@xmachines/docs 6.0.0 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (538) hide show
  1. package/README.md +6 -5
  2. package/api/@xmachines/core/README.md +1 -1
  3. package/api/@xmachines/core/cache/functions/createLruCache.md +1 -1
  4. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
  5. package/api/@xmachines/core/errors/classes/BaseError.md +4 -4
  6. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +4 -4
  7. package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
  8. package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
  9. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  10. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  12. package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
  13. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  14. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  15. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  16. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  18. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  19. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  20. package/api/@xmachines/play/README.md +1 -1
  21. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  22. package/api/@xmachines/play/errors/classes/PlayError.md +5 -4
  23. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  24. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  25. package/api/@xmachines/play-actor/README.md +1 -1
  26. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  27. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  28. package/api/@xmachines/play-atom/README.md +2 -2
  29. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  30. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
  31. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  32. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
  33. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
  34. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  35. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  36. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  37. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  38. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  39. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  40. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  41. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  42. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  43. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  44. package/api/@xmachines/play-dom/README.md +9 -14
  45. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  46. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  47. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  48. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +11 -11
  49. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +2 -2
  50. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  51. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -14
  52. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  53. package/api/@xmachines/play-dom-router/README.md +1 -1
  54. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  55. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  56. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  57. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  58. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  59. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  60. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  61. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  62. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +8 -8
  63. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  64. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  65. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  66. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  67. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  68. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  69. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +6 -6
  70. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  71. package/api/@xmachines/play-pattern/README.md +1 -1
  72. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  73. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  74. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  75. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  76. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  77. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +4 -4
  78. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  79. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
  80. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
  81. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
  82. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
  83. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +4 -4
  84. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  85. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  86. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  87. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  88. package/api/@xmachines/play-react/README.md +2 -2
  89. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  90. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  91. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  92. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  93. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  94. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  95. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  96. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  97. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  98. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  99. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  100. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  101. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  102. package/api/@xmachines/play-react-router/README.md +1 -1
  103. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  104. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  105. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  106. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  107. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  108. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  109. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  110. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  111. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  112. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  113. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  114. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  115. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  116. package/api/@xmachines/play-router/README.md +7 -8
  117. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  118. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  119. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  120. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  121. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  122. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  123. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  124. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  125. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  126. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  127. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  128. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  136. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  143. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  144. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  146. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  148. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  152. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  153. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  154. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  155. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  156. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
  157. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
  158. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  159. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  160. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  161. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
  162. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
  163. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  164. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  165. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
  166. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  167. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  168. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  169. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  170. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  171. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
  172. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  173. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  174. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  175. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +12 -15
  176. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  177. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  178. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  179. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +5 -5
  180. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +6 -6
  181. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  182. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  183. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  184. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  185. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  186. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  187. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  188. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  189. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  190. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  191. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  192. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  193. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  194. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  195. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  196. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  197. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  198. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  199. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  200. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  201. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  202. package/api/@xmachines/play-solid/README.md +1 -4
  203. package/api/@xmachines/play-solid/functions/defineRegistry.md +5 -5
  204. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  205. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  206. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  207. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +9 -8
  208. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  209. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  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/variables/schema.md +35 -54
  216. package/api/@xmachines/play-solid-router/README.md +2 -2
  217. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  218. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +8 -8
  219. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  223. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  226. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  230. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-svelte/README.md +2 -2
  232. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  236. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  237. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +10 -8
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +10 -8
  239. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  240. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  241. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  243. package/api/@xmachines/play-svelte-spa-router/README.md +1 -1
  244. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  245. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  246. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  253. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +6 -6
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  256. package/api/@xmachines/play-sveltekit-router/README.md +1 -1
  257. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  258. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  259. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  260. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  261. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +8 -8
  262. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  263. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  264. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  265. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  266. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  267. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  268. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +6 -6
  269. package/api/@xmachines/play-tanstack-react-router/README.md +1 -1
  270. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  271. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  272. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  273. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  279. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  282. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  283. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  284. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  285. package/api/@xmachines/play-tanstack-router/README.md +1 -1
  286. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  287. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  288. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  289. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  290. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  291. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  292. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  298. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  302. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  304. package/api/@xmachines/play-url/README.md +1 -1
  305. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  306. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  307. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  308. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  309. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  310. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  311. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  312. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  313. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  314. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  315. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  316. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  317. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  318. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  319. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  320. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  321. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  322. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  323. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  324. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  325. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  326. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +3 -3
  327. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
  328. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  329. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  330. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  331. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  332. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +2 -2
  333. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  334. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  335. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  336. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  337. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  338. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  339. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  340. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  341. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  342. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  343. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  344. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  345. package/api/@xmachines/play-view/README.md +53 -22
  346. package/api/@xmachines/play-view/errors/README.md +1 -0
  347. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +204 -0
  348. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  349. package/api/@xmachines/play-view/index/README.md +6 -0
  350. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  351. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  352. package/api/@xmachines/play-view/index/functions/composeViews.md +35 -0
  353. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +1 -1
  354. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  355. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  356. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  357. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  358. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  359. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +1 -1
  360. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  361. package/api/@xmachines/play-view/index/functions/typedSpec.md +11 -11
  362. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  363. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  364. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +16 -0
  365. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +3 -3
  366. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +12 -8
  367. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  368. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +3 -3
  369. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  370. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +4 -4
  371. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +25 -0
  372. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +23 -0
  373. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +3 -3
  374. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +4 -4
  375. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +15 -0
  376. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +14 -0
  377. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  378. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  379. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  380. package/api/@xmachines/play-vue/README.md +3 -5
  381. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  382. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  383. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  384. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  385. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  386. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  387. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  388. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  389. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  390. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  391. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  392. package/api/@xmachines/play-vue-router/README.md +1 -1
  393. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  394. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  395. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  396. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  397. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  398. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  399. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +4 -4
  400. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  401. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  402. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  403. package/api/@xmachines/play-xstate/README.md +24 -17
  404. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  405. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  406. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  407. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  408. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  409. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
  410. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  411. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  412. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -10
  413. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  414. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  415. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  416. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  417. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  418. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  419. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  420. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  421. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  422. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  423. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  424. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  425. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  426. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  427. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +12 -15
  428. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  429. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  430. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  431. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  432. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  433. package/api/@xmachines/play-xstate/with-view/functions/withView.md +2 -4
  434. package/api/@xmachines/shared/vite-aliases/README.md +7 -0
  435. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +11 -5
  436. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +37 -0
  437. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +28 -0
  438. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  439. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  440. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  441. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  442. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +26 -0
  443. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +15 -0
  444. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  445. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +5 -1
  446. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  447. package/api/llms.txt +8 -4
  448. package/contributing/architecture.md +18 -8
  449. package/contributing/configuration.md +39 -6
  450. package/contributing/development.md +3 -1
  451. package/contributing/migrating-to-play-atom.md +1 -1
  452. package/contributing/testing.md +33 -4
  453. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +9 -9
  454. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  455. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  456. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  457. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  458. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  459. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  460. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  461. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  462. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  463. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  464. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  465. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  466. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  467. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  468. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  469. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  470. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  471. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  472. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  473. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +15 -15
  474. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +9 -9
  475. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  476. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  477. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  478. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  479. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  480. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  481. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  482. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  483. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  484. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  485. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  486. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  487. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  488. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  489. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  490. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  491. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  492. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  493. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  494. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +15 -15
  495. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +9 -9
  496. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  497. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  498. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  499. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  500. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  501. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  502. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  503. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  504. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  505. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  506. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  507. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  508. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  509. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  510. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  511. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  512. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  513. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  514. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +190 -277
  515. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  516. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +9 -9
  517. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  518. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +190 -277
  519. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +15 -15
  520. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +9 -9
  521. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  522. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  523. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  524. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  525. package/examples/README.md +1 -1
  526. package/examples/multi-router-integration.md +1 -1
  527. package/examples/routing-patterns.md +1 -1
  528. package/examples/traffic-light.md +1 -1
  529. package/guides/README.md +5 -4
  530. package/guides/actor-model.md +4 -4
  531. package/guides/atoms.md +4 -4
  532. package/guides/getting-started.md +2 -6
  533. package/guides/inspector.md +1 -1
  534. package/guides/routing.md +41 -45
  535. package/guides/state-machines.md +69 -4
  536. package/guides/views.md +347 -0
  537. package/package.json +1 -1
  538. package/rfc/play.md +24 -8
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-solid/src/ActorProvider.tsx:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L113)
5
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L113)
6
6
 
7
7
  The props of ActorProvider, the low-level provider.
8
8
 
@@ -21,10 +21,10 @@ with JSONUIProvider and with every necessary sub-provider.
21
21
 
22
22
  | Property | Type | Description | Inherited from | Defined in |
23
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:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L169) |
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:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L154) |
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:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L117) |
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. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through `onRenderError`. 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:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L149) |
28
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. 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:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L183) |
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:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L171) |
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:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L178) |
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:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L224) |
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:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L154) |
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:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L117) |
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. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through `onRenderError`. 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:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L149) |
28
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. 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:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L238) |
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:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L226) |
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:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L233) |
@@ -27,11 +27,12 @@ const Button: ComponentFn<typeof catalog, 'Button'> = (ctx) => {
27
27
 
28
28
  ## Properties
29
29
 
30
- | Property | Type | Description | Inherited from | Defined in |
31
- | ------------------------------------------ | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ---------- |
32
- | <a id="property-bindings"></a> `bindings?` | `Record`\<`string`, `string`\> | Two-way binding paths resolved from `$bindState` / `$bindItem` expressions. Maps prop name → absolute state path for write-back. | `BaseComponentProps.bindings` | - |
33
- | <a id="property-children"></a> `children?` | `any` | - | `BaseComponentProps.children` | - |
34
- | <a id="property-emit"></a> `emit` | (`event`) => `void` | Simple event emitter (shorthand). Fires the event and returns void. | `BaseComponentProps.emit` | - |
35
- | <a id="property-loading"></a> `loading?` | `boolean` | - | `BaseComponentProps.loading` | - |
36
- | <a id="property-on"></a> `on` | (`event`) => `EventHandle` | Get an event handle with metadata. Use when you need shouldPreventDefault or bound checks. | `BaseComponentProps.on` | - |
37
- | <a id="property-props"></a> `props` | `InferComponentProps` | - | `BaseComponentProps.props` | - |
30
+ | Property | Type | Description | Inherited from | Defined in |
31
+ | ------------------------------------------ | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ---------- |
32
+ | <a id="property-bindings"></a> `bindings?` | `Record`\<`string`, `string`\> | Two-way binding paths resolved from `$bindState` / `$bindItem` expressions. Maps prop name → absolute state path for write-back. | `BaseComponentProps.bindings` | - |
33
+ | <a id="property-children"></a> `children?` | `any` | - | `BaseComponentProps.children` | - |
34
+ | <a id="property-emit"></a> `emit` | (`event`) => `void` | Simple event emitter (shorthand). Fires the event and returns void. | `BaseComponentProps.emit` | - |
35
+ | <a id="property-loading"></a> `loading?` | `boolean` | - | `BaseComponentProps.loading` | - |
36
+ | <a id="property-on"></a> `on` | (`event`) => `EventHandle` | Get an event handle with metadata. Use when you need shouldPreventDefault or bound checks. | `BaseComponentProps.on` | - |
37
+ | <a id="property-props"></a> `props` | `InferComponentProps` | - | `BaseComponentProps.props` | - |
38
+ | <a id="property-slots"></a> `slots?` | `Record`\<`string`, `any`\> | Rendered content for each named slot of the element (`element.slots`). A slot renders only when the component reads its key, like `children`. | `BaseComponentProps.slots` | - |
@@ -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/v6.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/v6.1.0/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
 
@@ -14,13 +14,13 @@ The props of PlayUIProvider — every ActorProvider prop, and also the props tha
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
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:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L169) |
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:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L154) |
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:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L117) |
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:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L224) |
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:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L154) |
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:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L117) |
20
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
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. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through `onRenderError`. 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:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L149) |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-view/src/view-types.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L183) |
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:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L171) |
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:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L178) |
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. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through `onRenderError`. 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:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L149) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-view/src/view-types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L238) |
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:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L226) |
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:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L233) |
26
26
  | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-solid/src/ActorProvider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L67)
5
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L67)
6
6
 
7
7
  The value that the ViewContext of ActorProvider provides.
8
8
  usePlayView() gives it inside the ActorProvider tree.
@@ -23,7 +23,7 @@ provider builds the subtree again when one of them changes.
23
23
 
24
24
  | Property | Type | Description | Inherited from | Defined in |
25
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:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L112) |
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:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L114) |
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:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L110) |
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:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L118) |
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:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L167) |
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:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L169) |
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:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L165) |
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:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/view-types.ts#L173) |
@@ -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/v6.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/v6.1.0/packages/play-solid/src/useActor.ts#L37)
10
10
 
11
11
  The actor type of the context of this renderer.
12
12
 
@@ -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/v6.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/v6.1.0/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
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: Component<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/ActorProvider.tsx:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-solid/src/ActorProvider.tsx#L226)
9
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-solid/src/ActorProvider.tsx#L226)
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.
@@ -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/v6.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/v6.1.0/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.
@@ -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/v6.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/v6.1.0/packages/play-solid/src/PlayUIProvider.tsx#L84)
10
10
 
11
11
  The composite provider: ActorProvider and JSONUIProvider.
12
12
 
@@ -4,60 +4,41 @@
4
4
 
5
5
  ```ts
6
6
  const schema: _json_render_core.Schema<{
7
- catalog: _json_render_core.SchemaType<
8
- "object",
9
- {
10
- actions: _json_render_core.SchemaType<
11
- "map",
12
- {
13
- description: _json_render_core.SchemaType<"string", unknown>;
14
- params: _json_render_core.SchemaType<"zod", unknown>;
15
- }
16
- >;
17
- components: _json_render_core.SchemaType<
18
- "map",
19
- {
20
- description: _json_render_core.SchemaType<"string", unknown>;
21
- example: _json_render_core.SchemaType<"any", unknown>;
22
- props: _json_render_core.SchemaType<"zod", unknown>;
23
- slots: _json_render_core.SchemaType<
24
- "array",
25
- _json_render_core.SchemaType<"string", unknown>
26
- >;
27
- }
28
- >;
29
- }
30
- >;
31
- spec: _json_render_core.SchemaType<
32
- "object",
33
- {
34
- elements: _json_render_core.SchemaType<
35
- "record",
36
- _json_render_core.SchemaType<
37
- "object",
38
- {
39
- children: _json_render_core.SchemaType<
40
- "array",
41
- _json_render_core.SchemaType<"string", unknown>
42
- >;
43
- props: _json_render_core.SchemaType<"propsOf", string>;
44
- repeat: {
45
- inner?: unknown;
46
- kind: "any";
47
- optional: true;
48
- };
49
- type: _json_render_core.SchemaType<"ref", string>;
50
- visible: {
51
- inner?: unknown;
52
- kind: "any";
53
- optional: true;
54
- };
55
- }
56
- >
57
- >;
58
- root: _json_render_core.SchemaType<"string", unknown>;
59
- }
60
- >;
7
+ catalog: _json_render_core.SchemaType<"object", {
8
+ actions: _json_render_core.SchemaType<"map", {
9
+ description: _json_render_core.SchemaType<"string", unknown>;
10
+ params: _json_render_core.SchemaType<"zod", unknown>;
11
+ }>;
12
+ components: _json_render_core.SchemaType<"map", {
13
+ description: _json_render_core.SchemaType<"string", unknown>;
14
+ example: _json_render_core.SchemaType<"any", unknown>;
15
+ props: _json_render_core.SchemaType<"zod", unknown>;
16
+ slots: _json_render_core.SchemaType<"array", _json_render_core.SchemaType<"string", unknown>>;
17
+ }>;
18
+ }>;
19
+ spec: _json_render_core.SchemaType<"object", {
20
+ elements: _json_render_core.SchemaType<"record", _json_render_core.SchemaType<"object", {
21
+ children: _json_render_core.SchemaType<"array", _json_render_core.SchemaType<"string", unknown>>;
22
+ props: _json_render_core.SchemaType<"propsOf", string>;
23
+ repeat: {
24
+ inner?: unknown;
25
+ kind: "any";
26
+ optional: true;
27
+ };
28
+ slots: {
29
+ inner?: _json_render_core.SchemaType<"array", _json_render_core.SchemaType<..., ...>>;
30
+ kind: "record";
31
+ optional: true;
32
+ };
33
+ type: _json_render_core.SchemaType<"ref", string>;
34
+ visible: {
35
+ inner?: unknown;
36
+ kind: "any";
37
+ optional: true;
38
+ };
39
+ }>>;
40
+ root: _json_render_core.SchemaType<"string", unknown>;
41
+ }>;
61
42
  }>;
62
43
  ```
63
44
 
@@ -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-6.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-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-solid-router)
8
8
 
9
9
  ## Installation
10
10
 
@@ -199,7 +199,7 @@ const routeMap = new RouteMap([
199
199
  > that holds one parameterized route compiles it in the CONSTRUCTOR, and it throws an
200
200
  > `InvalidRoutePatternError` there for a pattern that URLPattern refuses. Such a route
201
201
  > therefore fails at startup, whatever this bridge does. You install no polyfill:
202
- > [`@xmachines/play-router`](../play-router/README.md) carries `urlpattern-polyfill` as an ordinary dependency and it
202
+ > [`@xmachines/play-url`](../play-url/README.md) carries `urlpattern-polyfill` as an ordinary dependency and it
203
203
  > uses the native API when the runtime has one.
204
204
 
205
205
  What follows is about the CALLS that a navigation makes, which cost time and which the
@@ -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/v6.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/v6.1.0/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/v6.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/v6.1.0/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/v6.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/v6.1.0/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/v6.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/v6.1.0/packages/play-router/src/base-route-map.ts#L277)
132
132
 
133
133
  Resolves a URL path to its state ID.
134
134
 
@@ -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/v6.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/v6.1.0/packages/play-solid-router/src/solid-router-bridge.ts#L73)
6
6
 
7
7
  The SolidJS Router integration bridge. It extends RouterBridgeBase
8
8
 
@@ -18,7 +18,7 @@ of the HOST and its params describe the route of the machine never, and a locati
18
18
  that fills a segment of the pattern while Solid reports none of its names.
19
19
 
20
20
  This is about the CALLS that a navigation makes, and not about the availability of the
21
- API. `@xmachines/play-router` carries `urlpattern-polyfill` as an ordinary dependency
21
+ API. `@xmachines/play-url` carries `urlpattern-polyfill` as an ordinary dependency
22
22
  and it uses the native URLPattern when the runtime has one, so the API is present
23
23
  whatever this bridge does. A BAD pattern is a question of the route map: `RouteMap`
24
24
  compiles each parameterized route in its constructor and throws an
@@ -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/v6.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/v6.1.0/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/v6.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/v6.1.0/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/v6.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/v6.1.0/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/v6.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/v6.1.0/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:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L791)
191
+ Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L791)
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/v6.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/v6.1.0/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
 
@@ -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/v6.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/v6.1.0/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
 
@@ -2,7 +2,7 @@
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/v6.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/v6.1.0/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
 
@@ -45,7 +45,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
45
45
 
46
46
  | Property | Modifier | Type | Description | Defined in |
47
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/v6.0.0/packages/play-actor/src/play-actor.ts#L82) |
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/v6.1.0/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/v6.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/v6.1.0/packages/play-actor/src/play-actor.ts#L90)
59
59
 
60
60
  Sends an event to the actor.
61
61