@xmachines/docs 1.0.0-beta.56 → 1.0.0-beta.57

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 (461) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/README.md +3 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  4. package/api/@xmachines/play/classes/PlayError.md +7 -7
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +5 -5
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +4 -4
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  22. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  23. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +1 -1
  24. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  25. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +1 -1
  26. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +1 -1
  27. package/api/@xmachines/play-dom/interfaces/EventHandle.md +1 -1
  28. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  29. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  30. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +1 -1
  31. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  35. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  45. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  46. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  47. package/api/@xmachines/play-dom-router/README.md +4 -4
  48. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  56. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  63. package/api/@xmachines/play-react/README.md +5 -5
  64. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  65. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  68. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  70. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  71. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  72. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  73. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  74. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  75. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  78. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  79. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  80. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  81. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  82. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  83. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  87. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  89. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  90. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  91. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  93. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  94. package/api/@xmachines/play-react-router/README.md +5 -5
  95. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  96. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  97. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  98. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  99. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  100. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  102. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  103. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  104. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  105. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  106. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  108. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-router/README.md +5 -5
  110. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  111. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  112. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  113. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  114. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  115. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  116. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  118. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  119. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  120. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  121. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  122. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  123. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  124. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  125. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  126. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  127. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  128. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  129. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  130. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  131. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  132. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  133. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  134. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  135. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  136. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  140. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  141. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  143. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  144. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  145. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  146. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  147. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  148. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  149. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  150. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  151. package/api/@xmachines/play-signals/README.md +5 -5
  152. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  153. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  154. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  155. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  156. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  157. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  158. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  159. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  160. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  170. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  171. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  172. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  173. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  174. package/api/@xmachines/play-solid/README.md +6 -6
  175. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  178. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  179. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  180. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  181. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  189. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  190. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  192. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  193. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  199. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  200. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  201. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  202. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  203. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  204. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  206. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  207. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  208. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  209. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  212. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  214. package/api/@xmachines/play-solid-router/README.md +5 -5
  215. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  217. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  218. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  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/RoutableActor.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 +5 -5
  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 +1 -1
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  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/ActionFn.md +1 -1
  243. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  244. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  246. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  247. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  248. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  249. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  250. package/api/@xmachines/play-svelte-spa-router/README.md +4 -4
  251. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  253. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  256. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  257. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  258. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  259. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  260. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  261. package/api/@xmachines/play-sveltekit-router/README.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  263. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  264. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  265. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  266. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  267. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  268. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  269. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  270. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  271. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/README.md +6 -6
  273. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  275. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  276. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  277. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  278. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  279. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  280. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  281. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  282. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  284. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  285. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  286. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  287. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  288. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  289. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  291. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  292. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  293. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  294. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  295. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  296. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  297. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  298. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  300. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  301. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  304. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  305. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  306. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  307. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  308. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  309. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  310. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  311. package/api/@xmachines/play-vue/README.md +5 -5
  312. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  313. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  314. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  315. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  317. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  318. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  319. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  320. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  321. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  322. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  323. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  324. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  325. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  326. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  327. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  328. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  329. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  330. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  331. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  332. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  333. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  334. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  335. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  336. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  337. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  338. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  339. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  340. package/api/@xmachines/play-vue-router/README.md +4 -4
  341. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  342. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  343. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  344. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  345. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  346. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  347. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  348. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  349. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  350. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  351. package/api/@xmachines/play-xstate/README.md +3 -3
  352. package/api/@xmachines/play-xstate/classes/PlayerActor.md +19 -19
  353. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  354. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  355. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  356. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  357. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  358. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  359. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  360. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  361. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  362. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  363. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  364. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  365. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  366. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  367. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  368. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  369. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  370. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  371. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  372. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  373. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  374. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  375. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  376. package/api/@xmachines/shared/README.md +2 -2
  377. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  378. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  379. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  380. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  381. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  382. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  383. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  384. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  385. package/contributing/configuration.md +12 -12
  386. package/contributing/deployment.md +9 -9
  387. package/contributing/development.md +43 -43
  388. package/contributing/testing.md +15 -15
  389. package/examples/@xmachines/play-dom-demo/README.md +12 -12
  390. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  397. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  398. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  399. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  400. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  401. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  402. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  403. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  404. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  405. package/examples/@xmachines/play-dom-router-demo/README.md +12 -12
  406. package/examples/@xmachines/play-react-demo/README.md +12 -12
  407. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  408. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  414. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  415. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  416. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  417. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  418. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  419. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  420. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  421. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  422. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  423. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  424. package/examples/@xmachines/play-react-router-demo/README.md +12 -12
  425. package/examples/@xmachines/play-solid-demo/README.md +12 -12
  426. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  431. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  432. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  433. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  434. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  435. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  436. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  437. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  438. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  439. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  440. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  441. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  442. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  443. package/examples/@xmachines/play-solid-router-demo/README.md +12 -12
  444. package/examples/@xmachines/play-svelte-demo/README.md +12 -12
  445. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  446. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  447. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  448. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  449. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +12 -12
  450. package/examples/@xmachines/play-sveltekit-router-demo/README.md +12 -12
  451. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +12 -12
  452. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +12 -12
  453. package/examples/@xmachines/play-vue-demo/README.md +12 -12
  454. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  455. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  456. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  457. package/examples/@xmachines/play-vue-router-demo/README.md +12 -12
  458. package/examples/README.md +3 -3
  459. package/guides/getting-started.md +31 -38
  460. package/guides/signals.md +2 -2
  461. package/package.json +2 -2
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L297)
5
+ Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
8
  adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L269)
52
+ Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -122,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
122
122
 
123
123
  | Property | Modifier | Type | Defined in |
124
124
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
125
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L230) |
126
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L228) |
127
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L229) |
128
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L227) |
129
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L51)
5
+ Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L55) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L53) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L341)
5
+ Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L357)
57
+ Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L357)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L373)
86
+ Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-vue-router/src/play-router-provider.ts#L10)
9
+ Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-vue-router/src/play-router-provider.ts#L10)
10
10
 
11
11
  ## Deprecated
12
12
 
@@ -64,7 +64,7 @@ const PlayRouterProvider: DefineComponent<
64
64
  >;
65
65
  ```
66
66
 
67
- Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-vue-router/src/play-router-provider.ts#L19)
67
+ Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-vue-router/src/play-router-provider.ts#L19)
68
68
 
69
69
  PlayRouterProvider — Vue convenience wrapper for VueRouterBridge.
70
70
 
@@ -16,7 +16,7 @@ Part of the [XMachines Play](../../README.md) monorepo.
16
16
  ## Installation
17
17
 
18
18
  ```bash
19
- npm install @xmachines/play-xstate xstate
19
+ pnpm add @xmachines/play-xstate xstate
20
20
  ```
21
21
 
22
22
  `xstate ^5.31.0` is a peer dependency and must be installed alongside this package.
@@ -283,10 +283,10 @@ All error classes extend `PlayError` from `@xmachines/play` and carry typed deta
283
283
 
284
284
  ```bash
285
285
  # Run tests for this package in isolation
286
- npm test -w packages/play-xstate
286
+ pnpm --filter @xmachines/play-xstate test
287
287
 
288
288
  # Watch mode
289
- npm run test:watch -w packages/play-xstate
289
+ pnpm --filter @xmachines/play-xstate run test:watch
290
290
  ```
291
291
 
292
292
  Tests use [Vitest](https://vitest.dev/) and live in `packages/play-xstate/test/`.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayerActor\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/player-actor.ts:361](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L361)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:361](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L361)
6
6
 
7
7
  Concrete XState actor implementing Play Architecture signal protocol
8
8
 
@@ -108,7 +108,7 @@ new PlayerActor<TMachine>(
108
108
  restoredSnapshot?): PlayerActor<TMachine>;
109
109
  ```
110
110
 
111
- Defined in: [packages/play-xstate/src/player-actor.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L453)
111
+ Defined in: [packages/play-xstate/src/player-actor.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L453)
112
112
 
113
113
  #### Parameters
114
114
 
@@ -133,16 +133,16 @@ Defined in: [packages/play-xstate/src/player-actor.ts:453](https://gitlab.com/xm
133
133
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
134
134
  | <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`_parent`](../../play-actor/classes/AbstractActor.md#property-_parent) | - |
135
135
  | <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`clock`](../../play-actor/classes/AbstractActor.md#property-clock) | - |
136
- | <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | A TC39 `Signal.Computed` that derives the current URL path from the active machine state's `meta.route` template and the actor's context. Returns `null` when the current state has no `meta.route`, or when the route template cannot be fully resolved (e.g. a required parameter is absent from context). **Throws** When a required `:param` placeholder in the route template has no matching value in the actor's context. Import the class from `@xmachines/play-xstate/errors`. **Example** `// Returns "/profile/alice" when context.userId === "alice" const route = actor.currentRoute.get();` | - | - | [packages/play-xstate/src/player-actor.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L407) |
137
- | <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | Reactive signal containing the current view spec derived from the active state's `meta.view` metadata. Emits a **fresh object reference** whenever the rendered view actually changes — a different state's view, or a param/context change that alters the resolved spec (including `reenter: true` re-entries with new params). Snapshots that do not change the rendered view (e.g. context-only assigns) keep the previous reference so downstream providers do not remount the UI on every event. The emitted `PlaySpec` has its element `props` enriched with `context.params` before emission — URL path parameters (e.g. `:section?`) flow into component props automatically. See `mergeRouteParamsIntoProps` for the merge priority rules. Returns `null` when the current state has no `meta.view` metadata. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.root); // e.g. "root" console.log(view.elements); // @xmachines/json-render-core Spec elements }` | - | - | [packages/play-xstate/src/player-actor.ts:451](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L451) |
136
+ | <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | A TC39 `Signal.Computed` that derives the current URL path from the active machine state's `meta.route` template and the actor's context. Returns `null` when the current state has no `meta.route`, or when the route template cannot be fully resolved (e.g. a required parameter is absent from context). **Throws** When a required `:param` placeholder in the route template has no matching value in the actor's context. Import the class from `@xmachines/play-xstate/errors`. **Example** `// Returns "/profile/alice" when context.userId === "alice" const route = actor.currentRoute.get();` | - | - | [packages/play-xstate/src/player-actor.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L407) |
137
+ | <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | Reactive signal containing the current view spec derived from the active state's `meta.view` metadata. Emits a **fresh object reference** whenever the rendered view actually changes — a different state's view, or a param/context change that alters the resolved spec (including `reenter: true` re-entries with new params). Snapshots that do not change the rendered view (e.g. context-only assigns) keep the previous reference so downstream providers do not remount the UI on every event. The emitted `PlaySpec` has its element `props` enriched with `context.params` before emission — URL path parameters (e.g. `:section?`) flow into component props automatically. See `mergeRouteParamsIntoProps` for the merge priority rules. Returns `null` when the current state has no `meta.view` metadata. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.root); // e.g. "root" console.log(view.elements); // @xmachines/json-render-core Spec elements }` | - | - | [packages/play-xstate/src/player-actor.ts:451](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L451) |
138
138
  | <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`id`](../../play-actor/classes/AbstractActor.md#property-id) | - |
139
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction, never changes even when the actor is restored from a snapshot. Router bridges compare this against the browser URL to distinguish a deep-link (non-initial URL → router wins) from a restore (initial URL + actor at a different restored route → actor wins). Derived statically from the machine definition via `deriveInitialRoute` (XState's pure `initialTransition` helper): the initial state chain and its `meta.route` templates are fixed at machine definition time, while `:param` substitution uses the machine's real initial context for this actor's `input`. No extra actor is ever created, and a restored snapshot never influences the value — it is always the machine's **default** initial route. | - | - | [packages/play-xstate/src/player-actor.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L424) |
139
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction, never changes even when the actor is restored from a snapshot. Router bridges compare this against the browser URL to distinguish a deep-link (non-initial URL → router wins) from a restore (initial URL + actor at a different restored route → actor wins). Derived statically from the machine definition via `deriveInitialRoute` (XState's pure `initialTransition` helper): the initial state chain and its `meta.route` templates are fixed at machine definition time, while `:param` substitution uses the machine's real initial context for this actor's `input`. No extra actor is ever created, and a restored snapshot never influences the value — it is always the machine's **default** initial route. | - | - | [packages/play-xstate/src/player-actor.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L424) |
140
140
  | <a id="property-logic"></a> `logic` | `public` | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`logic`](../../play-actor/classes/AbstractActor.md#property-logic) | - |
141
141
  | <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`options`](../../play-actor/classes/AbstractActor.md#property-options) | - |
142
142
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<`any`, `any`, `any`\> | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`ref`](../../play-actor/classes/AbstractActor.md#property-ref) | - |
143
143
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`sessionId`](../../play-actor/classes/AbstractActor.md#property-sessionid) | - |
144
144
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`src`](../../play-actor/classes/AbstractActor.md#property-src) | - |
145
- | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:372](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L372) |
145
+ | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:372](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L372) |
146
146
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`system`](../../play-actor/classes/AbstractActor.md#property-system) | - |
147
147
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
148
148
 
@@ -154,7 +154,7 @@ Defined in: [packages/play-xstate/src/player-actor.ts:453](https://gitlab.com/xm
154
154
  observable: InteropSubscribable<any>;
155
155
  ```
156
156
 
157
- Defined in: `.pnpm`
157
+ Defined in: `xstate`
158
158
 
159
159
  #### Returns
160
160
 
@@ -172,7 +172,7 @@ Defined in: `.pnpm`
172
172
  can(event): boolean;
173
173
  ```
174
174
 
175
- Defined in: [packages/play-xstate/src/player-actor.ts:385](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L385)
175
+ Defined in: [packages/play-xstate/src/player-actor.ts:385](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L385)
176
176
 
177
177
  Returns whether the actor's current state can accept the given event.
178
178
 
@@ -203,7 +203,7 @@ if (actor.can({ type: "auth.logout" })) { ... }
203
203
  dispose(): void;
204
204
  ```
205
205
 
206
- Defined in: [packages/play-xstate/src/player-actor.ts:726](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L726)
206
+ Defined in: [packages/play-xstate/src/player-actor.ts:726](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L726)
207
207
 
208
208
  Convenience dispose method for cleanup
209
209
 
@@ -221,7 +221,7 @@ Per CONTEXT.md: "Both .dispose() convenience method and manual machine.stop()"
221
221
  getPersistedSnapshot(): Snapshot<unknown>;
222
222
  ```
223
223
 
224
- Defined in: [packages/play-xstate/src/player-actor.ts:684](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L684)
224
+ Defined in: [packages/play-xstate/src/player-actor.ts:684](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L684)
225
225
 
226
226
  Get the persisted snapshot of the wrapped XState actor.
227
227
 
@@ -244,7 +244,7 @@ Suitable for serialization and later restoration via the factory's
244
244
  getSnapshot(): SnapshotFrom<TMachine>;
245
245
  ```
246
246
 
247
- Defined in: [packages/play-xstate/src/player-actor.ts:608](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L608)
247
+ Defined in: [packages/play-xstate/src/player-actor.ts:608](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L608)
248
248
 
249
249
  Get current snapshot
250
250
 
@@ -264,7 +264,7 @@ Get current snapshot
264
264
  on<TType>(type, handler): Subscription;
265
265
  ```
266
266
 
267
- Defined in: [packages/play-xstate/src/player-actor.ts:669](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L669)
267
+ Defined in: [packages/play-xstate/src/player-actor.ts:669](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L669)
268
268
 
269
269
  Listen for events emitted by the wrapped XState actor via the `emit` action.
270
270
 
@@ -299,7 +299,7 @@ Subscription with an `unsubscribe()` method.
299
299
  select<TSelected>(selector, equalityFn?): Readable<TSelected>;
300
300
  ```
301
301
 
302
- Defined in: `.pnpm`
302
+ Defined in: `xstate`
303
303
 
304
304
  #### Type Parameters
305
305
 
@@ -330,7 +330,7 @@ Defined in: `.pnpm`
330
330
  send(event): void;
331
331
  ```
332
332
 
333
- Defined in: [packages/play-xstate/src/player-actor.ts:585](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L585)
333
+ Defined in: [packages/play-xstate/src/player-actor.ts:585](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L585)
334
334
 
335
335
  Send an event to the underlying XState actor.
336
336
 
@@ -374,7 +374,7 @@ actor.send({ type: "play.route", to: "#home" });
374
374
  start(): this;
375
375
  ```
376
376
 
377
- Defined in: [packages/play-xstate/src/player-actor.ts:540](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L540)
377
+ Defined in: [packages/play-xstate/src/player-actor.ts:540](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L540)
378
378
 
379
379
  Start the actor
380
380
 
@@ -396,7 +396,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
396
396
  stop(): this;
397
397
  ```
398
398
 
399
- Defined in: [packages/play-xstate/src/player-actor.ts:554](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L554)
399
+ Defined in: [packages/play-xstate/src/player-actor.ts:554](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L554)
400
400
 
401
401
  Stop the actor and cleanup
402
402
 
@@ -418,7 +418,7 @@ Stop the actor and cleanup
418
418
  subscribe(observer): Subscription;
419
419
  ```
420
420
 
421
- Defined in: [packages/play-xstate/src/player-actor.ts:630](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L630)
421
+ Defined in: [packages/play-xstate/src/player-actor.ts:630](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L630)
422
422
 
423
423
  Subscribe to snapshot updates from the wrapped XState actor.
424
424
 
@@ -449,7 +449,7 @@ subscribe(
449
449
  completeListener?): Subscription;
450
450
  ```
451
451
 
452
- Defined in: [packages/play-xstate/src/player-actor.ts:641](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/player-actor.ts#L641)
452
+ Defined in: [packages/play-xstate/src/player-actor.ts:641](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/player-actor.ts#L641)
453
453
 
454
454
  Subscribe to snapshot updates from the wrapped XState actor.
455
455
 
@@ -481,7 +481,7 @@ Subscription with an `unsubscribe()` method.
481
481
  toJSON(): object;
482
482
  ```
483
483
 
484
- Defined in: `.pnpm`
484
+ Defined in: `xstate`
485
485
 
486
486
  #### Returns
487
487
 
@@ -6,7 +6,7 @@
6
6
  function buildRouteUrl(routeTemplate, context?): string;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/build-url.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/routing/build-url.ts#L40)
9
+ Defined in: [packages/play-xstate/src/routing/build-url.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/routing/build-url.ts#L40)
10
10
 
11
11
  Build a full URL from a route template and the actor's context.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function composeGuards<TContext, TEvent>(guards): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/guards/compose.ts#L78)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/guards/compose.ts#L78)
10
10
 
11
11
  Compose guards with AND logic using XState's and() helper
12
12
 
@@ -6,7 +6,7 @@
6
6
  function composeGuardsOr<TContext, TEvent>(guards): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/guards/compose.ts#L144)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/guards/compose.ts#L144)
10
10
 
11
11
  Compose guards with OR logic using XState's or() helper
12
12
 
@@ -6,7 +6,7 @@
6
6
  function contextFieldMatches<TContext>(fieldPath, expectedValue): Guard<TContext, PlayEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/guards/helpers.ts#L71)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/guards/helpers.ts#L71)
10
10
 
11
11
  Check if a context field matches an expected value.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/define-player.ts#L61)
9
+ Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/define-player.ts#L61)
10
10
 
11
11
  Create a player factory from an XState machine
12
12
 
@@ -6,7 +6,7 @@
6
6
  function deriveRoute(stateMeta): string | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/derive-route.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/routing/derive-route.ts#L91)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/routing/derive-route.ts#L91)
10
10
 
11
11
  Derive route from XState state metadata
12
12
 
@@ -6,7 +6,7 @@
6
6
  function eventMatches<TEvent>(eventType): Guard<unknown, TEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/guards/helpers.ts#L50)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/guards/helpers.ts#L50)
10
10
 
11
11
  Check if event type matches expected type
12
12
 
@@ -6,7 +6,7 @@
6
6
  function formatPlayRouteTransitions<T>(machineConfig): T;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/routing/format-play-route-transitions.ts#L84)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/routing/format-play-route-transitions.ts#L84)
10
10
 
11
11
  Formats play.route transitions from declarative route configs
12
12
 
@@ -6,7 +6,7 @@
6
6
  function hasContext<TContext>(path): Guard<TContext, PlayEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/guards/helpers.ts#L24)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/guards/helpers.ts#L24)
10
10
 
11
11
  Check if context has a truthy value at path
12
12
 
@@ -6,7 +6,7 @@
6
6
  function isAbsoluteRoute(path): boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/derive-route.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/routing/derive-route.ts#L158)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/routing/derive-route.ts#L158)
10
10
 
11
11
  Check if route path is absolute
12
12
 
@@ -6,7 +6,7 @@
6
6
  function negateGuard<TContext, TEvent>(guard): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/guards/compose.ts#L204)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:204](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/guards/compose.ts#L204)
10
10
 
11
11
  Negate a guard using XState's not() helper
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerConfig\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L7)
5
+ Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L7)
6
6
 
7
7
  Configuration for definePlayer()
8
8
 
@@ -16,5 +16,5 @@ Configuration for definePlayer()
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ---------------------------------------- | ------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L9) |
20
- | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L12) |
19
+ | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L9) |
20
+ | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L12) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerFactoryResumeOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L47)
5
+ Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L47)
6
6
 
7
7
  Optional restore arguments for the player factory.
8
8
 
@@ -19,4 +19,4 @@ Mirrors XState's createActor options bag while preserving the existing
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
21
  | ------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L49) |
22
+ | <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L49) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L20)
5
+ Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L20)
6
6
 
7
7
  Player lifecycle hooks
8
8
 
@@ -18,8 +18,8 @@ Per CONTEXT.md: Rich set of hooks for observability
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | ---------------------------------------------------- | --------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L38) |
22
- | <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L22) |
23
- | <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L35) |
24
- | <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L25) |
25
- | <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-xstate/src/types.ts#L28) |
21
+ | <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L38) |
22
+ | <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L22) |
23
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L35) |
24
+ | <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L25) |
25
+ | <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-xstate/src/types.ts#L28) |