@xmachines/docs 1.0.0-beta.53 → 1.0.0-beta.55

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 (442) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  3. package/api/@xmachines/play/classes/PlayError.md +7 -7
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +2 -0
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  8. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
  9. package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
  10. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  11. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  12. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  14. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  15. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  16. package/api/@xmachines/play-dom/README.md +2 -0
  17. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  18. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  19. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  20. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  21. package/api/@xmachines/play-dom/functions/renderSpec.md +12 -30
  22. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -6
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -15
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -8
  29. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +25 -0
  30. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -5
  31. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  34. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +44 -0
  38. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  45. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  48. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  51. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  52. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  53. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +16 -6
  54. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +7 -3
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +16 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +6 -6
  60. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  61. package/api/@xmachines/play-react/README.md +6 -6
  62. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  63. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  65. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  66. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  70. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  71. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  72. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  73. package/api/@xmachines/play-react/functions/useSignalEffect.md +28 -26
  74. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  75. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  76. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  80. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  81. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  85. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  87. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  89. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  90. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  91. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  92. package/api/@xmachines/play-react-router/README.md +10 -1
  93. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -365
  94. package/api/@xmachines/play-react-router/classes/RouteMap.md +17 -5
  95. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
  96. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  97. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
  98. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  99. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +16 -6
  100. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  102. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  103. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  104. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +6 -6
  105. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  106. package/api/@xmachines/play-react-router/{functions → variables}/PlayRouterProvider.md +6 -6
  107. package/api/@xmachines/play-router/README.md +12 -10
  108. package/api/@xmachines/play-router/classes/RouteMap.md +17 -5
  109. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +9 -345
  110. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  111. package/api/@xmachines/play-router/functions/buildRouteTree.md +11 -1
  112. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  113. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
  114. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +13 -6
  115. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  116. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractRouteParams.md +9 -1
  118. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  119. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  120. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  121. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  122. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +7 -2
  123. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  124. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  125. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  126. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  127. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  128. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  129. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  130. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  131. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  132. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  133. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  134. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +16 -6
  135. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +17 -0
  136. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  137. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  138. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  139. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  140. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  141. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  142. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  143. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  144. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  145. package/api/@xmachines/play-router/interfaces/RouterBridge.md +6 -6
  146. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  147. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  148. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  149. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  150. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -2
  151. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  152. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -2
  153. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  154. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  155. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  156. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  157. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  170. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  171. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  172. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  173. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  174. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  179. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  185. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  189. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  190. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  191. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  192. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  199. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  200. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  201. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  204. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  206. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  207. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  208. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  209. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  210. package/api/@xmachines/play-solid-router/README.md +7 -1
  211. package/api/@xmachines/play-solid-router/classes/RouteMap.md +17 -5
  212. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -360
  213. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
  214. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  215. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  216. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  217. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +16 -6
  218. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
  219. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +17 -7
  220. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  221. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  222. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +6 -6
  223. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
  224. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  225. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  226. package/api/@xmachines/play-solid-router/{functions → variables}/PlayRouterProvider.md +6 -6
  227. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  228. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  229. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  230. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  231. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  232. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  233. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  234. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  235. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  236. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  237. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  239. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  240. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  241. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  242. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  243. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  244. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +17 -5
  245. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  246. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +16 -6
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +6 -6
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  253. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  254. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +17 -5
  255. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  256. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  257. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  258. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  259. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +16 -6
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  261. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  262. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +6 -6
  263. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  264. package/api/@xmachines/play-tanstack-react-router/README.md +7 -1
  265. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +17 -5
  266. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -384
  267. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
  268. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  269. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
  270. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +16 -6
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +6 -6
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +12 -4
  282. package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md +8 -6
  283. package/api/@xmachines/play-tanstack-router/README.md +58 -0
  284. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +131 -0
  285. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
  286. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
  287. package/api/@xmachines/play-tanstack-solid-router/README.md +7 -1
  288. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +17 -5
  289. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +25 -378
  290. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
  291. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +16 -6
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +15 -7
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  298. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +6 -6
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.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 +30 -7
  303. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
  304. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  305. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  306. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  307. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  308. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  309. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  310. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  311. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  312. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  313. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  314. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  315. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  317. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  318. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  319. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  320. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  321. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  322. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  323. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  324. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  325. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  326. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  327. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  328. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  329. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  330. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  331. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  332. package/api/@xmachines/play-vue-router/classes/RouteMap.md +17 -5
  333. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +6 -395
  334. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  335. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  336. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +16 -6
  337. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  338. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  339. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +6 -6
  340. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  341. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +3 -3
  342. package/api/@xmachines/play-xstate/classes/PlayerActor.md +70 -169
  343. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  344. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  345. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  346. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  347. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  348. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  349. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  350. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  351. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  352. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  353. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  354. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  355. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  356. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  357. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  358. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  359. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  360. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  361. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  362. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  363. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  364. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  365. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  366. package/api/@xmachines/shared/vite-aliases/README.md +1 -0
  367. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +7 -3
  368. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  369. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  370. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +6 -5
  371. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
  372. package/api/@xmachines/shared/vitest/README.md +5 -0
  373. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
  374. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  375. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
  376. package/api/README.md +1 -0
  377. package/api/llms.txt +4 -3
  378. package/contributing/architecture.md +6 -6
  379. package/contributing/configuration.md +1 -16
  380. package/contributing/deployment.md +8 -8
  381. package/contributing/testing.md +4 -4
  382. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  383. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  384. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  385. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  386. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  387. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  388. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  389. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  390. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  397. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  398. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  399. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  400. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  401. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  402. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  403. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  404. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  405. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  406. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  407. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  408. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  414. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  415. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  416. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  417. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  418. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  419. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  420. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  421. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  422. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  423. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  424. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  425. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  426. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  431. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  432. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  433. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  434. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  435. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  436. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  437. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  438. package/guides/README.md +6 -44
  439. package/package.json +6 -3
  440. package/api/@xmachines/play-router/functions/createRouteMatcher.md +0 -53
  441. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +0 -56
  442. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -33
package/api/@xmachines/play-xstate/classes/PlayerActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayerActor\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/player-actor.ts:342](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L342)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:361](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L361)
6
6
 
7
7
  Concrete XState actor implementing Play Architecture signal protocol
8
8
 
@@ -105,21 +105,19 @@ new PlayerActor<TMachine>(
105
105
  machine,
106
106
  options,
107
107
  input?,
108
- restoredSnapshot?,
109
- _cachedInitialRoute?): PlayerActor<TMachine>;
108
+ restoredSnapshot?): PlayerActor<TMachine>;
110
109
  ```
111
110
 
112
- Defined in: [packages/play-xstate/src/player-actor.ts:434](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L434)
111
+ Defined in: [packages/play-xstate/src/player-actor.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L453)
113
112
 
114
113
  #### Parameters
115
114
 
116
- | Parameter | Type | Description |
117
- | ---------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
118
- | `machine` | `TMachine` | - |
119
- | `options` | [`PlayerOptions`](../interfaces/PlayerOptions.md)\<`TMachine`\> | - |
120
- | `input?` | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\> | - |
121
- | `restoredSnapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | - |
122
- | `_cachedInitialRoute?` | `string` \| `null` | **`Internal`** Pre-computed initial route from `definePlayer`. `initialRoute` is determined by the machine's initial state node and its `meta.route` template — both fixed at machine definition time regardless of `input` or `snapshot`. When provided, used directly on every construction, eliminating a redundant `createActor()` call per actor instance. — set by `definePlayer`; callers should not pass this directly. |
115
+ | Parameter | Type |
116
+ | ------------------- | --------------------------------------------------------------------------------- |
117
+ | `machine` | `TMachine` |
118
+ | `options` | [`PlayerOptions`](../interfaces/PlayerOptions.md)\<`TMachine`\> |
119
+ | `input?` | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\> |
120
+ | `restoredSnapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> |
123
121
 
124
122
  #### Returns
125
123
 
@@ -131,22 +129,22 @@ Defined in: [packages/play-xstate/src/player-actor.ts:434](https://gitlab.com/xm
131
129
 
132
130
  ## Properties
133
131
 
134
- | Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
135
- | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136
- | <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) | - |
137
- | <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) | - |
138
- | <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:387](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L387) |
139
- | <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. Always emits a **fresh object reference** on every state transition (including self-transitions with `reenter: true`) so TC39 Signal equality checks reliably detect changes. 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); // @json-render/core Spec elements }` | - | - | [packages/play-xstate/src/player-actor.ts:432](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L432) |
140
- | <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) | - |
141
- | <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). Determined by the machine's initial state node and its `meta.route` template — both are fixed at machine definition time. `definePlayer` pre-computes this value once from the machine definition and passes it to every actor it constructs, so no extra `createActor()` call is needed per construction. When `PlayerActor` is constructed directly (without `definePlayer`), the value is derived from `xstateActor.getSnapshot()` (normal path) or a transient `createActor(machine, { input })` call (restore path, to avoid using the snapshot's state instead of the machine's default). | - | - | [packages/play-xstate/src/player-actor.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L407) |
142
- | <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) | - |
143
- | <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) | - |
144
- | <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) | - |
145
- | <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) | - |
146
- | <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) | - |
147
- | <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:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L352) |
148
- | <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) | - |
149
- | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
132
+ | Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
133
+ | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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
+ | <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.55/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); // @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.55/packages/play-xstate/src/player-actor.ts#L451) |
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.55/packages/play-xstate/src/player-actor.ts#L424) |
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
+ | <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
+ | <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
+ | <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
+ | <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.55/packages/play-xstate/src/player-actor.ts#L372) |
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
+ | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
150
148
 
151
149
  ## Methods
152
150
 
@@ -156,7 +154,7 @@ Defined in: [packages/play-xstate/src/player-actor.ts:434](https://gitlab.com/xm
156
154
  observable: InteropSubscribable<any>;
157
155
  ```
158
156
 
159
- Defined in: `xstate`
157
+ Defined in: `.pnpm`
160
158
 
161
159
  #### Returns
162
160
 
@@ -174,7 +172,7 @@ Defined in: `xstate`
174
172
  can(event): boolean;
175
173
  ```
176
174
 
177
- Defined in: [packages/play-xstate/src/player-actor.ts:365](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L365)
175
+ Defined in: [packages/play-xstate/src/player-actor.ts:385](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L385)
178
176
 
179
177
  Returns whether the actor's current state can accept the given event.
180
178
 
@@ -205,7 +203,7 @@ if (actor.can({ type: "auth.logout" })) { ... }
205
203
  dispose(): void;
206
204
  ```
207
205
 
208
- Defined in: [packages/play-xstate/src/player-actor.ts:647](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L647)
206
+ Defined in: [packages/play-xstate/src/player-actor.ts:726](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L726)
209
207
 
210
208
  Convenience dispose method for cleanup
211
209
 
@@ -223,29 +221,18 @@ Per CONTEXT.md: "Both .dispose() convenience method and manual machine.stop()"
223
221
  getPersistedSnapshot(): Snapshot<unknown>;
224
222
  ```
225
223
 
226
- Defined in: `xstate`
224
+ Defined in: [packages/play-xstate/src/player-actor.ts:684](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L684)
227
225
 
228
- Obtain the internal state of the actor, which can be persisted.
226
+ Get the persisted snapshot of the wrapped XState actor.
227
+
228
+ Suitable for serialization and later restoration via the factory's
229
+ `restore.snapshot` option.
229
230
 
230
231
  #### Returns
231
232
 
232
233
  [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\>
233
234
 
234
- #### Remarks
235
-
236
- The internal state can be persisted from any actor, not only machines.
237
-
238
- Note that the persisted state is not the same as the snapshot from
239
- [Actor.getSnapshot](../../play-actor/classes/AbstractActor.md#getsnapshot). Persisted state represents the internal state of
240
- the actor, while snapshots represent the actor's last emitted value.
241
-
242
- Can be restored with [ActorOptions.state](https://www.jsdocs.io/package/xstate#ActorOptions.state)
243
-
244
- #### See
245
-
246
- https://stately.ai/docs/persistence
247
-
248
- #### Inherited from
235
+ #### Overrides
249
236
 
250
237
  [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`getPersistedSnapshot`](../../play-actor/classes/AbstractActor.md#getpersistedsnapshot)
251
238
 
@@ -257,7 +244,7 @@ https://stately.ai/docs/persistence
257
244
  getSnapshot(): SnapshotFrom<TMachine>;
258
245
  ```
259
246
 
260
- Defined in: [packages/play-xstate/src/player-actor.ts:616](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L616)
247
+ Defined in: [packages/play-xstate/src/player-actor.ts:608](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L608)
261
248
 
262
249
  Get current snapshot
263
250
 
@@ -277,7 +264,9 @@ Get current snapshot
277
264
  on<TType>(type, handler): Subscription;
278
265
  ```
279
266
 
280
- Defined in: `xstate`
267
+ Defined in: [packages/play-xstate/src/player-actor.ts:669](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L669)
268
+
269
+ Listen for events emitted by the wrapped XState actor via the `emit` action.
281
270
 
282
271
  #### Type Parameters
283
272
 
@@ -287,16 +276,18 @@ Defined in: `xstate`
287
276
 
288
277
  #### Parameters
289
278
 
290
- | Parameter | Type |
291
- | --------- | --------------------- |
292
- | `type` | `TType` |
293
- | `handler` | (`emitted`) => `void` |
279
+ | Parameter | Type | Description |
280
+ | --------- | --------------------- | --------------------------------------------------- |
281
+ | `type` | `TType` | Emitted event type to listen for, or `"*"` for all. |
282
+ | `handler` | (`emitted`) => `void` | Called with each matching emitted event. |
294
283
 
295
284
  #### Returns
296
285
 
297
286
  [`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
298
287
 
299
- #### Inherited from
288
+ Subscription with an `unsubscribe()` method.
289
+
290
+ #### Overrides
300
291
 
301
292
  [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`on`](../../play-actor/classes/AbstractActor.md#on)
302
293
 
@@ -308,7 +299,7 @@ Defined in: `xstate`
308
299
  select<TSelected>(selector, equalityFn?): Readable<TSelected>;
309
300
  ```
310
301
 
311
- Defined in: `xstate`
302
+ Defined in: `.pnpm`
312
303
 
313
304
  #### Type Parameters
314
305
 
@@ -339,7 +330,7 @@ Defined in: `xstate`
339
330
  send(event): void;
340
331
  ```
341
332
 
342
- Defined in: [packages/play-xstate/src/player-actor.ts:593](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L593)
333
+ Defined in: [packages/play-xstate/src/player-actor.ts:585](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L585)
343
334
 
344
335
  Send an event to the underlying XState actor.
345
336
 
@@ -383,7 +374,7 @@ actor.send({ type: "play.route", to: "#home" });
383
374
  start(): this;
384
375
  ```
385
376
 
386
- Defined in: [packages/play-xstate/src/player-actor.ts:547](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L547)
377
+ Defined in: [packages/play-xstate/src/player-actor.ts:540](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L540)
387
378
 
388
379
  Start the actor
389
380
 
@@ -405,7 +396,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
405
396
  stop(): this;
406
397
  ```
407
398
 
408
- Defined in: [packages/play-xstate/src/player-actor.ts:561](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/player-actor.ts#L561)
399
+ Defined in: [packages/play-xstate/src/player-actor.ts:554](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L554)
409
400
 
410
401
  Stop the actor and cleanup
411
402
 
@@ -427,70 +418,25 @@ Stop the actor and cleanup
427
418
  subscribe(observer): Subscription;
428
419
  ```
429
420
 
430
- Defined in: `xstate`
421
+ Defined in: [packages/play-xstate/src/player-actor.ts:630](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L630)
422
+
423
+ Subscribe to snapshot updates from the wrapped XState actor.
431
424
 
432
- Subscribe an observer to an actor’s snapshot values.
425
+ Accepts an observer object, exactly like XState's `Actor.subscribe`.
433
426
 
434
427
  ##### Parameters
435
428
 
436
- | Parameter | Type | Description |
437
- | ---------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
438
- | `observer` | [`Observer`](https://www.jsdocs.io/package/xstate#Observer)\<`any`\> | Either a plain function that receives the latest snapshot, or an observer object whose `.next(snapshot)` method receives the latest snapshot |
429
+ | Parameter | Type | Description |
430
+ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- |
431
+ | `observer` | [`Observer`](https://www.jsdocs.io/package/xstate#Observer)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>\> | Observer with `next`/`error`/`complete` handlers. |
439
432
 
440
433
  ##### Returns
441
434
 
442
435
  [`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
443
436
 
444
- ##### Remarks
445
-
446
- The observer will receive the actor’s snapshot value when it is emitted.
447
- The observer can be:
437
+ Subscription with an `unsubscribe()` method.
448
438
 
449
- - A plain function that receives the latest snapshot, or
450
- - An observer object whose `.next(snapshot)` method receives the latest
451
- snapshot
452
-
453
- ##### Examples
454
-
455
- ```ts
456
- // Observer as a plain function
457
- const subscription = actor.subscribe((snapshot) => {
458
- console.log(snapshot);
459
- });
460
- ```
461
-
462
- ```ts
463
- // Observer as an object
464
- const subscription = actor.subscribe({
465
- next(snapshot) {
466
- console.log(snapshot);
467
- },
468
- error(err) {
469
- // ...
470
- },
471
- complete() {
472
- // ...
473
- },
474
- });
475
- ```
476
-
477
- The return value of `actor.subscribe(observer)` is a subscription object
478
- that has an `.unsubscribe()` method. You can call
479
- `subscription.unsubscribe()` to unsubscribe the observer:
480
-
481
- ```ts
482
- const subscription = actor.subscribe((snapshot) => {
483
- // ...
484
- });
485
-
486
- // Unsubscribe the observer
487
- subscription.unsubscribe();
488
- ```
489
-
490
- When the actor is stopped, all of its observers will automatically be
491
- unsubscribed.
492
-
493
- ##### Inherited from
439
+ ##### Overrides
494
440
 
495
441
  [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`subscribe`](../../play-actor/classes/AbstractActor.md#subscribe)
496
442
 
@@ -503,72 +449,27 @@ subscribe(
503
449
  completeListener?): Subscription;
504
450
  ```
505
451
 
506
- Defined in: `xstate`
452
+ Defined in: [packages/play-xstate/src/player-actor.ts:641](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/player-actor.ts#L641)
453
+
454
+ Subscribe to snapshot updates from the wrapped XState actor.
507
455
 
508
- Subscribe an observer to an actor’s snapshot values.
456
+ Accepts listener functions, exactly like XState's `Actor.subscribe`.
509
457
 
510
458
  ##### Parameters
511
459
 
512
- | Parameter | Type |
513
- | ------------------- | ---------------------- |
514
- | `nextListener?` | (`snapshot`) => `void` |
515
- | `errorListener?` | (`error`) => `void` |
516
- | `completeListener?` | () => `void` |
460
+ | Parameter | Type | Description |
461
+ | ------------------- | ---------------------- | -------------------------------------------------------- |
462
+ | `nextListener?` | (`snapshot`) => `void` | Snapshot listener function. |
463
+ | `errorListener?` | (`error`) => `void` | Called when the actor errors. |
464
+ | `completeListener?` | () => `void` | Called when the actor completes (reaches a final state). |
517
465
 
518
466
  ##### Returns
519
467
 
520
468
  [`Subscription`](https://www.jsdocs.io/package/xstate#Subscription)
521
469
 
522
- ##### Remarks
523
-
524
- The observer will receive the actor’s snapshot value when it is emitted.
525
- The observer can be:
526
-
527
- - A plain function that receives the latest snapshot, or
528
- - An observer object whose `.next(snapshot)` method receives the latest
529
- snapshot
530
-
531
- ##### Examples
532
-
533
- ```ts
534
- // Observer as a plain function
535
- const subscription = actor.subscribe((snapshot) => {
536
- console.log(snapshot);
537
- });
538
- ```
539
-
540
- ```ts
541
- // Observer as an object
542
- const subscription = actor.subscribe({
543
- next(snapshot) {
544
- console.log(snapshot);
545
- },
546
- error(err) {
547
- // ...
548
- },
549
- complete() {
550
- // ...
551
- },
552
- });
553
- ```
554
-
555
- The return value of `actor.subscribe(observer)` is a subscription object
556
- that has an `.unsubscribe()` method. You can call
557
- `subscription.unsubscribe()` to unsubscribe the observer:
558
-
559
- ```ts
560
- const subscription = actor.subscribe((snapshot) => {
561
- // ...
562
- });
563
-
564
- // Unsubscribe the observer
565
- subscription.unsubscribe();
566
- ```
567
-
568
- When the actor is stopped, all of its observers will automatically be
569
- unsubscribed.
470
+ Subscription with an `unsubscribe()` method.
570
471
 
571
- ##### Inherited from
472
+ ##### Overrides
572
473
 
573
474
  [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`subscribe`](../../play-actor/classes/AbstractActor.md#subscribe)
574
475
 
@@ -580,7 +481,7 @@ unsubscribed.
580
481
  toJSON(): object;
581
482
  ```
582
483
 
583
- Defined in: `xstate`
484
+ Defined in: `.pnpm`
584
485
 
585
486
  #### Returns
586
487
 
package/api/@xmachines/play-xstate/functions/buildRouteUrl.md CHANGED
@@ -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.53/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.55/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
 
package/api/@xmachines/play-xstate/functions/composeGuards.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/guards/compose.ts#L78)
10
10
 
11
11
  Compose guards with AND logic using XState's and() helper
12
12
 
package/api/@xmachines/play-xstate/functions/composeGuardsOr.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/guards/compose.ts#L144)
10
10
 
11
11
  Compose guards with OR logic using XState's or() helper
12
12
 
package/api/@xmachines/play-xstate/functions/contextFieldMatches.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/guards/helpers.ts#L71)
10
10
 
11
11
  Check if a context field matches an expected value.
12
12
 
package/api/@xmachines/play-xstate/functions/definePlayer.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/define-player.ts#L61)
10
10
 
11
11
  Create a player factory from an XState machine
12
12
 
package/api/@xmachines/play-xstate/functions/deriveRoute.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/routing/derive-route.ts#L91)
10
10
 
11
11
  Derive route from XState state metadata
12
12
 
package/api/@xmachines/play-xstate/functions/eventMatches.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/guards/helpers.ts#L50)
10
10
 
11
11
  Check if event type matches expected type
12
12
 
package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md CHANGED
@@ -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.53/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.55/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
 
package/api/@xmachines/play-xstate/functions/hasContext.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/guards/helpers.ts#L24)
10
10
 
11
11
  Check if context has a truthy value at path
12
12
 
package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md CHANGED
@@ -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:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-xstate/src/routing/derive-route.ts#L149)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-xstate/src/routing/derive-route.ts#L158)
10
10
 
11
11
  Check if route path is absolute
12
12
 
package/api/@xmachines/play-xstate/functions/negateGuard.md CHANGED
@@ -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.53/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.55/packages/play-xstate/src/guards/compose.ts#L204)
10
10
 
11
11
  Negate a guard using XState's not() helper
12
12