@xmachines/docs 7.0.0 → 8.0.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (542) hide show
  1. package/README.md +2 -2
  2. package/api/@xmachines/core/cache/functions/createLruCache.md +1 -1
  3. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
  4. package/api/@xmachines/core/errors/classes/BaseError.md +11 -11
  5. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +11 -11
  6. package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
  7. package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
  8. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  9. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  10. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
  12. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  13. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  14. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  15. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  16. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  18. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  19. package/api/@xmachines/play/README.md +1 -1
  20. package/api/@xmachines/play/errors/classes/NonNullableError.md +11 -11
  21. package/api/@xmachines/play/errors/classes/PlayError.md +11 -11
  22. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  23. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +4 -4
  24. package/api/@xmachines/play-actor/README.md +3 -3
  25. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +4 -4
  26. package/api/@xmachines/play-actor/interfaces/PlayActor.md +6 -6
  27. package/api/@xmachines/play-atom/README.md +6 -4
  28. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  29. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  30. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  31. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +6 -6
  32. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +4 -4
  33. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  34. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  35. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  36. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  37. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  38. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  39. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  40. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  41. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  42. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  43. package/api/@xmachines/play-dom/README.md +8 -5
  44. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  45. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  46. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  47. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +12 -12
  48. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  49. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +15 -15
  50. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  51. package/api/@xmachines/play-dom-router/README.md +5 -3
  52. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  53. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  54. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  55. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  56. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  57. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +5 -5
  58. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  59. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  60. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  61. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +9 -9
  62. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  63. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  64. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  65. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  66. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  67. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +8 -8
  68. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  69. package/api/@xmachines/play-pattern/README.md +1 -1
  70. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  71. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  72. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  73. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  74. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  75. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  76. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  77. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  78. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  79. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  80. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  81. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  82. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  83. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  84. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  85. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  86. package/api/@xmachines/play-react/README.md +5 -5
  87. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  88. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  89. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  90. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  91. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  92. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +8 -8
  93. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +6 -6
  94. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  95. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  96. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  97. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  98. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  99. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  100. package/api/@xmachines/play-react-router/README.md +1 -1
  101. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  102. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  103. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  104. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  105. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +9 -9
  106. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  107. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +6 -6
  108. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  109. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  110. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  111. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  112. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  113. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  114. package/api/@xmachines/play-router/README.md +15 -14
  115. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +11 -11
  116. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +12 -12
  117. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +12 -12
  118. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +12 -12
  119. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +12 -12
  120. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +12 -12
  121. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +13 -13
  122. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +11 -11
  123. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +13 -13
  124. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  125. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  126. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  127. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  128. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  136. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +5 -5
  142. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  143. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  144. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  146. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  148. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  152. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +5 -5
  153. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +6 -6
  154. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  155. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  156. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  157. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +5 -5
  158. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +8 -8
  159. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +10 -10
  160. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  161. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +14 -14
  162. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +9 -9
  163. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +11 -11
  164. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +5 -5
  165. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +5 -5
  166. package/api/@xmachines/play-router/index/interfaces/Routable.md +5 -5
  167. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +6 -6
  168. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +10 -10
  169. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  170. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +5 -5
  171. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +5 -5
  172. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +12 -12
  173. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +7 -7
  174. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +7 -7
  175. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  176. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  177. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +7 -7
  178. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +8 -8
  179. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +7 -7
  180. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  181. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  182. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  183. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  184. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  185. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  186. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  187. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  188. package/api/@xmachines/play-router/xstate/README.md +5 -2
  189. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +2 -2
  190. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +5 -5
  191. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  192. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  193. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  194. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +7 -8
  195. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +8 -9
  196. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  197. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  198. package/api/@xmachines/play-router/xstate/interfaces/Graph.md +26 -0
  199. package/api/@xmachines/play-router/xstate/interfaces/GraphEdge.md +22 -0
  200. package/api/@xmachines/play-router/xstate/interfaces/GraphNode.md +21 -0
  201. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +6 -6
  202. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +7 -7
  203. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +4 -6
  204. package/api/@xmachines/play-solid/README.md +3 -3
  205. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  206. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  207. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  208. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  209. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  210. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  212. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  214. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  215. package/api/@xmachines/play-solid-router/README.md +4 -6
  216. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  217. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  218. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +6 -6
  220. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +9 -9
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  222. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +6 -6
  223. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  225. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  226. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  229. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  230. package/api/@xmachines/play-svelte/README.md +3 -3
  231. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  232. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  235. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  236. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  237. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  238. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  239. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  240. package/api/@xmachines/play-svelte-spa-router/README.md +6 -3
  241. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  242. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  243. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  244. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +5 -5
  245. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +9 -9
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +6 -6
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +8 -8
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  253. package/api/@xmachines/play-sveltekit-router/README.md +3 -2
  254. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  255. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  256. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  257. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +5 -5
  258. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +11 -11
  259. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  260. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +9 -9
  261. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  263. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  264. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  265. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +8 -8
  266. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +8 -8
  267. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +1 -1
  268. package/api/@xmachines/play-tanstack-react-router/README.md +3 -2
  269. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  270. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  271. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +9 -9
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +6 -6
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  282. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  284. package/api/@xmachines/play-tanstack-router/README.md +3 -2
  285. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  286. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  287. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  288. package/api/@xmachines/play-tanstack-solid-router/README.md +6 -7
  289. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  290. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  291. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +9 -9
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +6 -6
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  298. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  303. package/api/@xmachines/play-url/README.md +1 -1
  304. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +12 -12
  305. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +12 -12
  306. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +13 -13
  307. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  308. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  309. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  310. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  311. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  312. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  313. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  314. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  315. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  316. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  317. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  318. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  319. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  320. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  321. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  322. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  323. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  324. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +5 -5
  325. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  326. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  327. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +6 -6
  328. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  329. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +5 -5
  330. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +9 -9
  331. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  332. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +14 -14
  333. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +6 -6
  334. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +5 -5
  335. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +7 -7
  336. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  337. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  338. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  339. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  340. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  341. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  342. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  343. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  344. package/api/@xmachines/play-view/README.md +4 -4
  345. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +13 -13
  346. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +12 -12
  347. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +13 -13
  348. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  349. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +1 -1
  350. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  351. package/api/@xmachines/play-view/index/functions/composeViews.md +1 -1
  352. package/api/@xmachines/play-view/index/functions/createActorProxy.md +1 -1
  353. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +1 -1
  354. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  355. package/api/@xmachines/play-view/index/functions/createViewSession.md +1 -1
  356. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  357. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +1 -1
  358. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  359. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  360. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  361. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  362. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  363. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +7 -7
  364. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +7 -7
  365. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +7 -7
  366. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +4 -4
  367. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +8 -8
  368. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  369. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  370. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +4 -4
  371. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +7 -7
  372. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +5 -5
  373. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +7 -7
  374. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +5 -5
  375. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +8 -8
  376. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +4 -4
  377. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +7 -7
  378. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +6 -6
  379. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +5 -5
  380. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  381. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +1 -1
  382. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  383. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  384. package/api/@xmachines/play-vue/README.md +2 -2
  385. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  386. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  387. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  388. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  389. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  390. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  391. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  392. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  393. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  394. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -4
  395. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  396. package/api/@xmachines/play-vue-router/README.md +1 -1
  397. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +11 -11
  398. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +11 -11
  399. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  400. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  401. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +9 -9
  402. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +6 -6
  403. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  404. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +5 -5
  405. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  406. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  407. package/api/@xmachines/play-xstate/README.md +63 -52
  408. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +11 -11
  409. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +12 -12
  410. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +11 -11
  411. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +12 -12
  412. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +12 -12
  413. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  414. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +13 -13
  415. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +15 -15
  416. package/api/@xmachines/play-xstate/index/README.md +1 -1
  417. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +201 -124
  418. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  419. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +14 -10
  420. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +6 -6
  421. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +4 -4
  422. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +9 -9
  423. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  424. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  425. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  426. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  427. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +13 -5
  428. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +26 -13
  429. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  430. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  431. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +8 -8
  432. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +7 -7
  433. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  434. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  435. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  436. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  437. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  438. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  439. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  440. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  441. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  442. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  443. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  444. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  445. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  446. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +1 -1
  447. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  448. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  449. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  450. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  451. package/contributing/architecture.md +13 -9
  452. package/contributing/configuration.md +24 -50
  453. package/contributing/deployment.md +128 -158
  454. package/contributing/development.md +6 -6
  455. package/contributing/migrating-to-play-atom.md +13 -1
  456. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +11 -11
  457. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  458. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  459. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  460. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  461. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  462. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  463. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  464. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  465. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  466. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  467. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  468. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  469. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  470. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  471. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  472. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  473. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  474. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  475. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  476. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +17 -17
  477. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +11 -11
  478. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  479. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  480. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  481. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  482. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  483. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  484. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  485. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  486. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  487. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  488. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  489. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  490. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  491. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  492. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  493. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  494. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  495. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  496. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  497. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +17 -17
  498. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +11 -11
  499. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  500. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  501. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  502. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  503. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  504. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  505. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  506. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  507. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  508. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  509. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  510. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  511. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  512. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  513. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  514. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  515. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  516. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  517. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  518. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  519. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +11 -11
  520. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  521. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  522. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +17 -17
  523. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +11 -11
  524. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  525. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  526. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  527. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  528. package/examples/README.md +1 -1
  529. package/examples/basic-state-machine.md +19 -23
  530. package/examples/form-validation.md +43 -48
  531. package/examples/routing-patterns.md +30 -35
  532. package/examples/traffic-light.md +19 -21
  533. package/guides/actor-model.md +5 -6
  534. package/guides/getting-started.md +45 -51
  535. package/guides/inspector.md +52 -46
  536. package/guides/routing.md +4 -2
  537. package/guides/state-machines.md +80 -64
  538. package/guides/views.md +6 -4
  539. package/package.json +1 -1
  540. package/rfc/git.md +13 -5
  541. package/rfc/play.md +22 -18
  542. package/rfc/run.md +7 -4
package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-solid/src/ActorProvider.tsx:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L116)
5
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L116)
6
6
 
7
7
  The props of ActorProvider, the low-level provider.
8
8
 
@@ -19,12 +19,12 @@ with JSONUIProvider and with every necessary sub-provider.
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description | Inherited from | Defined in |
23
- | ----------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-actor"></a> `actor` | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`actor`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L219) |
25
- | <a id="property-children"></a> `children` | `any` | The children. They are necessary, and they must hold a <PlayRenderer />. You can also use the PlayUIProvider short form | - | [packages/play-solid/src/ActorProvider.tsx:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L161) |
26
- | <a id="property-fallback"></a> `fallback?` | `any` | The optional fallback element. The provider shows it when currentView is null, and when the ErrorBoundary catches an error | - | [packages/play-solid/src/ActorProvider.tsx:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L120) |
27
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | The optional callback. The provider calls it when the SolidJS ErrorBoundary catches an error. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The second parameter is the RESET, for a retry that the host starts — a "Retry" button of its own. It clears the caught error and renders again, and it resolves the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts, and a reset after the provider is disposed does nothing. The five renderers hold the same three rules. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. The fallback of this boundary is the RETURN of the callback that reports, so a throw that left this handler would take the fallback off the screen AND let the error escape the boundary. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule. | - | [packages/play-solid/src/ActorProvider.tsx:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L156) |
28
- | <a id="property-onrendererror"></a> `onRenderError?` | [`OnRenderError`](../type-aliases/OnRenderError.md) | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L236) |
29
- | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L221) |
30
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`store`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L228) |
22
+ | Property | Type | Description | Inherited from | Defined in |
23
+ | ----------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | <a id="property-actor"></a> `actor` | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`actor`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L219) |
25
+ | <a id="property-children"></a> `children` | `any` | The children. They are necessary, and they must hold a <PlayRenderer />. You can also use the PlayUIProvider short form | - | [packages/play-solid/src/ActorProvider.tsx:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L161) |
26
+ | <a id="property-fallback"></a> `fallback?` | `any` | The optional fallback element. The provider shows it when currentView is null, and when the ErrorBoundary catches an error | - | [packages/play-solid/src/ActorProvider.tsx:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L120) |
27
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | The optional callback. The provider calls it when the SolidJS ErrorBoundary catches an error. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The second parameter is the RESET, for a retry that the host starts — a "Retry" button of its own. It clears the caught error and renders again, and it resolves the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts, and a reset after the provider is disposed does nothing. The five renderers hold the same three rules. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. The fallback of this boundary is the RETURN of the callback that reports, so a throw that left this handler would take the fallback off the screen AND let the error escape the boundary. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule. | - | [packages/play-solid/src/ActorProvider.tsx:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L156) |
28
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`OnRenderError`](../type-aliases/OnRenderError.md) | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L236) |
29
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L221) |
30
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`store`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L228) |
package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-solid/src/PlayUIProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/PlayUIProvider.tsx#L37)
5
+ Defined in: [packages/play-solid/src/PlayUIProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/PlayUIProvider.tsx#L37)
6
6
 
7
7
  The props of PlayUIProvider — every ActorProvider prop, and also the props that it forwards to JSONUIProvider.
8
8
 
@@ -12,15 +12,15 @@ The props of PlayUIProvider — every ActorProvider prop, and also the props tha
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Type | Description | Inherited from | Defined in |
16
- | ---------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability. | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L219) |
18
- | <a id="property-children"></a> `children` | `any` | The children. They are necessary, and they must hold a <PlayRenderer />. You can also use the PlayUIProvider short form | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-solid/src/ActorProvider.tsx:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L161) |
19
- | <a id="property-fallback"></a> `fallback?` | `any` | The optional fallback element. The provider shows it when currentView is null, and when the ErrorBoundary catches an error | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-solid/src/ActorProvider.tsx:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L120) |
20
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | The optional callback. The provider calls it when the SolidJS ErrorBoundary catches an error. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The second parameter is the RESET, for a retry that the host starts — a "Retry" button of its own. It clears the caught error and renders again, and it resolves the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts, and a reset after the provider is disposed does nothing. The five renderers hold the same three rules. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. The fallback of this boundary is the RETURN of the callback that reports, so a throw that left this handler would take the fallback off the screen AND let the error escape the boundary. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule. | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-solid/src/ActorProvider.tsx:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L156) |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`OnRenderError`](../type-aliases/OnRenderError.md) | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L236) |
24
- | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L221) |
25
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L228) |
26
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
15
+ | Property | Type | Description | Inherited from | Defined in |
16
+ | ---------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | <a id="property-actor"></a> `actor` | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability. | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L219) |
18
+ | <a id="property-children"></a> `children` | `any` | The children. They are necessary, and they must hold a <PlayRenderer />. You can also use the PlayUIProvider short form | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-solid/src/ActorProvider.tsx:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L161) |
19
+ | <a id="property-fallback"></a> `fallback?` | `any` | The optional fallback element. The provider shows it when currentView is null, and when the ErrorBoundary catches an error | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-solid/src/ActorProvider.tsx:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L120) |
20
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | The optional callback. The provider calls it when the SolidJS ErrorBoundary catches an error. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The second parameter is the RESET, for a retry that the host starts — a "Retry" button of its own. It clears the caught error and renders again, and it resolves the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts, and a reset after the provider is disposed does nothing. The five renderers hold the same three rules. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. The fallback of this boundary is the RETURN of the callback that reports, so a throw that left this handler would take the fallback off the screen AND let the error escape the boundary. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule. | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-solid/src/ActorProvider.tsx:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L156) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`OnRenderError`](../type-aliases/OnRenderError.md) | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L236) |
24
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L221) |
25
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L228) |
26
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
package/api/@xmachines/play-solid/interfaces/ViewContextValue.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-solid/src/ActorProvider.tsx:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L70)
5
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L70)
6
6
 
7
7
  The value that the ViewContext of ActorProvider provides.
8
8
  usePlayView() gives it inside the ActorProvider tree.
@@ -21,9 +21,9 @@ provider builds the subtree again when one of them changes.
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description | Inherited from | Defined in |
25
- | ----------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`handlers`](../../play-view/index/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-view/src/view-types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L162) |
27
- | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`registry`](../../play-view/index/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L164) |
28
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-view/index/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`spec`](../../play-view/index/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-view/src/view-types.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L160) |
29
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`store`](../../play-view/index/interfaces/BaseViewContextValue.md#property-store) | [packages/play-view/src/view-types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L168) |
24
+ | Property | Type | Description | Inherited from | Defined in |
25
+ | ----------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`handlers`](../../play-view/index/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-view/src/view-types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L162) |
27
+ | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`registry`](../../play-view/index/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L164) |
28
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-view/index/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`spec`](../../play-view/index/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-view/src/view-types.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L160) |
29
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-view/index/interfaces/BaseViewContextValue.md).[`store`](../../play-view/index/interfaces/BaseViewContextValue.md#property-store) | [packages/play-view/src/view-types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-view/src/view-types.ts#L168) |
package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type AnyPlayActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/useActor.ts#L37)
9
+ Defined in: [packages/play-solid/src/useActor.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/useActor.ts#L37)
10
10
 
11
11
  The actor type of the context of this renderer.
12
12
 
package/api/@xmachines/play-solid/variables/ActorContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const ActorContext: Context<AnyPlayActor | null>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/useActor.ts#L45)
9
+ Defined in: [packages/play-solid/src/useActor.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/useActor.ts#L45)
10
10
 
11
11
  The SolidJS context of the actor. This package exports it, so that a consumer
12
12
  can use ActorContext.Provider directly for a custom composition (see D-11). The
package/api/@xmachines/play-solid/variables/ActorProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: Component<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/ActorProvider.tsx:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/ActorProvider.tsx#L238)
9
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/ActorProvider.tsx#L238)
10
10
 
11
11
  The ActorProvider component. It owns the actor bridge, the atom subscription, the
12
12
  StateStore lifecycle, the resolution of the handlers, and the error boundary.
package/api/@xmachines/play-solid/variables/PlayRenderer.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: Component;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/PlayRenderer.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/PlayRenderer.tsx#L30)
9
+ Defined in: [packages/play-solid/src/PlayRenderer.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/PlayRenderer.tsx#L30)
10
10
 
11
11
  The leaf renderer without props. Put it inside an ActorProvider tree or a
12
12
  PlayUIProvider tree.
package/api/@xmachines/play-solid/variables/PlayUIProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayUIProvider: Component<PlayUIProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/PlayUIProvider.tsx:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid/src/PlayUIProvider.tsx#L84)
9
+ Defined in: [packages/play-solid/src/PlayUIProvider.tsx:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid/src/PlayUIProvider.tsx#L84)
10
10
 
11
11
  The composite provider: ActorProvider and JSONUIProvider.
12
12
 
package/api/@xmachines/play-solid-router/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  SolidJS Router adapter for the XMachines Universal Player Architecture. It keeps the state machine routes of a `PlayerActor` and the browser URL in step, in both directions, through `@solidjs/router`.
6
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-7.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-solid-router)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-8.0.0--next.1-blue)](https://www.npmjs.com/package/@xmachines/play-solid-router)
8
8
 
9
9
  ## Installation
10
10
 
@@ -180,10 +180,8 @@ const machineConfig = {
180
180
  states: {
181
181
  dashboard: {
182
182
  meta: { route: "/dashboard" },
183
- always: {
184
- guard: ({ context }) => !context.isAuthenticated,
185
- target: "login",
186
- },
183
+ // A transition function is the guard: it returns a target to redirect
184
+ always: ({ context }) => (context.isAuthenticated ? undefined : { target: "login" }),
187
185
  },
188
186
  },
189
187
  };
@@ -235,7 +233,7 @@ A path that fills NO optional segment reaches URLPattern never. `/settings` agai
235
233
  - [@xmachines/play-router](../play-router/README.md) — core router primitives and `RouterBridgeBase`
236
234
  - [@xmachines/play-tanstack-solid-router](../play-tanstack-solid-router/README.md) — TanStack Solid Router adapter
237
235
  - [@xmachines/play-solid](../play-solid/README.md) — SolidJS view renderer
238
- - [@xmachines/play-xstate](../play-xstate/README.md) — XState v5 player factory
236
+ - [@xmachines/play-xstate](../play-xstate/README.md) — XState v6 player factory
239
237
 
240
238
  ## Learn More
241
239
 
package/api/@xmachines/play-solid-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L176)
5
+ Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L176)
6
6
 
7
7
  The shared base class of the route map for both directions.
8
8
 
@@ -64,7 +64,7 @@ map.getPathByStateId("missing"); // null
64
64
  new RouteMap(mappings, options?): RouteMap;
65
65
  ```
66
66
 
67
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L209)
67
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L209)
68
68
 
69
69
  Builds a route map from an array of the mappings between a state ID and a path.
70
70
 
@@ -92,7 +92,7 @@ candidates is therefore efficient.
92
92
  getPathByStateId(stateId): string | null;
93
93
  ```
94
94
 
95
- Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L322)
95
+ Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L322)
96
96
 
97
97
  Returns the path pattern of a state ID.
98
98
 
@@ -128,7 +128,7 @@ map.getPathByStateId("missing"); // null
128
128
  getStateIdByPath(path): string | null;
129
129
  ```
130
130
 
131
- Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/base-route-map.ts#L277)
131
+ Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/base-route-map.ts#L277)
132
132
 
133
133
  Resolves a URL path to its state ID.
134
134
 
package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [play-solid-router/src/solid-router-bridge.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L73)
5
+ Defined in: [play-solid-router/src/solid-router-bridge.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid-router/src/solid-router-bridge.ts#L73)
6
6
 
7
7
  The SolidJS Router integration bridge. It extends RouterBridgeBase
8
8
 
@@ -43,7 +43,7 @@ new SolidRouterBridge(
43
43
  ): SolidRouterBridge;
44
44
  ```
45
45
 
46
- Defined in: [play-solid-router/src/solid-router-bridge.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L96)
46
+ Defined in: [play-solid-router/src/solid-router-bridge.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid-router/src/solid-router-bridge.ts#L96)
47
47
 
48
48
  Creates a SolidJS Router bridge
49
49
 
@@ -78,7 +78,7 @@ Creates a SolidJS Router bridge
78
78
  get basePath(): string;
79
79
  ```
80
80
 
81
- Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L282)
81
+ Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/router-bridge-base.ts#L282)
82
82
 
83
83
  The resolved URL prefix that the machine of this bridge is mounted under, or `""`
84
84
  when the machine owns the complete router.
@@ -103,7 +103,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
103
103
  get basePathParams(): Readonly<Record<string, string>>;
104
104
  ```
105
105
 
106
- Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L311)
106
+ Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/router-bridge-base.ts#L311)
107
107
 
108
108
  The resolved values of the `:param` segments of the mount, or `{}` for a prefix
109
109
  without a param.
@@ -154,7 +154,7 @@ mount while the machine stays on the same route, and no event goes out.
154
154
  connect(): void;
155
155
  ```
156
156
 
157
- Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L533)
157
+ Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/router-bridge-base.ts#L533)
158
158
 
159
159
  Connects the router bridge to the Actor.
160
160
 
@@ -188,7 +188,7 @@ An adapter that needs a different behavior of the first synchronization override
188
188
  disconnect(): void;
189
189
  ```
190
190
 
191
- Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L795)
191
+ Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/router-bridge-base.ts#L795)
192
192
 
193
193
  Disconnects the router bridge from the Actor.
194
194
 
@@ -211,7 +211,7 @@ framework.
211
211
  setBasePath(basePath?, basePathParams?): void;
212
212
  ```
213
213
 
214
- Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-router/src/router-bridge-base.ts#L351)
214
+ Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-router/src/router-bridge-base.ts#L351)
215
215
 
216
216
  Moves the machine to a different mount point, while it stays connected.
217
217
 
package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createPlayRouterProvider<TRouter, TActorBase>(BridgeCtor): <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [play-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L51)
9
+ Defined in: [play-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-solid-router/src/create-play-router-provider.tsx#L51)
10
10
 
11
11
  Builds a `PlayRouterProvider` for one Solid bridge class.
12
12
 
package/api/@xmachines/play-solid-router/interfaces/PlayActor.md CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: PlayActor\<TSnapshot, TEvent\>
4
4
 
5
- Defined in: [play-actor/src/play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-actor/src/play-actor.ts#L75)
5
+ Defined in: [play-actor/src/play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L75)
6
6
 
7
7
  The actor contract of the Play Architecture. It names NO engine.
8
8
 
9
9
  An actor of XMachines holds exactly two things, and this interface names both: the
10
10
  reactive snapshot, and the typed event dispatch. A state machine library is the concern
11
- of an adapter, and `@xmachines/play-xstate` is the adapter of XState v5.
11
+ of an adapter, and `@xmachines/play-xstate` is the adapter of XState v6.
12
12
 
13
13
  Both type parameters carry their real type through, and neither one erases it.
14
14
  `AbstractActor` declares `Atom<unknown>`, so every consumer of a snapshot reads
@@ -43,9 +43,9 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
43
43
 
44
44
  ## Properties
45
45
 
46
- | Property | Modifier | Type | Description | Defined in |
47
- | ----------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
48
- | <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor/src/play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-actor/src/play-actor.ts#L82) |
46
+ | Property | Modifier | Type | Description | Defined in |
47
+ | ----------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
48
+ | <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor/src/play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L82) |
49
49
 
50
50
  ## Methods
51
51
 
@@ -55,7 +55,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
55
55
  send(event): void;
56
56
  ```
57
57
 
58
- Defined in: [play-actor/src/play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-actor/src/play-actor.ts#L90)
58
+ Defined in: [play-actor/src/play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L90)
59
59
 
60
60
  Sends an event to the actor.
61
61