@xmachines/docs 7.0.0 → 8.0.0-next.1

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 (542) hide show
  1. package/README.md +2 -2
  2. package/api/@xmachines/core/cache/functions/createLruCache.md +1 -1
  3. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
  4. package/api/@xmachines/core/errors/classes/BaseError.md +11 -11
  5. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +11 -11
  6. package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
  7. package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
  8. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  9. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  10. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
  12. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  13. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  14. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  15. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  16. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  18. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  19. package/api/@xmachines/play/README.md +1 -1
  20. package/api/@xmachines/play/errors/classes/NonNullableError.md +11 -11
  21. package/api/@xmachines/play/errors/classes/PlayError.md +11 -11
  22. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  23. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +4 -4
  24. package/api/@xmachines/play-actor/README.md +3 -3
  25. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +4 -4
  26. package/api/@xmachines/play-actor/interfaces/PlayActor.md +6 -6
  27. package/api/@xmachines/play-atom/README.md +6 -4
  28. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  29. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  30. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  31. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +6 -6
  32. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +4 -4
  33. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  34. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  35. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  36. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  37. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  38. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  39. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  40. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  41. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  42. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  43. package/api/@xmachines/play-dom/README.md +8 -5
  44. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  45. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  46. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  47. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +12 -12
  48. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  49. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +15 -15
  50. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  51. package/api/@xmachines/play-dom-router/README.md +5 -3
  52. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  53. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  54. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  55. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  56. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  57. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +5 -5
  58. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  59. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  60. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  61. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +9 -9
  62. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  63. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  64. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  65. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  66. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  67. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +8 -8
  68. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  69. package/api/@xmachines/play-pattern/README.md +1 -1
  70. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  71. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  72. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  73. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  74. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  75. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  76. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  77. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  78. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  79. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  80. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  81. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  82. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  83. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  84. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  85. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  86. package/api/@xmachines/play-react/README.md +5 -5
  87. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  88. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  89. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  90. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  91. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  92. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +8 -8
  93. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +6 -6
  94. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  95. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  96. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  97. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  98. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  99. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  100. package/api/@xmachines/play-react-router/README.md +1 -1
  101. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  102. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  103. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  104. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  105. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +9 -9
  106. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  107. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +6 -6
  108. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  109. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  110. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  111. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  112. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  113. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  114. package/api/@xmachines/play-router/README.md +15 -14
  115. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +11 -11
  116. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +12 -12
  117. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +12 -12
  118. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +12 -12
  119. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +12 -12
  120. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +12 -12
  121. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +13 -13
  122. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +11 -11
  123. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +13 -13
  124. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  125. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  126. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  127. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  128. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  136. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +5 -5
  142. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  143. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  144. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  146. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  148. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  152. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +5 -5
  153. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +6 -6
  154. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  155. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  156. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  157. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +5 -5
  158. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +8 -8
  159. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +10 -10
  160. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  161. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +14 -14
  162. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +9 -9
  163. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +11 -11
  164. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +5 -5
  165. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +5 -5
  166. package/api/@xmachines/play-router/index/interfaces/Routable.md +5 -5
  167. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +6 -6
  168. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +10 -10
  169. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  170. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +5 -5
  171. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +5 -5
  172. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +12 -12
  173. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +7 -7
  174. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +7 -7
  175. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  176. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  177. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +7 -7
  178. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +8 -8
  179. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +7 -7
  180. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  181. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  182. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  183. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  184. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  185. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  186. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  187. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  188. package/api/@xmachines/play-router/xstate/README.md +5 -2
  189. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +2 -2
  190. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +5 -5
  191. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  192. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  193. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  194. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +7 -8
  195. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +8 -9
  196. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  197. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  198. package/api/@xmachines/play-router/xstate/interfaces/Graph.md +26 -0
  199. package/api/@xmachines/play-router/xstate/interfaces/GraphEdge.md +22 -0
  200. package/api/@xmachines/play-router/xstate/interfaces/GraphNode.md +21 -0
  201. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +6 -6
  202. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +7 -7
  203. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +4 -6
  204. package/api/@xmachines/play-solid/README.md +3 -3
  205. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  206. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  207. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  208. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  209. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  210. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  212. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  214. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  215. package/api/@xmachines/play-solid-router/README.md +4 -6
  216. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  217. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  218. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +6 -6
  220. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +9 -9
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  222. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +6 -6
  223. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  225. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  226. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  229. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  230. package/api/@xmachines/play-svelte/README.md +3 -3
  231. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  232. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  235. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  236. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  237. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  238. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  239. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  240. package/api/@xmachines/play-svelte-spa-router/README.md +6 -3
  241. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  242. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  243. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  244. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +5 -5
  245. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +9 -9
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +6 -6
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +8 -8
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  253. package/api/@xmachines/play-sveltekit-router/README.md +3 -2
  254. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  255. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  256. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  257. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +5 -5
  258. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +11 -11
  259. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  260. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +9 -9
  261. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  263. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  264. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  265. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +8 -8
  266. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +8 -8
  267. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +1 -1
  268. package/api/@xmachines/play-tanstack-react-router/README.md +3 -2
  269. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  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 +9 -9
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +6 -6
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  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 +3 -2
  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 +6 -7
  289. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  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 +9 -9
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +6 -6
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  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 +1 -1
  304. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +12 -12
  305. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +12 -12
  306. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +13 -13
  307. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  308. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  309. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  310. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  311. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  312. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  313. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  314. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  315. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  316. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  317. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  318. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  319. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  320. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  321. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  322. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  323. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  324. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +5 -5
  325. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  326. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  327. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +6 -6
  328. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  329. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +5 -5
  330. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +9 -9
  331. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  332. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +14 -14
  333. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +6 -6
  334. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +5 -5
  335. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +7 -7
  336. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  337. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  338. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  339. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  340. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  341. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  342. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  343. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  344. package/api/@xmachines/play-view/README.md +4 -4
  345. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +13 -13
  346. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +12 -12
  347. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +13 -13
  348. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  349. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +1 -1
  350. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  351. package/api/@xmachines/play-view/index/functions/composeViews.md +1 -1
  352. package/api/@xmachines/play-view/index/functions/createActorProxy.md +1 -1
  353. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +1 -1
  354. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  355. package/api/@xmachines/play-view/index/functions/createViewSession.md +1 -1
  356. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  357. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +1 -1
  358. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  359. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  360. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  361. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  362. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  363. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +7 -7
  364. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +7 -7
  365. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +7 -7
  366. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +4 -4
  367. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +8 -8
  368. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  369. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  370. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +4 -4
  371. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +7 -7
  372. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +5 -5
  373. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +7 -7
  374. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +5 -5
  375. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +8 -8
  376. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +4 -4
  377. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +7 -7
  378. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +6 -6
  379. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +5 -5
  380. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  381. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +1 -1
  382. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  383. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  384. package/api/@xmachines/play-vue/README.md +2 -2
  385. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  386. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  387. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  388. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  389. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  390. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  391. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  392. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  393. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  394. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -4
  395. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  396. package/api/@xmachines/play-vue-router/README.md +1 -1
  397. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +11 -11
  398. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +11 -11
  399. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  400. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  401. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +9 -9
  402. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +6 -6
  403. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  404. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +5 -5
  405. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  406. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  407. package/api/@xmachines/play-xstate/README.md +63 -52
  408. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +11 -11
  409. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +12 -12
  410. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +11 -11
  411. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +12 -12
  412. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +12 -12
  413. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  414. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +13 -13
  415. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +15 -15
  416. package/api/@xmachines/play-xstate/index/README.md +1 -1
  417. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +201 -124
  418. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  419. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +14 -10
  420. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +6 -6
  421. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +4 -4
  422. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +9 -9
  423. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  424. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  425. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  426. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  427. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +13 -5
  428. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +26 -13
  429. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  430. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  431. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +8 -8
  432. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +7 -7
  433. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  434. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  435. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  436. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  437. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  438. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  439. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  440. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  441. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  442. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  443. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  444. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  445. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  446. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +1 -1
  447. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  448. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  449. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  450. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  451. package/contributing/architecture.md +13 -9
  452. package/contributing/configuration.md +24 -50
  453. package/contributing/deployment.md +128 -158
  454. package/contributing/development.md +6 -6
  455. package/contributing/migrating-to-play-atom.md +13 -1
  456. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +11 -11
  457. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  458. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  459. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  460. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  461. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  462. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  463. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  464. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  465. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  466. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  467. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  468. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  469. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  470. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  471. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  472. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  473. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  474. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  475. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  476. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +17 -17
  477. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +11 -11
  478. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  479. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  480. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  481. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  482. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  483. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  484. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  485. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  486. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  487. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  488. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  489. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  490. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  491. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  492. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  493. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  494. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  495. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  496. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  497. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +17 -17
  498. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +11 -11
  499. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  500. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  501. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  502. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  503. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  504. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  505. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  506. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  507. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  508. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  509. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  510. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  511. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  512. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  513. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  514. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  515. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  516. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  517. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  518. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  519. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +11 -11
  520. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  521. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  522. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +17 -17
  523. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +11 -11
  524. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  525. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  526. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  527. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  528. package/examples/README.md +1 -1
  529. package/examples/basic-state-machine.md +19 -23
  530. package/examples/form-validation.md +43 -48
  531. package/examples/routing-patterns.md +30 -35
  532. package/examples/traffic-light.md +19 -21
  533. package/guides/actor-model.md +5 -6
  534. package/guides/getting-started.md +45 -51
  535. package/guides/inspector.md +52 -46
  536. package/guides/routing.md +4 -2
  537. package/guides/state-machines.md +80 -64
  538. package/guides/views.md +6 -4
  539. package/package.json +1 -1
  540. package/rfc/git.md +13 -5
  541. package/rfc/play.md +22 -18
  542. package/rfc/run.md +7 -4
@@ -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/v7.0.0/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/docs-v8.0.0-next.1/packages/play-actor/examples/shared/src/actions.ts#L48)
10
10
 
11
11
  Build the demo action handler map for one actor.
12
12
 
@@ -23,13 +23,13 @@ framework's `defineRegistry` accepts; spread the result into its `actions`.
23
23
 
24
24
  `object`
25
25
 
26
- | Name | Type | Defined in |
27
- | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
- | `addTask()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.0.0/packages/play-actor/examples/shared/src/actions.ts#L92) |
26
+ | Name | Type | Defined in |
27
+ | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
+ | `addTask()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-svelte/examples/demo/src/catalog.ts#L6)
9
+ Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-svelte/examples/demo/src/catalog.ts#L6)
@@ -194,4 +194,4 @@ const authCatalog: Catalog<{
194
194
  }>;
195
195
  ```
196
196
 
197
- Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-svelte/examples/demo/src/catalog.ts#L5)
197
+ Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-svelte/examples/demo/src/catalog.ts#L5)
@@ -6,25 +6,25 @@
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/v7.0.0/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/docs-v8.0.0-next.1/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
 
13
13
  ## Type Declaration
14
14
 
15
- | Name | Type | Default value | Defined in |
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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.0.0/packages/play-svelte/examples/demo/src/components/demo-components.ts#L27) |
15
+ | Name | Type | Default value | Defined in |
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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/v7.0.0/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/docs-v8.0.0-next.1/packages/play-actor/examples/shared/src/actions.ts#L48)
10
10
 
11
11
  Build the demo action handler map for one actor.
12
12
 
@@ -23,13 +23,13 @@ framework's `defineRegistry` accepts; spread the result into its `actions`.
23
23
 
24
24
  `object`
25
25
 
26
- | Name | Type | Defined in |
27
- | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
- | `addTask()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.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/v7.0.0/packages/play-actor/examples/shared/src/actions.ts#L92) |
26
+ | Name | Type | Defined in |
27
+ | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28
+ | `addTask()` | (`params?`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/docs-v8.0.0-next.1/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/v7.0.0/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/docs-v8.0.0-next.1/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/v7.0.0/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/docs-v8.0.0-next.1/packages/play-vue/examples/demo/src/env.d.ts#L5)
@@ -194,4 +194,4 @@ const authCatalog: Catalog<{
194
194
  }>;
195
195
  ```
196
196
 
197
- Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/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/docs-v8.0.0-next.1/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/v7.0.0/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/docs-v8.0.0-next.1/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.
@@ -10,7 +10,7 @@ Start with the fundamental machine + actor pattern:
10
10
 
11
11
  - **[Basic State Machine](basic-state-machine.md)** — `setup().createMachine()` + `definePlayer()` + atoms
12
12
  - **[Traffic Light](traffic-light.md)** — Multi-state machine with `meta.route` and `formatPlayRouteTransitions`
13
- - **[Form Validation](form-validation.md)** — Typed context mutations with `setup.assign`, guards, and `$bindState`
13
+ - **[Form Validation](form-validation.md)** — Typed context patches, guards in transition functions, and `$bindState`
14
14
 
15
15
  ### Level 2: Routing Patterns
16
16
 
@@ -1,6 +1,6 @@
1
1
  # Basic State Machine
2
2
 
3
- Learn how to define a simple toggle machine using the current XState v5 + XMachines `setup().createMachine()` + `definePlayer()` pattern.
3
+ Learn how to define a simple toggle machine using the current XState v6 + XMachines `setup().createMachine()` + `definePlayer()` pattern.
4
4
 
5
5
  ## Use Case
6
6
 
@@ -9,15 +9,15 @@ This example demonstrates a toggle switch — the foundation for understanding s
9
9
  ## Complete Code
10
10
 
11
11
  ```typescript
12
- import { setup } from "xstate";
12
+ import { setup, types } from "xstate";
13
13
  import { definePlayer } from "@xmachines/play-xstate";
14
14
 
15
- // 1. Declare types for context, events, and input via setup()
15
+ // 1. Declare the schemas of the context, the events, and the input via setup()
16
16
  const toggleSetup = setup({
17
- types: {
18
- context: {} as { toggleCount: number },
19
- events: {} as { type: "toggle" },
20
- input: {} as { toggleCount?: number } | undefined,
17
+ schemas: {
18
+ context: types<{ toggleCount: number }>(),
19
+ events: { toggle: types<void>() },
20
+ input: types<{ toggleCount?: number } | undefined>(),
21
21
  },
22
22
  });
23
23
 
@@ -31,22 +31,18 @@ const toggleMachine = toggleSetup.createMachine({
31
31
  states: {
32
32
  off: {
33
33
  on: {
34
- toggle: {
34
+ toggle: ({ context }) => ({
35
35
  target: "on",
36
- actions: toggleSetup.assign({
37
- toggleCount: ({ context }) => context.toggleCount + 1,
38
- }),
39
- },
36
+ context: { toggleCount: context.toggleCount + 1 },
37
+ }),
40
38
  },
41
39
  },
42
40
  on: {
43
41
  on: {
44
- toggle: {
42
+ toggle: ({ context }) => ({
45
43
  target: "off",
46
- actions: toggleSetup.assign({
47
- toggleCount: ({ context }) => context.toggleCount + 1,
48
- }),
49
- },
44
+ context: { toggleCount: context.toggleCount + 1 },
45
+ }),
50
46
  },
51
47
  },
52
48
  },
@@ -81,11 +77,11 @@ actor.stop();
81
77
 
82
78
  ## Code Explanation
83
79
 
84
- 1. **`setup({ types })`** — Declares TypeScript types for `context`, `events`, and `input` before the machine is created. This is the XState v5 typed entry point. Never pass type parameters directly to `createMachine`.
80
+ 1. **`setup({ schemas })`** — Declares the schemas of `context`, `events`, and `input` before the machine is created. `types<T>()` gives a schema that carries the type alone, with no validation at run time. `events` is a map from the type of each event to its payload, and `types<void>()` declares an event without a payload. This is the XState v6 typed entry point. Never pass type parameters directly to `createMachine`.
85
81
 
86
- 2. **`toggleSetup.createMachine(...)`** — Creates the state machine. Using the scoped `toggleSetup.createMachine` (instead of the bare `createMachine` from xstate) ensures that guards and actions are type-checked against the declared types.
82
+ 2. **`toggleSetup.createMachine(...)`** — Creates the state machine. The scoped `toggleSetup.createMachine` checks each transition function against the declared schemas.
87
83
 
88
- 3. **`toggleSetup.assign(...)`** — Assigns context mutations using the typed setup's `assign` helper. This provides full inference from the declared context type — no manual type assertions needed.
84
+ 3. **A transition function** — Each transition is a function of `{ context, event }`. It returns the `target` and a `context` patch, which XState merges into the context at the top level. The context of the declared type gives the function full inference, with no type assertions.
89
85
 
90
86
  4. **`definePlayer({ machine })`** — Wraps the machine in a factory. Calling `createPlayer()` returns a `PlayerActor` — XMachines' actor type that extends XState's actor with atom reactivity and Play Architecture hooks.
91
87
 
@@ -99,14 +95,14 @@ actor.stop();
99
95
 
100
96
  ## Key Concepts
101
97
 
102
- - **`setup({ types })`**: The XState v5 typed entry point. Declares context, event, and input shapes before machine creation.
98
+ - **`setup({ schemas })`**: The XState v6 typed entry point. Declares the context, the event map, and the input before machine creation.
103
99
  - **`definePlayer({ machine })`**: Creates a factory function that returns `PlayerActor` instances.
104
100
  - **`actor.state`**: An `Atom<Snapshot>` — an atom-based reactive handle on the machine snapshot.
105
101
  - **`actor.getSnapshot()`**: Synchronous snapshot access — use for one-time reads and TypeScript-typed context inspection.
106
- - **Typed `assign`**: Always call `setup.assign(...)` (not the bare `assign` from xstate) for context mutations.
102
+ - **Context patches**: A transition function returns `{ context: { ... } }` to change the context. XState 6 has no `assign` action.
107
103
 
108
104
  ## Next Steps
109
105
 
110
106
  - **[Traffic Light Example](traffic-light.md)** — Multi-state machine with `meta.route` and `formatPlayRouteTransitions`
111
- - **[Form Validation Example](form-validation.md)** — Typed context mutations with `setup.assign` and guards
107
+ - **[Form Validation Example](form-validation.md)** — Typed context patches and guards in transition functions
112
108
  - **[Routing Patterns](routing-patterns.md)** — Adding `meta.route` to states and using `play.route` events
@@ -1,23 +1,25 @@
1
1
  # Form Validation with Typed Context
2
2
 
3
- Managing login form state using `setup({ types })`, typed `assign`, guards, and `meta.view` with `$bindState`.
3
+ Managing login form state using `setup({ schemas })`, transition functions with context patches and guards, and `meta.view` with `$bindState`.
4
4
 
5
5
  ## Use Case
6
6
 
7
7
  This example mirrors the `authMachine` login pattern: a form state with a local state store (`$bindState` two-way binding), a guard on the submit action, and a `meta.view` spec describing the component tree. It covers:
8
8
 
9
- - Typed context mutations with `setup.assign`
10
- - Guards as inline functions checking context
9
+ - Typed context patches, returned by transition functions
10
+ - Guards as conditions inside the transition functions
11
11
  - `meta.view` spec with `$bindState` for two-way form binding
12
12
  - Sending typed domain events from the view layer
13
13
 
14
14
  ## Complete Code
15
15
 
16
16
  ```typescript
17
- import { setup } from "xstate";
17
+ import { setup, types } from "xstate";
18
18
  import { compose, definePlayer, PlayerActor } from "@xmachines/play-xstate";
19
19
  import { formatPlayRouteTransitions } from "@xmachines/play-xstate/routing";
20
20
  import { withView } from "@xmachines/play-xstate/view";
21
+ import type { PlayRouteEvent, RouteMetadata } from "@xmachines/play-router";
22
+ import type { ViewMeta } from "@xmachines/play-view";
21
23
 
22
24
  // Context shape
23
25
  interface LoginContext {
@@ -28,30 +30,25 @@ interface LoginContext {
28
30
  query: Record<string, string>;
29
31
  }
30
32
 
31
- // Event union — lowercase dot-separated names
32
- type LoginEvent =
33
- | {
34
- type: "play.route";
35
- to: string;
36
- params?: Record<string, string>;
37
- query?: Record<string, string>;
38
- }
39
- | { type: "auth.login"; username: string }
40
- | { type: "auth.logout" };
41
-
42
- // 1. Typed setup — always use setup() before createMachine()
33
+ // 1. Typed setup — always use setup() before createMachine(). The events are a map from
34
+ // the type of each event (lowercase dot-separated names) to its payload.
43
35
  const loginSetup = setup({
44
- types: {
45
- context: {} as LoginContext,
46
- events: {} as LoginEvent,
47
- input: {} as Partial<LoginContext> | undefined,
36
+ schemas: {
37
+ context: types<LoginContext>(),
38
+ events: {
39
+ "play.route": types<Omit<PlayRouteEvent, "type">>(),
40
+ "auth.login": types<{ username: string }>(),
41
+ "auth.logout": types<void>(),
42
+ },
43
+ input: types<Partial<LoginContext> | undefined>(),
44
+ meta: types<{ route?: RouteMetadata; view?: ViewMeta }>(),
48
45
  },
49
46
  });
50
47
 
51
48
  // 2. Machine — wraps config in formatPlayRouteTransitions for play.route support
52
49
  const loginMachine = loginSetup.createMachine(
53
50
  formatPlayRouteTransitions({
54
- id: "login",
51
+ id: "loginFlow",
55
52
  initial: "idle",
56
53
  context: ({ input }) => ({
57
54
  isAuthenticated: input?.isAuthenticated ?? false,
@@ -63,24 +60,23 @@ const loginMachine = loginSetup.createMachine(
63
60
 
64
61
  // Root-level event handlers — accessible from any state
65
62
  on: {
66
- "auth.login": {
67
- target: ".dashboard",
68
- // Guard: allow login only when not already authenticated
69
- guard: ({ context }) => !context.isAuthenticated,
70
- actions: loginSetup.assign({
71
- isAuthenticated: true,
72
- errorMessage: null,
73
- // Typed by the event union — TypeScript narrows event.username safely
74
- username: ({ event }) => (event.type === "auth.login" ? event.username : null),
75
- }),
63
+ "auth.login": ({ context, event }) => {
64
+ // Guard: allow login only when not already authenticated. A transition
65
+ // function that returns nothing leaves the event unhandled.
66
+ if (context.isAuthenticated) return;
67
+ return {
68
+ target: ".dashboard",
69
+ // The event map types `event.username` for this transition
70
+ context: {
71
+ isAuthenticated: true,
72
+ errorMessage: null,
73
+ username: event.username,
74
+ },
75
+ };
76
76
  },
77
- "auth.logout": {
78
- target: ".idle",
79
- guard: ({ context }) => context.isAuthenticated,
80
- actions: loginSetup.assign({
81
- isAuthenticated: false,
82
- username: null,
83
- }),
77
+ "auth.logout": ({ context }) => {
78
+ if (!context.isAuthenticated) return;
79
+ return { target: ".idle", context: { isAuthenticated: false, username: null } };
84
80
  },
85
81
  },
86
82
 
@@ -147,10 +143,8 @@ const loginMachine = loginSetup.createMachine(
147
143
  },
148
144
  },
149
145
  // always-guard: redirect to login if not authenticated
150
- always: {
151
- guard: ({ context }) => !context.isAuthenticated,
152
- target: "login",
153
- },
146
+ always: ({ context }) =>
147
+ context.isAuthenticated ? undefined : { target: "login" },
154
148
  },
155
149
  },
156
150
  }),
@@ -173,8 +167,9 @@ actor.send({ type: "auth.login", username: "alice" });
173
167
  console.log(actor.getSnapshot().value); // "dashboard"
174
168
  console.log(actor.getSnapshot().context.username); // "alice"
175
169
 
176
- // 6. Guard prevents re-login while authenticated
177
- actor.send({ type: "auth.login", username: "bob" }); // guard fires, transition rejected
170
+ // 6. Guard prevents re-login while authenticated. `can` asks without a send: a send of an
171
+ // event that no transition takes makes the development build of XState 6 log a warning.
172
+ console.log(actor.can({ type: "auth.login", username: "bob" })); // false — the guard refuses it
178
173
  console.log(actor.getSnapshot().context.username); // still "alice"
179
174
 
180
175
  // 7. Logout
@@ -220,10 +215,10 @@ view: {
220
215
 
221
216
  ## Key Concepts
222
217
 
223
- - **`setup({ types })`**: Always declare context, events, and input types before `createMachine`.
224
- - **`setup.assign(...)`**: Use the scoped `assign` from your `setup` instance, not the bare one from `xstate`. This provides full type inference.
225
- - **Guards as inline functions**: `({ context }) => !context.isAuthenticated` — guards check state invariants ("can I BE in this state?"), not event details.
226
- - **`always` transitions**: Entry guards on states. Used for protected routes — if the guard fires, the machine redirects before the state is fully entered.
218
+ - **`setup({ schemas })`**: Always declare the context, the event map, the input, and the `meta` of the states before `createMachine`.
219
+ - **Context patches**: A transition function returns `{ context: { ... } }`. XState merges the patch into the context at the top level. XState 6 has no `assign` action.
220
+ - **Guards inside transition functions**: `if (context.isAuthenticated) return;` — a transition function that returns nothing leaves the event unhandled. A guard checks a state invariant ("can I BE in this state?"), not event details.
221
+ - **`always` transitions**: Entry guards on states. Used for protected routes — if the function returns a target, the machine redirects before the state is fully entered.
227
222
  - **Lowercase dot-separated event types**: `"auth.login"`, `"auth.logout"`, `"play.route"` — not `SCREAMING_SNAKE_CASE`.
228
223
 
229
224
  ## Connecting the Renderer
@@ -63,10 +63,10 @@ states: {
63
63
  Instead of hand-writing `play.route` event handlers for every routable state, wrap your machine config with `formatPlayRouteTransitions`:
64
64
 
65
65
  ```typescript
66
- import { setup } from "xstate";
66
+ import { setup, types } from "xstate";
67
67
  import { definePlayer } from "@xmachines/play-xstate";
68
68
  import { formatPlayRouteTransitions } from "@xmachines/play-xstate/routing";
69
- import type { PlayRouteEvent } from "@xmachines/play-router";
69
+ import type { PlayRouteEvent, RouteMetadata } from "@xmachines/play-router";
70
70
 
71
71
  interface AuthContext {
72
72
  isAuthenticated: boolean;
@@ -76,11 +76,15 @@ interface AuthContext {
76
76
  }
77
77
 
78
78
  const authSetup = setup({
79
- types: {
80
- context: {} as AuthContext,
81
- events: {} as
82
- PlayRouteEvent | { type: "auth.login"; username: string } | { type: "auth.logout" },
83
- input: {} as Partial<AuthContext> | undefined,
79
+ schemas: {
80
+ context: types<AuthContext>(),
81
+ events: {
82
+ "play.route": types<Omit<PlayRouteEvent, "type">>(),
83
+ "auth.login": types<{ username: string }>(),
84
+ "auth.logout": types<void>(),
85
+ },
86
+ input: types<Partial<AuthContext> | undefined>(),
87
+ meta: types<{ route?: RouteMetadata }>(),
84
88
  },
85
89
  });
86
90
 
@@ -109,14 +113,16 @@ const authMachine = authSetup.createMachine(
109
113
  ```typescript fragment
110
114
  on: {
111
115
  "play.route": [
112
- { target: ".home", guard: ({ event }) => event.to === "#home", reenter: false, actions: assign({ params, query }) },
113
- { target: ".about", guard: ({ event }) => event.to === "#about", reenter: false, actions: assign({ params, query }) },
114
- { target: ".login", guard: ({ event }) => event.to === "#login", reenter: false, actions: assign({ params, query }) },
115
- { target: ".profile", guard: ({ event }) => event.to === "#profile", reenter: false, actions: assign({ params, query }) },
116
+ { target: ".home", matches: { to: "#home" }, reenter: false, context: ({ context, event }) => ({ params, query }) },
117
+ { target: ".about", matches: { to: "#about" }, reenter: false, context: ({ context, event }) => ({ params, query }) },
118
+ { target: ".login", matches: { to: "#login" }, reenter: false, context: ({ context, event }) => ({ params, query }) },
119
+ { target: ".profile", matches: { to: "#profile" }, reenter: false, context: ({ context, event }) => ({ params, query }) },
116
120
  ],
117
121
  }
118
122
  ```
119
123
 
124
+ Each generated transition is a config object. `matches` selects the event by its `to` field, and `context` returns the patch that XState merges into the context. A `play.route` transition of your own comes after the generated ones, as the fallback.
125
+
120
126
  `reenter` comes from the object form of `meta.route`, and the default is `false`. Declare `meta: { route: { path: "/about", reenter: true } }` for a state whose route must also re-enter the domain of the transition. See [Re-entry on a navigation](../guides/routing.md#re-entry-on-a-navigation).
121
127
 
122
128
  ### `play.route` Events — Navigation
@@ -153,25 +159,19 @@ actor.send({
153
159
 
154
160
  ### `always` Guards — Protected Routes
155
161
 
156
- Use XState `always` transitions to protect states. If the guard fires, the machine redirects _before_ the state is fully entered:
162
+ Use XState `always` transitions to protect states. If the function returns a target, the machine redirects _before_ the state is fully entered:
157
163
 
158
164
  ```typescript fragment
159
165
  dashboard: {
160
166
  id: "dashboard",
161
167
  meta: { route: "/dashboard" },
162
- always: {
163
- // If not authenticated, redirect to login immediately
164
- guard: ({ context }) => !context.isAuthenticated,
165
- target: "login",
166
- },
168
+ // If not authenticated, redirect to login immediately
169
+ always: ({ context }) => (context.isAuthenticated ? undefined : { target: "login" }),
167
170
  },
168
171
  profile: {
169
172
  id: "profile",
170
173
  meta: { route: "/profile/:username" },
171
- always: {
172
- guard: ({ context }) => !context.isAuthenticated,
173
- target: "login",
174
- },
174
+ always: ({ context }) => (context.isAuthenticated ? undefined : { target: "login" }),
175
175
  },
176
176
  ```
177
177
 
@@ -186,21 +186,16 @@ const authMachine = authSetup.createMachine(
186
186
  formatPlayRouteTransitions({
187
187
  // ...
188
188
  on: {
189
- "auth.login": {
190
- target: ".dashboard",
191
- guard: ({ context }) => !context.isAuthenticated,
192
- actions: authSetup.assign({
193
- isAuthenticated: true,
194
- username: ({ event }) => (event.type === "auth.login" ? event.username : null),
195
- }),
189
+ "auth.login": ({ context, event }) => {
190
+ if (context.isAuthenticated) return;
191
+ return {
192
+ target: ".dashboard",
193
+ context: { isAuthenticated: true, username: event.username },
194
+ };
196
195
  },
197
- "auth.logout": {
198
- target: ".home",
199
- guard: ({ context }) => context.isAuthenticated,
200
- actions: authSetup.assign({
201
- isAuthenticated: false,
202
- username: null,
203
- }),
196
+ "auth.logout": ({ context }) => {
197
+ if (!context.isAuthenticated) return;
198
+ return { target: ".home", context: { isAuthenticated: false, username: null } };
204
199
  },
205
200
  },
206
201
  states: {/* ... */},