@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 xmBuildOutputFile(packageDir, sourceFile): string;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L359)
9
+ Defined in: [vite-aliases.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L359)
10
10
 
11
11
  The file in `dist/` that the build writes for one source file of a package.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function xmCacheDir(importMetaUrl, name): string;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:495](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L495)
9
+ Defined in: [vite-aliases.ts:495](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L495)
10
10
 
11
11
  Returns the shared Vite `cacheDir` for this workspace package.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function xmOptimizeDeps(include?): DepOptimizationOptions;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:448](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L448)
9
+ Defined in: [vite-aliases.ts:448](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L448)
10
10
 
11
11
  Returns the standard Vite `optimizeDeps` config for browser test projects.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function xmResolve(importMetaUrl, extra?): ResolveOptions & object;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:333](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L333)
9
+ Defined in: [vite-aliases.ts:333](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L333)
10
10
 
11
11
  Full Vite `resolve` config for @xmachines/* workspace packages.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function xmSvelteRunes(): object;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:474](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L474)
9
+ Defined in: [vite-aliases.ts:474](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L474)
10
10
 
11
11
  Svelte plugin options that enforce runes mode for workspace sources only.
12
12
 
@@ -33,6 +33,6 @@ one and change the other.
33
33
 
34
34
  `object`
35
35
 
36
- | Name | Type | Defined in |
37
- | ------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
38
- | `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:475](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L475) |
36
+ | Name | Type | Defined in |
37
+ | ------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
38
+ | `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:475](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L475) |
@@ -6,7 +6,7 @@
6
6
  function xmTestTarget(env?): XmTestTarget;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L25)
9
+ Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L25)
10
10
 
11
11
  Reads the test target from the `XM_TEST_TARGET` environment variable.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type XmTestTarget = "source" | "dist";
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vite-aliases.ts#L13)
9
+ Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vite-aliases.ts#L13)
10
10
 
11
11
  The code that a test run loads for each published `@xmachines/*` package.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function defineXmBrowserConfig(importMetaUrl, overrides, options?): UserConfig;
7
7
  ```
8
8
 
9
- Defined in: [vitest.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vitest.ts#L224)
9
+ Defined in: [vitest.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vitest.ts#L224)
10
10
 
11
11
  Create a Vitest browser-mode config with XMachines workspace defaults.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function defineXmVitestConfig(importMetaUrl, overrides): UserConfig;
7
7
  ```
8
8
 
9
- Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vitest.ts#L76)
9
+ Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vitest.ts#L76)
10
10
 
11
11
  Create a Vitest config with XMachines workspace defaults.
12
12
 
@@ -2,15 +2,15 @@
2
2
 
3
3
  # Interface: XmBrowserConfigOptions
4
4
 
5
- Defined in: [vitest.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vitest.ts#L174)
5
+ Defined in: [vitest.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vitest.ts#L174)
6
6
 
7
7
  Options for [defineXmBrowserConfig](../functions/defineXmBrowserConfig.md) that live outside the plain
8
8
  Vitest config overrides.
9
9
 
10
10
  ## Properties
11
11
 
12
- | Property | Type | Description | Defined in |
13
- | -------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
14
- | <a id="property-base"></a> `base?` | `UserConfig` | Base Vite config to layer the browser test config on top of (typically a demo's `vite.config.ts`). When set, the base is expected to provide its own `resolve`/`plugins`, so the `cacheDir` and `resolve` defaults are not applied — mirroring the previous `mergeConfig(viteConfig, ...)` pattern in demo browser configs. | [vitest.ts:182](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vitest.ts#L182) |
15
- | <a id="property-optimizedeps"></a> `optimizeDeps?` | `string`[] | Extra package specifiers to pre-bundle via `xmOptimizeDeps` (e.g. `["@xmachines/json-render-vue", "@xmachines/json-render-vue/schema"]`). Ignored when `overrides.optimizeDeps` is set, which then replaces the default `xmOptimizeDeps()` wholesale. | [vitest.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vitest.ts#L189) |
16
- | <a id="property-resolve"></a> `resolve?` | `Partial`\<`ResolveOptions` & `object`\> | Extra resolve options forwarded to `xmResolve` (e.g. `conditions` or additional `alias` entries). Not applied when `base` is set — the base config owns `resolve` in that layout. | [vitest.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/shared/config/vitest.ts#L195) |
12
+ | Property | Type | Description | Defined in |
13
+ | -------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
14
+ | <a id="property-base"></a> `base?` | `UserConfig` | Base Vite config to layer the browser test config on top of (typically a demo's `vite.config.ts`). When set, the base is expected to provide its own `resolve`/`plugins`, so the `cacheDir` and `resolve` defaults are not applied — mirroring the previous `mergeConfig(viteConfig, ...)` pattern in demo browser configs. | [vitest.ts:182](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vitest.ts#L182) |
15
+ | <a id="property-optimizedeps"></a> `optimizeDeps?` | `string`[] | Extra package specifiers to pre-bundle via `xmOptimizeDeps` (e.g. `["@xmachines/json-render-vue", "@xmachines/json-render-vue/schema"]`). Ignored when `overrides.optimizeDeps` is set, which then replaces the default `xmOptimizeDeps()` wholesale. | [vitest.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vitest.ts#L189) |
16
+ | <a id="property-resolve"></a> `resolve?` | `Partial`\<`ResolveOptions` & `object`\> | Extra resolve options forwarded to `xmResolve` (e.g. `conditions` or additional `alias` entries). Not applied when `base` is set — the base config owns `resolve` in that layout. | [vitest.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/shared/config/vitest.ts#L195) |
@@ -4,7 +4,7 @@ XMachines Play implements the **Universal Player Architecture** — a layered, a
4
4
 
5
5
  ## System Overview
6
6
 
7
- XMachines JS is the JavaScript/TypeScript reference implementation of the **Universal Player Architecture** ([Play RFC](../rfc/play.md)). It is a monorepo of modular packages that strictly separates **business logic (the Actor)** from **infrastructure (router adapters and view renderers)**. An XState v5 state machine is the single source of truth; it owns all state, guards, and route validity. Infrastructure is passive: it observes atoms emitted by the Actor and proposes state changes via typed events. The Actor's guards make every navigation and transition decision. Communication across the boundary is exclusively through atoms — never subscriptions, callbacks, or direct state mutation. Five architectural invariants (documented in the [Play RFC](../rfc/play.md)) enforce this contract across the entire package graph.
7
+ XMachines JS is the JavaScript/TypeScript reference implementation of the **Universal Player Architecture** ([Play RFC](../rfc/play.md)). It is a monorepo of modular packages that strictly separates **business logic (the Actor)** from **infrastructure (router adapters and view renderers)**. An XState v6 state machine is the single source of truth; it owns all state, guards, and route validity. Infrastructure is passive: it observes atoms emitted by the Actor and proposes state changes via typed events. The Actor's guards make every navigation and transition decision. Communication across the boundary is exclusively through atoms — never subscriptions, callbacks, or direct state mutation. Five architectural invariants (documented in the [Play RFC](../rfc/play.md)) enforce this contract across the entire package graph.
8
8
 
9
9
  ## Architectural Invariants
10
10
 
@@ -86,7 +86,7 @@ The diagram groups the packages by role. The build order is a separate view: eac
86
86
  | [`@xmachines/play-atom`](../api/@xmachines/play-atom/README.md) | The atom primitives, isolated in one package | `packages/play-atom/src/index.ts` |
87
87
  | [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md) | `PlayActor`, and nothing else | `packages/play-actor/src/play-actor.ts` |
88
88
  | [`@xmachines/play-view`](../api/@xmachines/play-view/README.md) | `Viewable`, `PlaySpec`, the shared view half | `packages/play-view/src/view-types.ts` |
89
- | [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) | XState v5 adapter: `definePlayer`, `PlayerActor` | `packages/play-xstate/src/player-actor.ts` |
89
+ | [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) | XState v6 adapter: `definePlayer`, `PlayerActor` | `packages/play-xstate/src/player-actor.ts` |
90
90
  | [`@xmachines/play-pattern`](../api/@xmachines/play-pattern/README.md) | The route pattern language: one parse, and `buildPath` | `packages/play-pattern/src/pattern-grammar.ts` |
91
91
  | [`@xmachines/play-url`](../api/@xmachines/play-url/README.md) | The URLPattern API, a base path, framework params | `packages/play-url/src/url-pattern-utils.ts` |
92
92
  | [`@xmachines/play-router`](../api/@xmachines/play-router/README.md) | `RouteMap`, `RouterBridgeBase`, the provider lifecycle | `packages/play-router/src/router-bridge-base.ts` |
@@ -202,7 +202,7 @@ flowchart TD
202
202
  C --> D --> E --> F
203
203
  ```
204
204
 
205
- The composition keeps each element of the outer view by reference, except an element that receives a child view. It prefixes each key of a child view with the id of its state. play-xstate keeps one result of `composeViews` for each tree of views of each machine. A context assign therefore emits the same `elements` and `viewParts` references, and the emit gate of `withView` compares the top-level fields alone. One walk derives every view: a machine without `outlets` is its simple case, in which the deepest view wins. When the `viewKey` stays and the `viewParts` value changes, `createViewStoreLifecycle` writes the authored keys that the store does not hold. play-dom then gives the new spec to `setSpec` of the incremental renderer, which keeps each node whose element did not change.
205
+ The composition keeps each element of the outer view by reference, except an element that receives a child view. It prefixes each key of a child view with the id of its state. play-xstate keeps one result of `composeViews` for each tree of views of each machine. A change of the context therefore emits the same `elements` and `viewParts` references, and the emit gate of `withView` compares the top-level fields alone. One walk derives every view: a machine without `outlets` is its simple case, in which the deepest view wins. When the `viewKey` stays and the `viewParts` value changes, `createViewStoreLifecycle` writes the authored keys that the store does not hold. play-dom then gives the new spec to `setSpec` of the incremental renderer, which keeps each node whose element did not change.
206
206
 
207
207
  Each provider reads the view through `createViewSession` of play-view. The session resolves the store when the actor emits, when the host hands over a new actor or controlled store, and for a retry — never in a render. A provider binds the snapshot of the session to its framework: `useState` and a layout effect in play-react, a `shallowRef` in play-vue, a signal in play-solid, `$state.raw` in play-svelte, and a listener in play-dom. The subtree of the view is keyed on the `generation` of the store, and the error boundary resets on a new snapshot.
208
208
 
@@ -259,7 +259,7 @@ Extends `@xmachines/json-render-core` `Spec`. `deriveCurrentView` projects the m
259
259
 
260
260
  ### [`PlayerActor<TMachine>`](../api/@xmachines/play-xstate/index/classes/PlayerActor.md)
261
261
 
262
- Concrete XState v5 actor. It extends XState's own `Actor` directly, and it implements [`PlayActor`](../api/@xmachines/play-actor/interfaces/PlayActor.md). It receives the machine in its constructor, so an instance IS the actor rather than a wrapper around one. Bridges its own subscription to atoms. Exposes: `state`, `send()`, `start()`, `stop()`, `can()`.
262
+ Concrete XState v6 actor. It extends XState's own `Actor` directly, and it implements [`PlayActor`](../api/@xmachines/play-actor/interfaces/PlayActor.md). It receives the machine in its constructor, so an instance IS the actor rather than a wrapper around one. Bridges its own subscription to atoms. Exposes: `state`, `send()`, `start()`, `stop()`, `can()`.
263
263
 
264
264
  [`Routable`](../api/@xmachines/play-router/index/interfaces/Routable.md) and [`Viewable`](../api/@xmachines/play-view/index/interfaces/Viewable.md) are OPTIONAL capabilities, and the class implements neither. Each one is a mixin behind its own entry point — [`@xmachines/play-xstate/routing`](../api/@xmachines/play-xstate/README.md) and [`@xmachines/play-xstate/view`](../api/@xmachines/play-xstate/README.md) — and `compose` builds the class that an application needs:
265
265
 
@@ -340,7 +340,7 @@ Subscribe to a single atom with microtask coalescing and memory-safe cleanup. It
340
340
 
341
341
  ### [`formatPlayRouteTransitions(machineConfig)`](../api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md)
342
342
 
343
- Crawls machine state configs looking for states with `meta.route` and auto-generates `play.route` transition handlers at the root machine level. Each generated transition targets the matching state, guards on `event.to === "#stateId"`, and assigns `event.params` and `event.query` to context. Returns the same config type `T` — directly usable by `setup().createMachine()`.
343
+ Crawls machine state configs looking for states with `meta.route` and auto-generates `play.route` transition handlers at the root machine level. Each generated transition is a config object: it targets the matching state, it selects the event with `matches: { to: "#stateId" }`, and its `context` mapper returns a patch with `event.params` and `event.query`. The `play.route` entry is a list, with the generated transitions first and a transition of the machine last. Returns the same config type `T` — directly usable by `setup().createMachine()`.
344
344
 
345
345
  ## View Renderer Pattern
346
346
 
@@ -407,7 +407,7 @@ packages/
407
407
  ├── play-url/ # Layer 2: the URL layer — the URLPattern API, a base path, framework params
408
408
  ├── play-view/ # Layer 2: Viewable, PlaySpec, the view session, the context projection
409
409
  │
410
- ├── play-xstate/ # Layer 4: Concrete XState v5 actor: definePlayer, PlayerActor
410
+ ├── play-xstate/ # Layer 4: Concrete XState v6 actor: definePlayer, PlayerActor
411
411
  │ └── src/
412
412
  │ ├── player-actor.ts # PlayerActor — concrete actor
413
413
  │ ├── define-player.ts # definePlayer factory
@@ -482,7 +482,7 @@ The **protocol layer** is `play`, `play-atom` and `play-actor`. `play` reads `co
482
482
  | URL layer (`play-url`) | Protocol layer, `play-pattern`, `urlpattern-polyfill` | Any other `@xmachines/*` package |
483
483
  | View half (`play-view`) | Protocol layer, `@xmachines/json-render-core` | Router adapters, framework code |
484
484
  | Actor logic (`play-xstate`) | Protocol layer, `play-pattern`, `xstate` | View renderers, router adapters |
485
- | Router infrastructure (`play-router`) | Protocol layer, `play-url`, `@statelyai/graph` | View renderers |
485
+ | Router infrastructure (`play-router`) | Protocol layer, `play-url`, `xstate` | View renderers |
486
486
  | Router adapters (`play-*-router`) | `play-router`, protocol layer, framework router lib | View renderers |
487
487
  | View renderers (`play-*`) | Protocol layer, `play-view`, `@xmachines/json-render-*` | Router adapters |
488
488
 
@@ -541,13 +541,14 @@ import { InvalidEventError } from "@xmachines/play-xstate/errors";
541
541
 
542
542
  ```tsx
543
543
  import { createRootRoute, createRouter } from "@tanstack/react-router";
544
- import { setup } from "xstate";
544
+ import { setup, types } from "xstate";
545
545
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
546
546
  import { formatPlayRouteTransitions, withRouting } from "@xmachines/play-xstate/routing";
547
547
  import { withView } from "@xmachines/play-xstate/view";
548
548
  import { extractMachineRoutes } from "@xmachines/play-router/xstate";
549
549
  import { createRouteMapFromTree, PlayRouterProvider } from "@xmachines/play-tanstack-react-router";
550
550
  import { PlayUIProvider, PlayRenderer, type PlayUIProviderProps } from "@xmachines/play-react";
551
+ import type { ViewMeta } from "@xmachines/play-view";
551
552
 
552
553
  // 1. Define machine — meta.route declares virtual routes; meta.view declares UI specs
553
554
  const machineConfig = formatPlayRouteTransitions({
@@ -584,7 +585,10 @@ const machineConfig = formatPlayRouteTransitions({
584
585
  },
585
586
  });
586
587
 
587
- const machine = setup({}).createMachine(machineConfig);
588
+ // XState 6 types the `meta` of each state from `schemas.meta`
589
+ const machine = setup({
590
+ schemas: { meta: types<{ route?: string; view?: ViewMeta }>() },
591
+ }).createMachine(machineConfig);
588
592
 
589
593
  // 2. Build route map from machine definition (done once at startup)
590
594
  const routeTree = extractMachineRoutes(machine);
@@ -20,33 +20,6 @@ The dev container currently defines no workspace-specific environment variables;
20
20
 
21
21
  **Defined in:** the `test:dist` and `test:browser:dist` scripts of the root `package.json`. **Read by:** `xmTestTarget` of [`@xmachines/shared/vite-aliases`](../api/@xmachines/shared/README.md), which every config helper of that package calls. Do not set it by hand: run `pnpm run test:dist`. See [testing.md](testing.md#tests-on-the-build-output).
22
22
 
23
- ### CI / Release Pipeline Variable
24
-
25
- | Variable | Required | Default | Description |
26
- | ------------------- | -------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
- | `SEMREL_SKIP_STEPS` | Optional | `""` (empty — run all steps) | A single RegExp string matched against every semantic-release plugin step ID. Use `\|` for alternation to skip multiple steps. Set via the GitLab "Run pipeline" UI or API trigger. |
28
-
29
- **Defined in:** `.gitlab-ci.yml`, consumed by `release.config.mjs`.
30
-
31
- **Examples:**
32
-
33
- A step ID is the name of the plugin, and a name that the entry declares extends it: `@semantic-release/exec:build`.
34
-
35
- ```bash
36
- # Skip one prepare step
37
- SEMREL_SKIP_STEPS="@semantic-release/exec:build$"
38
-
39
- # Skip every prepare step
40
- SEMREL_SKIP_STEPS="@semantic-release/exec"
41
-
42
- # Leave CHANGELOG.md alone
43
- SEMREL_SKIP_STEPS="@semantic-release/changelog"
44
- ```
45
-
46
- A pattern that removes `@semantic-release/git` throws instead of running: semantic-release would still tag and push, and the tag would then name a commit that carries no version bump.
47
-
48
- The variable reaches the publish never. `scripts/publish-release.mjs` runs on the tag pipeline, outside semantic-release — see [deployment.md](deployment.md).
49
-
50
23
  ---
51
24
 
52
25
  ## Configuration Files
@@ -420,40 +393,42 @@ Provides the helpers used in all `vitest.config.ts` and `vite.config.ts` files:
420
393
  **Location:** `/release.config.mjs`
421
394
  **Tool:** [semantic-release](https://semantic-release.gitbook.io/) via `@semantic-release/*` plugins
422
395
 
423
- Defines the release branches and plugin chain used by the GitLab CI semantic-release job.
396
+ Defines the trains, the release branches, and the plugins of each run: the run of a branch, of the `semantic-release` job of a train, and the run of a tag, of the `publish-release` job. The `to-be-continuous` semantic-release component turns it into `.releaserc.json` and installs each plugin it names, so it is literals: no import of a plugin, no top-level await.
424
397
 
425
398
  **Release branches:**
426
399
 
427
400
  | Branch | Channel | Pre-release |
428
401
  | ------- | --------- | ----------- |
429
402
  | `main` | (default) | No |
403
+ | `next` | `next` | `next` |
430
404
  | `rc` | `rc` | `rc` |
431
405
  | `beta` | `beta` | `true` |
432
406
  | `alpha` | `alpha` | `alpha` |
433
407
  | `pre` | `pre` | `pre` |
434
408
 
435
- Only `main` is a protected branch today. That works because `GITLAB_TOKEN` — which the release needs, since `CI_JOB_TOKEN` can push neither the release commit nor the tag — is an _unprotected_ group variable and so reaches every one of these refs. If it is ever made protected, each of these branches has to be protected too, or the release fails in verify-conditions with `EGITNOPERMISSION` rather than at the registry.
409
+ `GITLAB_TOKEN`, which the release needs (`CI_JOB_TOKEN` can push neither the release commit nor the tag, and creates no GitLab release), is a _protected_ group variable: it reaches only protected branches and protected tags. Every release branch is protected, `main` and the prerelease branches alike, and so are the tags of the trains, `core-v*`, `play-v*` and `docs-v*`. A release branch added to this table has to be protected too, or its release fails in verify-conditions with `EGITNOPERMISSION`.
410
+
411
+ **Trains:** `core` (`packages/core`), `play` (`packages/play`, `packages/play-*`) and `docs` (`packages/docs`, with every file of `core` and `play` counting for it too). The build files of the root and `packages/shared` count for every train.
436
412
 
437
- **Tag format:** `v${version}`
413
+ **Tag format:** `<train>-v${version}`, as `play-v7.1.0`.
438
414
 
439
- **Plugin order:**
415
+ **Plugin order of a branch's run:**
440
416
 
441
- 1. `@semantic-release/commit-analyzer` — determines version bump from conventional commits
442
- 2. `@semantic-release/release-notes-generator` — builds release notes
443
- 3. `@semantic-release/changelog` — writes `CHANGELOG.md`
444
- 4. `@semantic-release/exec` steps (in order):
417
+ 1. `@semantic-release/commit-analyzer` and `@semantic-release/release-notes-generator`, each wrapped by an entry of `@wtf/semantic-release-trains` (`wrap`) — the version bump and the notes, of the train's commits alone; each entry of the trains plugin also checks the trains
418
+ 2. `@semantic-release/changelog` — writes the `CHANGELOG.md` of the train's first path
419
+ 3. `@wtf/semantic-release-replace` — writes the version into the badge of each README of the train, by the `badge` template at the root of the config
420
+ 4. Of `docs` alone, `@semantic-release/exec` steps (in order):
445
421
  - `corepack` — `corepack enable`
446
422
  - `install` — `pnpm install --frozen-lockfile`
447
- - `set-workspace-versions` — updates all `package.json` files to the new version
448
423
  - `build` — `pnpm run build`
449
- - `typedoc` — `pnpm --filter @xmachines/docs run typedoc`
424
+ - `typedoc` — `pnpm --filter @xmachines/docs run typedoc --gitRevision docs-v${nextRelease.version}`
450
425
  - `format-docs` — `pnpm --filter @xmachines/docs run format`
451
- - `stage-generated-docs` — `git add -A packages/docs/api packages/docs/examples/@xmachines packages/docs/examples/README.md`, so a page that TypeDoc deleted leaves git too
452
- 5. `@semantic-release/git` — commits the changelog, the manifests, the READMEs and the generated docs (`api/`, `examples/@xmachines/` and the demo lists of `examples/README.md`), then pushes the commit and the tag
453
426
 
454
- The list ends there. semantic-release publishes nothing and creates no GitLab release: `scripts/publish-release.mjs` does both, on the pipeline of the tag. [deployment.md](deployment.md) states the whole sequence and the reason.
427
+ then an entry of `@wtf/semantic-release-trains` of `generated: true`, which stages the trees that TypeDoc writes, so a page that TypeDoc deleted leaves git too
428
+
429
+ 5. `@semantic-release/git` — commits the changelog, the READMEs of the train, and of `docs` the generated docs (`api/`, `examples/@xmachines/` and the demo lists of `examples/README.md`), then pushes the commit and the tag
455
430
 
456
- Any step above can be skipped with the `SEMREL_SKIP_STEPS` CI variable, which the CI / Release Pipeline Variable section at the top of this page states.
431
+ **Plugin order of a tag's run:** the notes generator on the train; `@wtf/semantic-release-trains-publish`, which packs, smoke-tests and publishes the train's packages and packs its demos; `@semantic-release/gitlab`, the GitLab release with the tarballs. [deployment.md](deployment.md) states the whole sequence and the reason.
457
432
 
458
433
  ---
459
434
 
@@ -487,15 +462,14 @@ The only environment-specific distinction is between **local development** (dev
487
462
 
488
463
  ## Required vs Optional Settings Summary
489
464
 
490
- | Config | Required to Work | Optional / Has Default |
491
- | -------------------------------------------------------------------------- | --------------------------------------- | ----------------------------- |
492
- | `SEMREL_SKIP_STEPS` | No | Default: `""` (run all steps) |
493
- | Root `tsconfig.json` `references` | Yes — the whole build order | — |
494
- | Per-package `references` | No — TypeScript drops them on `extends` | — |
495
- | Per-package `composite: true` | Yes — required for project references | — |
496
- | [`@xmachines/shared/tsconfig`](../api/@xmachines/shared/README.md) extends | Yes — all packages must extend it | — |
497
- | [`@xmachines/shared/oxlint`](../api/@xmachines/shared/README.md) extends | Yes — all packages must extend it | — |
498
- | [`@xmachines/shared/oxfmt`](../api/@xmachines/shared/README.md) extends | Yes — all packages must extend it | — |
465
+ | Config | Required to Work | Optional / Has Default |
466
+ | -------------------------------------------------------------------------- | --------------------------------------- | ---------------------- |
467
+ | Root `tsconfig.json` `references` | Yes — the whole build order | — |
468
+ | Per-package `references` | No — TypeScript drops them on `extends` | — |
469
+ | Per-package `composite: true` | Yes — required for project references | — |
470
+ | [`@xmachines/shared/tsconfig`](../api/@xmachines/shared/README.md) extends | Yes — all packages must extend it | — |
471
+ | [`@xmachines/shared/oxlint`](../api/@xmachines/shared/README.md) extends | Yes — all packages must extend it | — |
472
+ | [`@xmachines/shared/oxfmt`](../api/@xmachines/shared/README.md) extends | Yes — all packages must extend it | — |
499
473
 
500
474
  ---
501
475