@xmachines/docs 1.0.0-beta.58 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (319) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +11 -11
  2. package/api/@xmachines/play/classes/PlayError.md +11 -11
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +15 -15
  6. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  7. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +7 -7
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +7 -7
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +4 -4
  14. package/api/@xmachines/play-dom/README.md +2 -6
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +10 -10
  19. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  20. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +12 -12
  21. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  22. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  23. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  24. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  25. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  26. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  27. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  28. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +6 -6
  29. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
  30. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  31. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  32. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  33. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  35. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  37. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +8 -8
  38. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  39. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  40. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  41. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  42. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  43. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +5 -5
  44. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  45. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  46. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  47. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  48. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  49. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  50. package/api/@xmachines/play-react-router/README.md +1 -3
  51. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  52. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  53. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  54. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  55. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  56. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  57. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
  58. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  60. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  61. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  62. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  63. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  64. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  65. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  66. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  67. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  68. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  70. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  74. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  76. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  77. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  81. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  82. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  83. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  85. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  86. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +6 -6
  87. package/api/@xmachines/play-router/interfaces/LocationLike.md +5 -5
  88. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +5 -5
  89. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +7 -7
  90. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  91. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  92. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +5 -5
  93. package/api/@xmachines/play-router/interfaces/RoutableActor.md +6 -6
  94. package/api/@xmachines/play-router/interfaces/RouteInfo.md +10 -10
  95. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +4 -4
  96. package/api/@xmachines/play-router/interfaces/RouteMapping.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/RouteMatch.md +5 -5
  98. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  99. package/api/@xmachines/play-router/interfaces/RouteObject.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/RouteTree.md +7 -7
  101. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  102. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  104. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  105. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  106. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  107. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -4
  108. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  109. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -4
  110. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  111. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  112. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  113. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  114. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  115. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  116. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  117. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  118. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  119. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  120. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  121. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  122. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  123. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  124. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  125. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  126. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  127. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +15 -15
  128. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  129. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
  130. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  131. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  132. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  133. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  134. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  135. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  136. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  137. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  138. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  140. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  141. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  142. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  143. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  144. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  145. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  146. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  147. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  148. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  149. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  150. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  151. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  152. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
  153. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  154. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  155. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  156. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  157. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  158. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  160. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  161. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +6 -6
  162. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  163. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
  164. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  165. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  166. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  167. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  168. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  169. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  170. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  171. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  172. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  173. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  174. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  175. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
  176. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  177. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  178. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  179. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  180. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  182. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  184. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  185. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  186. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  187. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  188. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  189. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  190. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  191. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  193. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  201. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  202. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  203. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  204. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  205. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  206. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  207. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  208. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +7 -7
  209. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +10 -10
  210. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  211. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  212. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  213. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  214. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  215. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -4
  216. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  217. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  218. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  219. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  220. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  221. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
  222. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +4 -4
  223. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +5 -5
  224. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  225. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  226. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  227. package/api/@xmachines/play-xstate/classes/PlayerActor.md +28 -28
  228. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  236. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  237. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  238. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  239. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +5 -5
  240. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +4 -4
  241. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +8 -8
  242. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +7 -7
  243. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +4 -4
  244. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  245. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  246. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  247. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  248. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  249. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  250. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  251. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  252. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  253. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  254. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  255. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  256. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  257. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  258. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  259. package/contributing/deployment.md +10 -12
  260. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  270. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  271. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  272. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  273. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  274. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  275. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  276. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  287. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  288. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  289. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  290. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  291. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  304. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  305. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  306. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  307. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  308. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  309. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  310. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  311. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  312. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  313. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  314. package/examples/multi-router-integration.md +3 -9
  315. package/examples/routing-patterns.md +2 -6
  316. package/guides/getting-started.md +1 -3
  317. package/guides/state-machines.md +2 -6
  318. package/package.json +6 -6
  319. package/rfc/play.md +1 -3
package/api/@xmachines/play-vue-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
package/api/@xmachines/play-vue-router/interfaces/PlayActor.md CHANGED
@@ -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.58/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/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
@@ -35,11 +35,11 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
35
35
 
36
36
  ## Properties
37
37
 
38
- | Property | Modifier | Type | Description | Inherited from | Defined in |
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.58/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.58/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.58/packages/play-router/src/types.ts#L267) |
38
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
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/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/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/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.58/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/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md CHANGED
@@ -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.58/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/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -120,10 +120,10 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
120
120
 
121
121
  ## Properties
122
122
 
123
- | Property | Modifier | Type | Defined in |
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.58/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.58/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.58/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.58/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.58/packages/play-router/src/types.ts#L226) |
123
+ | Property | Modifier | Type | Defined in |
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/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/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/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/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/packages/play-router/src/types.ts#L226) |
package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md CHANGED
@@ -2,12 +2,12 @@
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.58/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/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Description | Defined in |
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.58/packages/play-router/src/create-route-map.ts#L20) |
11
+ | Property | Type | Description | Defined in |
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/packages/play-router/src/create-route-map.ts#L20) |
package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md CHANGED
@@ -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.58/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/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -21,7 +21,7 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Modifier | Type | Description | Defined in |
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.58/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.58/packages/play-router/src/base-route-map.ts#L53) |
24
+ | Property | Modifier | Type | Description | Defined in |
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/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/packages/play-router/src/base-route-map.ts#L53) |
package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md CHANGED
@@ -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.58/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/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.58/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/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.58/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/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md CHANGED
@@ -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.58/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/packages/play-vue-router/src/play-router-provider.ts#L10)
10
10
 
11
11
  ## Deprecated
12
12
 
package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md CHANGED
@@ -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.58/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/packages/play-vue-router/src/play-router-provider.ts#L19)
68
68
 
69
69
  PlayRouterProvider — Vue convenience wrapper for VueRouterBridge.
70
70
 
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:361](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-xstate/src/player-actor.ts#L361)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:362](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L362)
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.58/packages/play-xstate/src/player-actor.ts#L453)
111
+ Defined in: [packages/play-xstate/src/player-actor.ts:454](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L454)
112
112
 
113
113
  #### Parameters
114
114
 
@@ -129,22 +129,22 @@ Defined in: [packages/play-xstate/src/player-actor.ts:453](https://gitlab.com/xm
129
129
 
130
130
  ## Properties
131
131
 
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.58/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.58/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.58/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.58/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) | - |
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:408](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L408) |
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:452](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L452) |
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:425](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L425) |
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:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L373) |
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) | - |
148
148
 
149
149
  ## Methods
150
150
 
@@ -172,7 +172,7 @@ Defined in: `xstate`
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.58/packages/play-xstate/src/player-actor.ts#L385)
175
+ Defined in: [packages/play-xstate/src/player-actor.ts:386](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L386)
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.58/packages/play-xstate/src/player-actor.ts#L726)
206
+ Defined in: [packages/play-xstate/src/player-actor.ts:727](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L727)
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.58/packages/play-xstate/src/player-actor.ts#L684)
224
+ Defined in: [packages/play-xstate/src/player-actor.ts:685](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L685)
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.58/packages/play-xstate/src/player-actor.ts#L608)
247
+ Defined in: [packages/play-xstate/src/player-actor.ts:609](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L609)
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.58/packages/play-xstate/src/player-actor.ts#L669)
267
+ Defined in: [packages/play-xstate/src/player-actor.ts:670](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L670)
268
268
 
269
269
  Listen for events emitted by the wrapped XState actor via the `emit` action.
270
270
 
@@ -330,7 +330,7 @@ Defined in: `xstate`
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.58/packages/play-xstate/src/player-actor.ts#L585)
333
+ Defined in: [packages/play-xstate/src/player-actor.ts:586](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L586)
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.58/packages/play-xstate/src/player-actor.ts#L540)
377
+ Defined in: [packages/play-xstate/src/player-actor.ts:541](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L541)
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.58/packages/play-xstate/src/player-actor.ts#L554)
399
+ Defined in: [packages/play-xstate/src/player-actor.ts:555](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L555)
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.58/packages/play-xstate/src/player-actor.ts#L630)
421
+ Defined in: [packages/play-xstate/src/player-actor.ts:631](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L631)
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.58/packages/play-xstate/src/player-actor.ts#L641)
452
+ Defined in: [packages/play-xstate/src/player-actor.ts:642](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/player-actor.ts#L642)
453
453
 
454
454
  Subscribe to snapshot updates from the wrapped XState actor.
455
455
 
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.58/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/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.58/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/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.58/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/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.58/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/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.58/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/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.58/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/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.58/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/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:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-xstate/src/routing/format-play-route-transitions.ts#L89)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L89)
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.58/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/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:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-xstate/src/routing/derive-route.ts#L160)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-xstate/src/routing/derive-route.ts#L160)
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.58/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/packages/play-xstate/src/guards/compose.ts#L204)
10
10
 
11
11
  Negate a guard using XState's not() helper
12
12
 
package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md CHANGED
@@ -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.58/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/packages/play-xstate/src/types.ts#L7)
6
6
 
7
7
  Configuration for definePlayer()
8
8
 
@@ -14,7 +14,7 @@ Configuration for definePlayer()
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Type | Description | Defined in |
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.58/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.58/packages/play-xstate/src/types.ts#L12) |
17
+ | Property | Type | Description | Defined in |
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/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/packages/play-xstate/src/types.ts#L12) |