@xmachines/docs 7.2.0 → 7.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (585) hide show
  1. package/README.md +2 -1
  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 +4 -4
  5. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +4 -4
  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/errors/classes/NonNullableError.md +4 -4
  20. package/api/@xmachines/play/errors/classes/PlayError.md +4 -4
  21. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  22. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  23. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  24. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  25. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  26. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
  27. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  28. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
  29. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
  30. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  31. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  32. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  33. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  34. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  35. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  36. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  37. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  38. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  39. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  40. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  41. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  42. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  43. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +3 -3
  44. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  45. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  46. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  47. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  48. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  49. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  55. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +8 -8
  56. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  57. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  58. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +6 -6
  63. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  64. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  65. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  66. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  67. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  68. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  69. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +4 -4
  70. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  71. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
  72. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
  73. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
  74. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
  75. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +4 -4
  76. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  77. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  78. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  79. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  80. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  81. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  82. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  83. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  85. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  86. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  87. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  88. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  89. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  90. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  91. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  93. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  94. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  95. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  96. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  98. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  99. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  100. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  101. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  102. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  103. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  104. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  105. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  106. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  107. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  108. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  109. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  110. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  111. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  112. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  113. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  114. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  115. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  116. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  117. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  118. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  119. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  120. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  121. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  122. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  123. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  124. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  125. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  126. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  127. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  128. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  133. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  136. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  143. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  144. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  145. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
  146. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
  147. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  148. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  149. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  150. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
  151. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
  152. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  153. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  154. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
  155. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  156. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  157. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  158. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  159. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  160. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
  161. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  162. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  163. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  164. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +5 -5
  165. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  166. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  167. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  168. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +5 -5
  169. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +6 -6
  170. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  171. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  172. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  173. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  174. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  175. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  176. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  177. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  178. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  179. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  180. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  181. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  182. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  183. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  184. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  185. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  186. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  187. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  188. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  189. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  190. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  192. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  194. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  195. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  196. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  197. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  198. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  199. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  200. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  201. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  202. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  203. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  204. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  205. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  206. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  207. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  208. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  209. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  210. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  211. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  212. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  213. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  214. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  215. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  216. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  217. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  218. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  219. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  220. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  221. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  222. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  223. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  224. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  225. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  226. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  227. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  228. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
  229. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  230. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  231. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  232. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  233. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  234. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +6 -6
  235. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  236. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  237. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  238. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  239. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  240. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +9 -9
  241. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  242. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  243. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  244. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  245. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  246. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  247. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +6 -6
  248. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +6 -6
  249. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +1 -1
  250. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  251. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  252. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  253. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  254. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  255. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  256. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  257. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  258. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  259. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  260. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  261. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  262. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  263. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  264. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  265. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  266. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  267. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  268. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  269. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  270. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  271. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  272. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  273. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  274. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  275. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  276. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  277. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  278. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  279. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  280. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  281. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  282. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  283. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  284. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  285. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  286. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  287. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  288. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  289. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  290. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  291. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  292. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  293. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  294. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  295. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  296. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  297. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  298. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  299. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  300. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  301. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  302. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  303. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +3 -3
  304. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
  305. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  306. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  307. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  308. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  309. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +2 -2
  310. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  311. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  312. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  313. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  314. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  315. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  316. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  317. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  318. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  319. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  320. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  321. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  322. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +6 -6
  323. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  324. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +6 -6
  325. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  326. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +1 -1
  327. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  328. package/api/@xmachines/play-view/index/functions/composeViews.md +1 -1
  329. package/api/@xmachines/play-view/index/functions/createActorProxy.md +1 -1
  330. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +1 -1
  331. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  332. package/api/@xmachines/play-view/index/functions/createViewSession.md +1 -1
  333. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  334. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +1 -1
  335. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  336. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  337. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  338. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  339. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  340. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  341. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  342. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +5 -5
  343. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +2 -2
  344. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +3 -3
  345. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  346. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +3 -3
  347. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  348. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +2 -2
  349. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +3 -3
  350. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +7 -7
  351. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +3 -3
  352. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +6 -6
  353. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +4 -4
  354. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +5 -5
  355. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +4 -4
  356. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +3 -3
  357. package/api/@xmachines/play-view/index/interfaces/Viewable.md +2 -2
  358. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +1 -1
  359. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  360. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  361. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  362. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  363. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  364. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  365. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  366. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  367. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  368. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  369. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  370. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  371. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  372. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  373. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  374. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  375. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  376. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  377. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  378. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +4 -4
  379. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  380. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  381. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  382. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  383. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  384. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  385. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  386. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  387. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
  388. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  389. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  390. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -10
  391. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  392. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  393. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  394. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  395. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  396. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  397. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  398. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  399. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  400. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  401. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  402. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  403. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  404. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  405. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +5 -5
  406. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  407. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  408. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  409. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  410. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  411. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  412. package/api/@xmachines/runtime-wasi/README.md +100 -0
  413. package/api/@xmachines/runtime-wasi/variables/component.md +11 -0
  414. package/api/@xmachines/runtime-wasi/variables/schemas.md +11 -0
  415. package/api/@xmachines/runtime-wasi/variables/wit.md +11 -0
  416. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  417. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  418. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  419. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  420. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  421. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  422. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  423. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +1 -1
  424. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  425. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  426. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  427. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  428. package/api/README.md +1 -0
  429. package/api/trains.json +1 -0
  430. package/contributing/configuration.md +11 -2
  431. package/contributing/deployment.md +40 -33
  432. package/contributing/development.md +2 -2
  433. package/examples/@xmachines/play-dom-gallery-demo/functions/createConfirmDialog.md +1 -1
  434. package/examples/@xmachines/play-dom-gallery-demo/functions/createDebugPanel.md +1 -1
  435. package/examples/@xmachines/play-dom-gallery-demo/functions/initApp.md +1 -1
  436. package/examples/@xmachines/play-dom-gallery-demo/functions/initShell.md +1 -1
  437. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  438. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  439. package/examples/@xmachines/play-dom-gallery-demo/interfaces/ShellOptions.md +7 -7
  440. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  441. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  442. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  443. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  444. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GalleryActor.md +1 -1
  445. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GallerySlug.md +1 -1
  446. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/KitCatalog.md +1 -1
  447. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  448. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  449. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  450. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  451. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  452. package/examples/@xmachines/play-dom-gallery-demo/variables/Button.md +1 -1
  453. package/examples/@xmachines/play-dom-gallery-demo/variables/Field.md +1 -1
  454. package/examples/@xmachines/play-dom-gallery-demo/variables/Page.md +1 -1
  455. package/examples/@xmachines/play-dom-gallery-demo/variables/Panel.md +1 -1
  456. package/examples/@xmachines/play-dom-gallery-demo/variables/Text.md +1 -1
  457. package/examples/@xmachines/play-dom-gallery-demo/variables/authCatalog.md +1 -1
  458. package/examples/@xmachines/play-dom-gallery-demo/variables/demoComponents.md +6 -6
  459. package/examples/@xmachines/play-dom-gallery-demo/variables/donutCatalog.md +1 -1
  460. package/examples/@xmachines/play-dom-gallery-demo/variables/fetchCatalog.md +1 -1
  461. package/examples/@xmachines/play-dom-gallery-demo/variables/flightCatalog.md +1 -1
  462. package/examples/@xmachines/play-dom-gallery-demo/variables/galleryMachines.md +1 -1
  463. package/examples/@xmachines/play-dom-gallery-demo/variables/stopwatchCatalog.md +1 -1
  464. package/examples/@xmachines/play-dom-gallery-demo/variables/temperatureCatalog.md +1 -1
  465. package/examples/@xmachines/play-dom-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  466. package/examples/@xmachines/play-dom-gallery-demo/variables/todoMvcCatalog.md +1 -1
  467. package/examples/@xmachines/play-dom-gallery-demo/variables/triviaCatalog.md +1 -1
  468. package/examples/@xmachines/play-react-gallery-demo/functions/App.md +1 -1
  469. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  470. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  471. package/examples/@xmachines/play-react-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  472. package/examples/@xmachines/play-react-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  473. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  474. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  475. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GalleryActor.md +1 -1
  476. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GallerySlug.md +1 -1
  477. package/examples/@xmachines/play-react-gallery-demo/type-aliases/KitCatalog.md +1 -1
  478. package/examples/@xmachines/play-react-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  479. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  480. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  481. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  482. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  483. package/examples/@xmachines/play-react-gallery-demo/variables/Button.md +1 -1
  484. package/examples/@xmachines/play-react-gallery-demo/variables/DebugPanel.md +1 -1
  485. package/examples/@xmachines/play-react-gallery-demo/variables/Field.md +1 -1
  486. package/examples/@xmachines/play-react-gallery-demo/variables/Page.md +1 -1
  487. package/examples/@xmachines/play-react-gallery-demo/variables/Panel.md +1 -1
  488. package/examples/@xmachines/play-react-gallery-demo/variables/Shell.md +1 -1
  489. package/examples/@xmachines/play-react-gallery-demo/variables/Text.md +1 -1
  490. package/examples/@xmachines/play-react-gallery-demo/variables/authCatalog.md +1 -1
  491. package/examples/@xmachines/play-react-gallery-demo/variables/demoComponents.md +6 -6
  492. package/examples/@xmachines/play-react-gallery-demo/variables/donutCatalog.md +1 -1
  493. package/examples/@xmachines/play-react-gallery-demo/variables/fetchCatalog.md +1 -1
  494. package/examples/@xmachines/play-react-gallery-demo/variables/flightCatalog.md +1 -1
  495. package/examples/@xmachines/play-react-gallery-demo/variables/galleryMachines.md +1 -1
  496. package/examples/@xmachines/play-react-gallery-demo/variables/stopwatchCatalog.md +1 -1
  497. package/examples/@xmachines/play-react-gallery-demo/variables/temperatureCatalog.md +1 -1
  498. package/examples/@xmachines/play-react-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  499. package/examples/@xmachines/play-react-gallery-demo/variables/todoMvcCatalog.md +1 -1
  500. package/examples/@xmachines/play-react-gallery-demo/variables/triviaCatalog.md +1 -1
  501. package/examples/@xmachines/play-solid-gallery-demo/functions/App.md +1 -1
  502. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  503. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  504. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  505. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  506. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  507. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  508. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GalleryActor.md +1 -1
  509. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GallerySlug.md +1 -1
  510. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/KitCatalog.md +1 -1
  511. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  512. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  513. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  514. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  515. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  516. package/examples/@xmachines/play-solid-gallery-demo/variables/Button.md +1 -1
  517. package/examples/@xmachines/play-solid-gallery-demo/variables/DebugPanel.md +1 -1
  518. package/examples/@xmachines/play-solid-gallery-demo/variables/Field.md +1 -1
  519. package/examples/@xmachines/play-solid-gallery-demo/variables/Page.md +1 -1
  520. package/examples/@xmachines/play-solid-gallery-demo/variables/Panel.md +1 -1
  521. package/examples/@xmachines/play-solid-gallery-demo/variables/Shell.md +1 -1
  522. package/examples/@xmachines/play-solid-gallery-demo/variables/Text.md +1 -1
  523. package/examples/@xmachines/play-solid-gallery-demo/variables/authCatalog.md +1 -1
  524. package/examples/@xmachines/play-solid-gallery-demo/variables/demoComponents.md +6 -6
  525. package/examples/@xmachines/play-solid-gallery-demo/variables/donutCatalog.md +1 -1
  526. package/examples/@xmachines/play-solid-gallery-demo/variables/fetchCatalog.md +1 -1
  527. package/examples/@xmachines/play-solid-gallery-demo/variables/flightCatalog.md +1 -1
  528. package/examples/@xmachines/play-solid-gallery-demo/variables/galleryMachines.md +1 -1
  529. package/examples/@xmachines/play-solid-gallery-demo/variables/stopwatchCatalog.md +1 -1
  530. package/examples/@xmachines/play-solid-gallery-demo/variables/temperatureCatalog.md +1 -1
  531. package/examples/@xmachines/play-solid-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  532. package/examples/@xmachines/play-solid-gallery-demo/variables/todoMvcCatalog.md +1 -1
  533. package/examples/@xmachines/play-solid-gallery-demo/variables/triviaCatalog.md +1 -1
  534. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  535. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  536. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  537. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  538. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  539. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  540. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GalleryActor.md +1 -1
  541. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GallerySlug.md +1 -1
  542. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/KitCatalog.md +1 -1
  543. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  544. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  545. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  546. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  547. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  548. package/examples/@xmachines/play-svelte-gallery-demo/variables/authCatalog.md +1 -1
  549. package/examples/@xmachines/play-svelte-gallery-demo/variables/demoComponents.md +6 -6
  550. package/examples/@xmachines/play-svelte-gallery-demo/variables/donutCatalog.md +1 -1
  551. package/examples/@xmachines/play-svelte-gallery-demo/variables/fetchCatalog.md +1 -1
  552. package/examples/@xmachines/play-svelte-gallery-demo/variables/flightCatalog.md +1 -1
  553. package/examples/@xmachines/play-svelte-gallery-demo/variables/galleryMachines.md +1 -1
  554. package/examples/@xmachines/play-svelte-gallery-demo/variables/stopwatchCatalog.md +1 -1
  555. package/examples/@xmachines/play-svelte-gallery-demo/variables/temperatureCatalog.md +1 -1
  556. package/examples/@xmachines/play-svelte-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  557. package/examples/@xmachines/play-svelte-gallery-demo/variables/todoMvcCatalog.md +1 -1
  558. package/examples/@xmachines/play-svelte-gallery-demo/variables/triviaCatalog.md +1 -1
  559. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  560. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  561. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  562. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  563. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  564. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  565. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GalleryActor.md +1 -1
  566. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GallerySlug.md +1 -1
  567. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/KitCatalog.md +1 -1
  568. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  569. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  570. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  571. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  572. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  573. package/examples/@xmachines/play-vue-gallery-demo/variables/App.md +1 -1
  574. package/examples/@xmachines/play-vue-gallery-demo/variables/authCatalog.md +1 -1
  575. package/examples/@xmachines/play-vue-gallery-demo/variables/demoComponents.md +1 -1
  576. package/examples/@xmachines/play-vue-gallery-demo/variables/donutCatalog.md +1 -1
  577. package/examples/@xmachines/play-vue-gallery-demo/variables/fetchCatalog.md +1 -1
  578. package/examples/@xmachines/play-vue-gallery-demo/variables/flightCatalog.md +1 -1
  579. package/examples/@xmachines/play-vue-gallery-demo/variables/galleryMachines.md +1 -1
  580. package/examples/@xmachines/play-vue-gallery-demo/variables/stopwatchCatalog.md +1 -1
  581. package/examples/@xmachines/play-vue-gallery-demo/variables/temperatureCatalog.md +1 -1
  582. package/examples/@xmachines/play-vue-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  583. package/examples/@xmachines/play-vue-gallery-demo/variables/todoMvcCatalog.md +1 -1
  584. package/examples/@xmachines/play-vue-gallery-demo/variables/triviaCatalog.md +1 -1
  585. package/package.json +1 -1
@@ -6,7 +6,7 @@
6
6
  type RouteData = Record<string, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-router/src/types.ts#L15)
9
+ Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L15)
10
10
 
11
11
  The resolved extra data of a route. It reaches the consumer on the `data` field of a
12
12
  `play.route` event.
@@ -6,7 +6,7 @@
6
6
  type RouteDataResolver = (args) => RouteData;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-router/src/types.ts#L28)
9
+ Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L28)
10
10
 
11
11
  The function form of [RouteObject.data](../interfaces/RouteObject.md#property-data).
12
12
 
@@ -6,7 +6,7 @@
6
6
  type RouteMachineConfig = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L177)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L177)
10
10
 
11
11
  The minimal structural constraint of a machine config that
12
12
  `formatPlayRouteTransitions` accepts.
@@ -32,7 +32,7 @@ original concrete type through the transform. Therefore
32
32
  context?: unknown;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L178)
35
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L178)
36
36
 
37
37
  ---
38
38
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
42
42
  on?: Record<string, unknown>;
43
43
  ```
44
44
 
45
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L180)
45
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L180)
46
46
 
47
47
  ---
48
48
 
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
52
52
  states?: Record<string, unknown>;
53
53
  ```
54
54
 
55
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L179)
55
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L179)
@@ -6,6 +6,6 @@
6
6
  type RouteMetadata = string | RouteObject;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-router/src/types.ts#L151)
9
+ Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-router/src/types.ts#L151)
10
10
 
11
11
  The route metadata of the `meta.route` field of a state machine.
@@ -6,7 +6,7 @@
6
6
  type RouteStateNode = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
10
10
 
11
11
  The minimal structural shape of one XState state node, as
12
12
  `formatPlayRouteTransitions` reads it during its walk over the machine config.
@@ -29,7 +29,7 @@ signature without a change.
29
29
  id?: string;
30
30
  ```
31
31
 
32
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L34)
32
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L34)
33
33
 
34
34
  The optional explicit state ID, for example `"home"` or `"settings"`. It is the `#id` target of a `play.route` event.
35
35
 
@@ -41,7 +41,7 @@ The optional explicit state ID, for example `"home"` or `"settings"`. It is the
41
41
  meta?: object;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L36)
44
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L36)
45
45
 
46
46
  The state metadata. A `meta.route` field gives the state a route.
47
47
 
@@ -64,7 +64,7 @@ generated transition, and that flag defaults to `false`.
64
64
  on?: Record<string, unknown>;
65
65
  ```
66
66
 
67
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
67
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
68
68
 
69
69
  The event handlers of this state. The function reads them where a child asks for a
70
70
  local `play.route` handler, so that the transitions of the user survive the merge.
@@ -77,6 +77,6 @@ local `play.route` handler, so that the transitions of the user survive the merg
77
77
  states?: Record<string, RouteStateNode>;
78
78
  ```
79
79
 
80
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L46)
80
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L46)
81
81
 
82
82
  The nested child states. The function walks them for each further route declaration.
@@ -6,7 +6,7 @@
6
6
  function withView<TMachine>(Base): PlayerConstructor<TMachine, Viewable>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/with-view.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/with-view.ts#L61)
9
+ Defined in: [packages/play-xstate/src/with-view.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-xstate/src/with-view.ts#L61)
10
10
 
11
11
  Adds the view capability to an actor class.
12
12
 
@@ -0,0 +1,100 @@
1
+ [API](../../README.md) / @xmachines/runtime-wasi
2
+
3
+ # @xmachines/runtime-wasi
4
+
5
+ The WASI 0.2 component of the xmachines-rs runtime, with its WIT package and the JSON Schemas of its JSON text.
6
+
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-1.2.0-blue)](https://www.npmjs.com/package/@xmachines/runtime-wasi)
8
+
9
+ The component (`wasm32-wasip2`) runs XState v6 machine definitions. The host gives it the guards, the actions, the delays and the expressions. It is the build of the crate [`xmachines-runtime-wasi`](https://docs.rs/xmachines-runtime-wasi) of [xmachines-rs](https://gitlab.com/xmachin-es/xmachines-rs). The package also holds the WIT package `xmachines:runtime` of the component, and the JSON Schemas of the JSON text that the component passes.
10
+
11
+ xmachines-rs is an independent runtime. It is not an official Stately package.
12
+
13
+ ## Installation
14
+
15
+ ```bash
16
+ pnpm add @xmachines/runtime-wasi
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ The package gives each file as a URL. Node's `fs`, the bindings of Wasmtime and jco take a file URL, and a bundler resolves `new URL(…, import.meta.url)` as an asset:
22
+
23
+ ```ts norun
24
+ import { component, schemas, wit } from "@xmachines/runtime-wasi";
25
+ import { readFile } from "node:fs/promises";
26
+
27
+ const bytes = await readFile(component); // the component, of the world xmachines:runtime/runtime
28
+ const source = await readFile(wit, "utf8"); // the WIT package xmachines:runtime
29
+ const snapshot = new URL("snapshot.schema.json", schemas);
30
+ ```
31
+
32
+ The package also exports each file by its path: `@xmachines/runtime-wasi/xmachines_runtime_wasi.wasm` and `@xmachines/runtime-wasi/wit/…`.
33
+
34
+ ## Contract
35
+
36
+ The world `xmachines:runtime/runtime` exports `actors` and the `actor` resource: `start` and `restore`, `send`, `send-to`, `advance`, `next-deadline`, `snapshot`, `persist`, the emitted events and logs, `pending-effects`, `resolve-effect` and `stop`. It imports `implementations`: `guard`, `action`, `delay`, `expr`, `context-expr` and `evaluate`.
37
+
38
+ Values cross as JSON text. A JSON Schema (draft 2020-12) of `wit/schemas/` specifies each string, and the `$id` of each schema is its published place in xmachines-rs. The [README of the crate](https://docs.rs/xmachines-runtime-wasi) and the [guide to the WASI components](https://gitlab.com/xmachin-es/xmachines-rs/-/blob/main/crates/xmachines-docs/guides/wasi.md) give the rest.
39
+
40
+ ## The runtime that the package ships
41
+
42
+ Git holds no file of the runtime. The `package.json` of the package pins it, under `xmachines.runtime`:
43
+
44
+ ```json
45
+ {
46
+ "xmachines": {
47
+ "runtime": {
48
+ "version": "1.1.0",
49
+ "sha256": {
50
+ "wit/runtime.wit": "7c546c3b…",
51
+ "xmachines_runtime_wasi.wasm": "1387f1cf…"
52
+ }
53
+ }
54
+ }
55
+ }
56
+ ```
57
+
58
+ - `version` is the release of the xmachines-rs runtime, the tag `runtime-v<version>` of xmachines-rs.
59
+ - `sha256` holds the SHA-256 of each file that the package ships, by its path below `dist/`: the component, and each file of the WIT package.
60
+
61
+ Each release of xmachines-rs uploads two files to the generic package registry of its project, at the version of the release:
62
+
63
+ - `xmachines_runtime_wasi.wasm`, the component.
64
+ - `wit.tar.gz`, the WIT package and its JSON Schemas, which unpacks to `wit/`.
65
+
66
+ The build of the package (`pnpm --filter @xmachines/runtime-wasi run build`, or the root `pnpm run build`) downloads the two files of the pinned version, unpacks the archive, and compares each file with its SHA-256 in the pin. A file that is missing, extra or changed fails the build, and the build then writes nothing. The files go into `dist/`, which git ignores. A file that `dist/` holds already, and that matches the pin, stays, so a second build downloads nothing. The tests of the package do the same before they run.
67
+
68
+ The download and the check are `scripts/fetch-runtime-wasi.mjs` and `scripts/lib/runtime-wasi.mjs`, at the root of the repository.
69
+
70
+ ## How a bump arrives
71
+
72
+ The tag pipeline of a release of xmachines-rs triggers a pipeline of xmachines-js on `main`. The trigger gives two variables: `RUNTIME_VERSION`, as `1.2.0`, and `RUNTIME_RELEASE_TYPE`, which is `major`, `minor` or `patch`. That pipeline runs one job, `runtime-wasi-bump`:
73
+
74
+ 1. It downloads the files of the version, and computes the SHA-256 of each file.
75
+ 2. It writes the new pin into `package.json`.
76
+ 3. It commits the pin on the branch `runtime-wasi/runtime-<version>`. The type of the release gives the type of the commit:
77
+ - `major`: `feat(runtime-wasi)!: the xmachines-rs runtime <version>`, with a `BREAKING CHANGE:` footer.
78
+ - `minor`: `feat(runtime-wasi): the xmachines-rs runtime <version>`.
79
+ - `patch`: `fix(runtime-wasi): the xmachines-rs runtime <version>`.
80
+ 4. It pushes the branch, with the push options that open its merge request into `main`.
81
+
82
+ A branch that exists already, or a pin of the version already, ends the job with success, and the job changes nothing. The merge request runs the pipeline of every change, and its merge releases the `runtime` train.
83
+
84
+ ## Versions
85
+
86
+ The package is the `runtime` train of xmachines-js, and the train has its own version, by its tags `runtime-v<version>`. The version of the package therefore is not the version of the runtime that it ships: `xmachines.runtime.version` of its `package.json` is. The bump of a major release of the runtime is a major release of the package, the bump of a minor release is a minor release, and the bump of a patch is a patch. The WIT package has a version of its own, which its file names.
87
+
88
+ The files of the package, as URLs that a host loads them by: the WASI component of the
89
+ xmachines-rs runtime, its WIT package, and the JSON Schemas of the JSON text that the component
90
+ passes. Node's `fs`, the bindings of Wasmtime and jco take a file URL, and a bundler resolves
91
+ `new URL(…, import.meta.url)` as an asset.
92
+
93
+ The build puts the files into `dist/`, beside this module. Each URL names `../dist/`, so it
94
+ resolves to the same file from `src/` (the `source` condition) and from `dist/`.
95
+
96
+ ## Variables
97
+
98
+ - [component](variables/component.md)
99
+ - [schemas](variables/schemas.md)
100
+ - [wit](variables/wit.md)
@@ -0,0 +1,11 @@
1
+ [API](../../../README.md) / [@xmachines/runtime-wasi](../README.md) / component
2
+
3
+ # Variable: component
4
+
5
+ ```ts
6
+ const component: URL;
7
+ ```
8
+
9
+ Defined in: [index.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/runtime-wasi/src/index.ts#L17)
10
+
11
+ The WASI 0.2 component (`wasm32-wasip2`), of the world `xmachines:runtime/runtime`.
@@ -0,0 +1,11 @@
1
+ [API](../../../README.md) / [@xmachines/runtime-wasi](../README.md) / schemas
2
+
3
+ # Variable: schemas
4
+
5
+ ```ts
6
+ const schemas: URL;
7
+ ```
8
+
9
+ Defined in: [index.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/runtime-wasi/src/index.ts#L26)
10
+
11
+ The folder of the JSON Schemas (draft 2020-12) of the JSON text that the WIT names, with a `/` at its end.
@@ -0,0 +1,11 @@
1
+ [API](../../../README.md) / [@xmachines/runtime-wasi](../README.md) / wit
2
+
3
+ # Variable: wit
4
+
5
+ ```ts
6
+ const wit: URL;
7
+ ```
8
+
9
+ Defined in: [index.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/runtime-wasi/src/index.ts#L23)
10
+
11
+ The WIT package `xmachines:runtime`, of the world that the component exports and imports.
@@ -6,7 +6,7 @@
6
6
  function xmAliases(importMetaUrl, target?): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L311)
9
+ Defined in: [vite-aliases.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L311)
10
10
 
11
11
  Vite resolve.alias entries for all @xmachines/* workspace packages.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function xmBuildOutput(importMetaUrl): Plugin;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L407)
9
+ Defined in: [vite-aliases.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L407)
10
10
 
11
11
  The Vite plugin of the dist run: it moves each `src/` file of a published package to its
12
12
  counterpart in `dist/`.
@@ -6,7 +6,7 @@
6
6
  function xmBuildOutputFile(packageDir, sourceFile): string;
7
7
  ```
8
8
 
9
- Defined in: [vite-aliases.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L378)
9
+ Defined in: [vite-aliases.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L378)
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:514](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L514)
9
+ Defined in: [vite-aliases.ts:514](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L514)
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:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L467)
9
+ Defined in: [vite-aliases.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L467)
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:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L352)
9
+ Defined in: [vite-aliases.ts:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L352)
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:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L493)
9
+ Defined in: [vite-aliases.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L493)
10
10
 
11
11
  Svelte plugin options that enforce runes mode for workspace sources only.
12
12
 
@@ -35,4 +35,4 @@ one and change the other.
35
35
 
36
36
  | Name | Type | Defined in |
37
37
  | ------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
38
- | `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:494](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L494) |
38
+ | `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:494](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vite-aliases.ts#L494) |
@@ -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/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L25)
9
+ Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/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/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L13)
9
+ Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/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:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L230)
9
+ Defined in: [vitest.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vitest.ts#L230)
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/docs-v7.2.0/packages/shared/config/vitest.ts#L76)
9
+ Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vitest.ts#L76)
10
10
 
11
11
  Create a Vitest config with XMachines workspace defaults.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: XmBrowserConfigOptions
4
4
 
5
- Defined in: [vitest.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L180)
5
+ Defined in: [vitest.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vitest.ts#L180)
6
6
 
7
7
  Options for [defineXmBrowserConfig](../functions/defineXmBrowserConfig.md) that live outside the plain
8
8
  Vitest config overrides.
@@ -11,6 +11,6 @@ Vitest config overrides.
11
11
 
12
12
  | Property | Type | Description | Defined in |
13
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:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L188) |
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:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L195) |
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:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L201) |
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:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vitest.ts#L188) |
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:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vitest.ts#L195) |
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:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/shared/config/vitest.ts#L201) |
package/api/README.md CHANGED
@@ -25,4 +25,5 @@
25
25
  - [@xmachines/play-vue](@xmachines/play-vue/README.md)
26
26
  - [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md)
27
27
  - [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
28
+ - [@xmachines/runtime-wasi](@xmachines/runtime-wasi/README.md)
28
29
  - [@xmachines/shared](@xmachines/shared/README.md)
package/api/trains.json CHANGED
@@ -25,6 +25,7 @@
25
25
  "@xmachines/play-vue-router",
26
26
  "@xmachines/play-xstate"
27
27
  ],
28
+ "runtime": ["@xmachines/runtime-wasi"],
28
29
  "docs": ["@xmachines/docs"]
29
30
  }
30
31
  }
@@ -20,6 +20,15 @@ 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
+ ### Runtime Bump Variables
24
+
25
+ | Variable | Required | Default | Description |
26
+ | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
27
+ | `RUNTIME_VERSION` | Yes | — | The release of the xmachines-rs runtime that the bump pins, as `1.2.0`. |
28
+ | `RUNTIME_RELEASE_TYPE` | Yes | — | The type of that release: `major`, `minor` or `patch`. It gives the type of the commit. |
29
+
30
+ **Defined in:** the trigger of the tag pipeline of xmachines-rs, which starts a pipeline of this project on `main`. **Read by:** the `runtime-wasi-bump` job (`scripts/bump-runtime-wasi.mjs`). A pipeline of the source `pipeline` with `RUNTIME_VERSION` runs that job alone. See the [README of `@xmachines/runtime-wasi`](../api/@xmachines/runtime-wasi/README.md#how-a-bump-arrives).
31
+
23
32
  ---
24
33
 
25
34
  ## Configuration Files
@@ -406,9 +415,9 @@ Defines the trains, the release branches, and the plugins of each run: the run o
406
415
  | `alpha` | `alpha` | `alpha` |
407
416
  | `pre` | `pre` | `pre` |
408
417
 
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`.
418
+ `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*`, `runtime-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
419
 
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.
420
+ **Trains:** `core` (`packages/core`), `play` (`packages/play`, `packages/play-*`), `runtime` (`packages/runtime-wasi`) and `docs` (`packages/docs`, with every file of `core`, `play` and `runtime` counting for it too). The build files of the root and `packages/shared` count for every train.
412
421
 
413
422
  **Tag format:** `<train>-v${version}`, as `play-v7.1.0`.
414
423
 
@@ -20,34 +20,35 @@ The root `package.json` is marked `"private": true` and is **never published** t
20
20
 
21
21
  ## Published Packages
22
22
 
23
- The release is in **trains**, each released on its own: `core`, `play` and `docs`. A train publishes every package under its paths that is not private, at the version of the train's release (`release.config.mjs`, `trains`):
24
-
25
- | Package | Directory | Train |
26
- | ------------------------------------------------------------------------------------------------- | ------------------------------------- | ------ |
27
- | [`@xmachines/core`](../api/@xmachines/core/README.md) | `packages/core` | `core` |
28
- | [`@xmachines/play`](../api/@xmachines/play/README.md) | `packages/play` | `play` |
29
- | [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md) | `packages/play-actor` | `play` |
30
- | [`@xmachines/play-atom`](../api/@xmachines/play-atom/README.md) | `packages/play-atom` | `play` |
31
- | [`@xmachines/play-dom`](../api/@xmachines/play-dom/README.md) | `packages/play-dom` | `play` |
32
- | [`@xmachines/play-dom-router`](../api/@xmachines/play-dom-router/README.md) | `packages/play-dom-router` | `play` |
33
- | [`@xmachines/play-pattern`](../api/@xmachines/play-pattern/README.md) | `packages/play-pattern` | `play` |
34
- | [`@xmachines/play-react`](../api/@xmachines/play-react/README.md) | `packages/play-react` | `play` |
35
- | [`@xmachines/play-react-router`](../api/@xmachines/play-react-router/README.md) | `packages/play-react-router` | `play` |
36
- | [`@xmachines/play-router`](../api/@xmachines/play-router/README.md) | `packages/play-router` | `play` |
37
- | [`@xmachines/play-solid`](../api/@xmachines/play-solid/README.md) | `packages/play-solid` | `play` |
38
- | [`@xmachines/play-solid-router`](../api/@xmachines/play-solid-router/README.md) | `packages/play-solid-router` | `play` |
39
- | [`@xmachines/play-svelte`](../api/@xmachines/play-svelte/README.md) | `packages/play-svelte` | `play` |
40
- | [`@xmachines/play-svelte-spa-router`](../api/@xmachines/play-svelte-spa-router/README.md) | `packages/play-svelte-spa-router` | `play` |
41
- | [`@xmachines/play-sveltekit-router`](../api/@xmachines/play-sveltekit-router/README.md) | `packages/play-sveltekit-router` | `play` |
42
- | [`@xmachines/play-tanstack-react-router`](../api/@xmachines/play-tanstack-react-router/README.md) | `packages/play-tanstack-react-router` | `play` |
43
- | [`@xmachines/play-tanstack-router`](../api/@xmachines/play-tanstack-router/README.md) | `packages/play-tanstack-router` | `play` |
44
- | [`@xmachines/play-tanstack-solid-router`](../api/@xmachines/play-tanstack-solid-router/README.md) | `packages/play-tanstack-solid-router` | `play` |
45
- | [`@xmachines/play-url`](../api/@xmachines/play-url/README.md) | `packages/play-url` | `play` |
46
- | [`@xmachines/play-view`](../api/@xmachines/play-view/README.md) | `packages/play-view` | `play` |
47
- | [`@xmachines/play-vue`](../api/@xmachines/play-vue/README.md) | `packages/play-vue` | `play` |
48
- | [`@xmachines/play-vue-router`](../api/@xmachines/play-vue-router/README.md) | `packages/play-vue-router` | `play` |
49
- | [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) | `packages/play-xstate` | `play` |
50
- | [`@xmachines/docs`](../README.md) | `packages/docs` | `docs` |
23
+ The release is in **trains**, each released on its own: `core`, `play`, `runtime` and `docs`. A train publishes every package under its paths that is not private, at the version of the train's release (`release.config.mjs`, `trains`):
24
+
25
+ | Package | Directory | Train |
26
+ | ------------------------------------------------------------------------------------------------- | ------------------------------------- | --------- |
27
+ | [`@xmachines/core`](../api/@xmachines/core/README.md) | `packages/core` | `core` |
28
+ | [`@xmachines/play`](../api/@xmachines/play/README.md) | `packages/play` | `play` |
29
+ | [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md) | `packages/play-actor` | `play` |
30
+ | [`@xmachines/play-atom`](../api/@xmachines/play-atom/README.md) | `packages/play-atom` | `play` |
31
+ | [`@xmachines/play-dom`](../api/@xmachines/play-dom/README.md) | `packages/play-dom` | `play` |
32
+ | [`@xmachines/play-dom-router`](../api/@xmachines/play-dom-router/README.md) | `packages/play-dom-router` | `play` |
33
+ | [`@xmachines/play-pattern`](../api/@xmachines/play-pattern/README.md) | `packages/play-pattern` | `play` |
34
+ | [`@xmachines/play-react`](../api/@xmachines/play-react/README.md) | `packages/play-react` | `play` |
35
+ | [`@xmachines/play-react-router`](../api/@xmachines/play-react-router/README.md) | `packages/play-react-router` | `play` |
36
+ | [`@xmachines/play-router`](../api/@xmachines/play-router/README.md) | `packages/play-router` | `play` |
37
+ | [`@xmachines/play-solid`](../api/@xmachines/play-solid/README.md) | `packages/play-solid` | `play` |
38
+ | [`@xmachines/play-solid-router`](../api/@xmachines/play-solid-router/README.md) | `packages/play-solid-router` | `play` |
39
+ | [`@xmachines/play-svelte`](../api/@xmachines/play-svelte/README.md) | `packages/play-svelte` | `play` |
40
+ | [`@xmachines/play-svelte-spa-router`](../api/@xmachines/play-svelte-spa-router/README.md) | `packages/play-svelte-spa-router` | `play` |
41
+ | [`@xmachines/play-sveltekit-router`](../api/@xmachines/play-sveltekit-router/README.md) | `packages/play-sveltekit-router` | `play` |
42
+ | [`@xmachines/play-tanstack-react-router`](../api/@xmachines/play-tanstack-react-router/README.md) | `packages/play-tanstack-react-router` | `play` |
43
+ | [`@xmachines/play-tanstack-router`](../api/@xmachines/play-tanstack-router/README.md) | `packages/play-tanstack-router` | `play` |
44
+ | [`@xmachines/play-tanstack-solid-router`](../api/@xmachines/play-tanstack-solid-router/README.md) | `packages/play-tanstack-solid-router` | `play` |
45
+ | [`@xmachines/play-url`](../api/@xmachines/play-url/README.md) | `packages/play-url` | `play` |
46
+ | [`@xmachines/play-view`](../api/@xmachines/play-view/README.md) | `packages/play-view` | `play` |
47
+ | [`@xmachines/play-vue`](../api/@xmachines/play-vue/README.md) | `packages/play-vue` | `play` |
48
+ | [`@xmachines/play-vue-router`](../api/@xmachines/play-vue-router/README.md) | `packages/play-vue-router` | `play` |
49
+ | [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md) | `packages/play-xstate` | `play` |
50
+ | [`@xmachines/runtime-wasi`](../api/@xmachines/runtime-wasi/README.md) | `packages/runtime-wasi` | `runtime` |
51
+ | [`@xmachines/docs`](../README.md) | `packages/docs` | `docs` |
51
52
 
52
53
  Every package of `packages/play-*` that is not private is on the `play` train. [`@xmachines/shared`](../api/@xmachines/shared/README.md) is private: it holds the configs every package is built with, and no train publishes it.
53
54
 
@@ -67,11 +68,14 @@ Pipeline runs are triggered by `.gitlab-ci.yml` under the following conditions:
67
68
  | --------------------------------------------------------- | -------------------------------------------------- |
68
69
  | Push to `main` / `next` / `rc` / `beta` / `alpha` / `pre` | Full pipeline; the release jobs wait to be started |
69
70
  | Merge request | Full pipeline, no release job |
71
+ | The trigger of a release of xmachines-rs | `runtime-wasi-bump` alone, which opens the bump |
70
72
  | Web / API / trigger / parent pipeline | Full pipeline |
71
73
  | A release tag, `<train>-v<version>` | `publish-release` alone, which publishes the train |
72
74
 
73
75
  No rule admits another tag, so pushing one runs nothing.
74
76
 
77
+ The tag pipeline of a release of xmachines-rs triggers a pipeline of this project on `main`, with the variables `RUNTIME_VERSION` and `RUNTIME_RELEASE_TYPE`. That pipeline is of the source `pipeline`, and it runs `runtime-wasi-bump` and no other job: each job starts its rules with `.bump-rules`. The job commits the new pin of [`@xmachines/runtime-wasi`](../api/@xmachines/runtime-wasi/README.md) on a branch, and pushes it with the push options that open its merge request. See [the README of the package](../api/@xmachines/runtime-wasi/README.md#how-a-bump-arrives).
78
+
75
79
  The pipeline includes two reusable CI components, both pinned in `.gitlab-ci.yml` — which is the version to trust, rather than a number repeated here:
76
80
 
77
81
  - **`to-be-continuous/node/gitlab-ci-node`** — handles install, lint, build, test, and audit
@@ -119,7 +123,7 @@ To run the same check on your machine, run `pnpm run docs` and then `pnpm run te
119
123
 
120
124
  ### Release Job Detail
121
125
 
122
- The `semantic-release` job is the job of the `to-be-continuous/semantic-release` component, with its own rules: manual on every release branch, and a `resource_group` that runs one release at a time. One click releases every train: the job runs semantic-release once for each train that the pipeline's input `release-trains` names, all three by default, in the order of the trains of `release.config.mjs`: `core`, then `play`, then `docs`, whatever order they were ticked in. A train with no commit that releases it releases nothing, and the next one runs. A run that fails stops the job; retry it, and each train it released already has nothing left to release. To release some trains alone, tick them in the multi-select `release-trains` of **Run pipeline**, or set `RELEASE_TRAINS` as you start the job, as `docs`: the input is the default of the global variable `RELEASE_TRAINS`, which a CI/CD variable overrides, as a to-be-continuous component maps its inputs. A name of no train fails the job.
126
+ The `semantic-release` job is the job of the `to-be-continuous/semantic-release` component, with its own rules: manual on every release branch, and a `resource_group` that runs one release at a time. One click releases every train: the job runs semantic-release once for each train that the pipeline's input `release-trains` names, all of them by default, in the order of the trains of `release.config.mjs`: `core`, then `play`, then `runtime`, then `docs`, whatever order they were ticked in. A train with no commit that releases it releases nothing, and the next one runs. A run that fails stops the job; retry it, and each train it released already has nothing left to release. To release some trains alone, tick them in the multi-select `release-trains` of **Run pipeline**, or set `RELEASE_TRAINS` as you start the job, as `docs`: the input is the default of the global variable `RELEASE_TRAINS`, which a CI/CD variable overrides, as a to-be-continuous component maps its inputs. A name of no train fails the job.
123
127
 
124
128
  The component turns `release.config.mjs` into `.releaserc.json`, of `RELEASE_TRAIN=docs`, whose run names every plugin of the others' runs too, and installs semantic-release and each plugin that the config names, globally. The config is therefore literals: it imports no plugin, and holds no top-level await. The job then removes `.releaserc.json`, so each run reads `release.config.mjs` of its own train.
125
129
 
@@ -165,6 +169,8 @@ The channel becomes the npm dist-tag verbatim, which is why none of them contain
165
169
 
166
170
  The tag format of a train is `<train>-v${version}`. Every train continued from 7.0.0, the last release of one version for everything: `core-v7.0.0`, `play-v7.0.0` and `docs-v7.0.0` name its commit.
167
171
 
172
+ The `runtime` train continues from 1.1.0, the last release of [`@xmachines/runtime-wasi`](../api/@xmachines/runtime-wasi/README.md) of xmachines-rs. The tag `runtime-v1.1.0` names the commit of `main` before the first commit of the package in this repository. That tag is a boundary, and it released nothing here: its push carried `-o ci.skip`, so its pipeline did not publish 1.1.0 a second time.
173
+
168
174
  #### `next` after a release of `main`
169
175
 
170
176
  `main` stays on XState 5 and merges into `next`. **After each release on `main`, merge `main` into `next`**, by a merge request from `main` to `next`, kept unsquashed, that keeps `main` (its source branch is never deleted).
@@ -177,18 +183,19 @@ A commit counts for a train when it changes a file under the train's paths, or o
177
183
 
178
184
  - `core`: `packages/core`.
179
185
  - `play`: `packages/play` and `packages/play-*`, the demos too.
180
- - `docs`: `packages/docs`, and every file of `core` and of `play`: the reference documents them, so a release of either is a release of `docs`. Release `docs` last.
186
+ - `runtime`: `packages/runtime-wasi`.
187
+ - `docs`: `packages/docs`, and every file of `core`, of `play` and of `runtime`: the reference documents them, so a release of any of them is a release of `docs`. Release `docs` last.
181
188
 
182
189
  The files every package is built with count for every train: the root `package.json`, `pnpm-lock.yaml`, `pnpm-workspace.yaml`, `tsconfig.json`, `vite.config.ts`, and `packages/shared`.
183
190
 
184
- Release the trains in order: `core`, then `play`, then `docs`. `play` depends on `core`, and `dependencies: "fail"` of the config fails a run of `play` while `core` has commits that would release and are not released: its publish would pin `core`'s last release, without what those commits changed. The job runs them in that order; one of the input `play` alone fails so. `docs` depends on both by the `dependsOn` of its train, as its package depends on neither, and fails so too: its reference would show their old version badges until its next release.
191
+ Release the trains in order: `core`, then `play`, then `runtime`, then `docs`. `play` depends on `core`, and `dependencies: "fail"` of the config fails a run of `play` while `core` has commits that would release and are not released: its publish would pin `core`'s last release, without what those commits changed. The job runs them in that order; one of the input `play` alone fails so. `docs` depends on the other three by the `dependsOn` of its train, as its package depends on none of them, and fails so too: its reference would show their old version badges until its next release.
185
192
 
186
193
  ### Branch Phase
187
194
 
188
195
  The job of a train runs these plugins, in this order:
189
196
 
190
197
  1. **The analyzer and the notes generator**, each wrapped by an entry of `@wtf/semantic-release-trains` (`wrap`), which gives it the train's commits alone. Each entry of the trains plugin also checks the trains: no file on two of them, and the trains the train depends on released. `type!:` is a breaking change, by `parserOpts` at the root of the config.
191
- 2. **`@semantic-release/changelog`** writes the train's changelog, the `CHANGELOG.md` of its first path: `packages/core/CHANGELOG.md`, `packages/play/CHANGELOG.md`, `packages/docs/CHANGELOG.md`. The root `CHANGELOG.md` holds the history up to 7.0.0.
198
+ 2. **`@semantic-release/changelog`** writes the train's changelog, the `CHANGELOG.md` of its first path: `packages/core/CHANGELOG.md`, `packages/play/CHANGELOG.md`, `packages/runtime-wasi/CHANGELOG.md`, `packages/docs/CHANGELOG.md`. The root `CHANGELOG.md` holds the history up to 7.0.0.
192
199
  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: a RegExp of the badge of shields.io, its version written as `shields` escapes it. `tests/readme-badges.test.ts` holds the template to every badge of the READMEs.
193
200
  4. **Of `docs` alone**, the reference: `corepack enable`, `pnpm install --frozen-lockfile`, `pnpm run build`, TypeDoc at the revision `docs-v${nextRelease.version}`, and `oxfmt` of the docs package, each a `@semantic-release/exec` step. Then an entry of `@wtf/semantic-release-trains` of `generated: true` stages the trees TypeDoc writes, deletions too: the git plugin stages what `git ls-files -m -o` reports, which never reports a deletion, so a page of an export that was renamed or removed would stay in git for ever.
194
201
  5. **`@semantic-release/git`** commits the changelog, the READMEs of the train, and of `docs` the reference (`packages/docs/api/**`, `packages/docs/examples/@xmachines/**` and the demo lists of `packages/docs/examples/README.md`), as:
@@ -247,7 +254,7 @@ What it costs:
247
254
 
248
255
  To publish packages, a maintainer must:
249
256
 
250
- 1. Have push access to a release-eligible branch (`main`, `next`, `rc`, `beta`, `alpha`, `pre`). `GITLAB_TOKEN` is a protected variable, so each of these branches is protected, and a new release branch must be too. The tags of the trains (`core-v*`, `play-v*`, `docs-v*`) are protected, so the tag's pipeline gets the token for the GitLab release.
257
+ 1. Have push access to a release-eligible branch (`main`, `next`, `rc`, `beta`, `alpha`, `pre`). `GITLAB_TOKEN` is a protected variable, so each of these branches is protected, and a new release branch must be too. The tags of the trains (`core-v*`, `play-v*`, `runtime-v*`, `docs-v*`) are protected, so the tag's pipeline gets the token for the GitLab release.
251
258
  2. Ensure the GitLab project CI/CD variables include the required tokens.
252
259
 
253
260
  ---