@xmachines/docs 1.0.0-beta.29 → 1.0.0-beta.30

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 (259) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -4
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  4. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  5. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  6. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  8. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  9. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  10. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  11. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  12. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  13. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  14. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  15. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  16. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  17. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  19. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  20. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  21. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  22. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  23. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  24. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  25. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  26. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  28. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  29. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  30. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  31. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  32. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  33. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  35. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  37. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  38. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  39. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  40. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  41. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  42. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  43. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  44. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  45. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  46. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  47. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  48. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  49. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  50. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  51. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  52. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  53. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  54. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  55. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  56. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  57. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  58. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  59. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  60. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  61. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  62. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  63. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  64. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  65. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  66. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  67. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  68. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  69. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  70. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  71. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  72. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  73. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  74. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  75. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  76. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  77. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  78. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  79. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  80. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  81. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  82. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  83. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  84. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  85. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  86. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  87. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  88. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  89. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  91. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  92. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  93. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  94. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  95. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  96. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  97. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  98. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  99. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  100. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  101. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  102. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  103. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  104. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  105. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  106. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  107. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  108. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  109. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  110. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  111. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  112. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  113. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  114. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  115. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  116. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  117. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  118. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  119. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  120. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  121. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  123. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  124. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  125. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  126. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  127. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  129. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  130. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  131. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  132. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  133. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  135. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  136. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  137. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  138. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  139. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  140. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  141. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  142. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  143. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  144. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  145. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  146. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  147. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  148. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  149. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  150. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  151. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  152. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  153. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  154. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  155. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  156. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  157. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  158. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  159. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  160. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  161. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  162. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  163. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  164. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  165. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  166. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  167. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  168. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  169. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  170. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  171. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  172. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  173. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  174. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  175. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  176. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  177. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  178. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  179. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  180. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  181. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  182. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  183. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  184. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  185. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  186. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  187. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  188. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  189. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  190. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  191. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  192. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  193. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  194. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  195. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  196. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  197. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  198. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  199. package/examples/@xmachines/play-dom-demo/functions/initShell.md +5 -5
  200. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  201. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  202. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  203. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  204. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  205. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  206. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  207. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  208. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  209. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  210. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  211. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +5 -5
  212. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +5 -5
  213. package/examples/@xmachines/play-react-demo/functions/Shell.md +7 -7
  214. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  215. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  216. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  217. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  218. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  219. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  220. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  221. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  222. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  223. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  224. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  225. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +5 -5
  226. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +5 -5
  227. package/examples/@xmachines/play-solid-demo/functions/Shell.md +7 -7
  228. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  229. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  230. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  231. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  232. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  233. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  234. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  235. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  236. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  237. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  238. package/examples/README.md +0 -8
  239. package/package.json +2 -2
  240. package/examples/@xmachines/play-actor-shared/README.md +0 -155
  241. package/examples/@xmachines/play-actor-shared/interfaces/AuthContext.md +0 -14
  242. package/examples/@xmachines/play-actor-shared/type-aliases/AuthActor.md +0 -27
  243. package/examples/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +0 -16
  244. package/examples/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +0 -17
  245. package/examples/@xmachines/play-actor-shared/type-aliases/AuthInput.md +0 -9
  246. package/examples/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +0 -11
  247. package/examples/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +0 -187
  248. package/examples/@xmachines/play-actor-shared/type-aliases/InferProps.md +0 -17
  249. package/examples/@xmachines/play-actor-shared/variables/authCatalog.md +0 -173
  250. package/examples/@xmachines/play-actor-shared/variables/authMachine.md +0 -189
  251. package/examples/@xmachines/play-actor-shared/variables/authSetup.md +0 -22
  252. package/examples/@xmachines/play-router-shared/README.md +0 -111
  253. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +0 -3
  254. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +0 -11
  255. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +0 -19
  256. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +0 -19
  257. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +0 -8
  258. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +0 -63
  259. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +0 -32
package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueRouterBridge
4
4
 
5
- Defined in: [play-vue-router/src/vue-router-bridge.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L16)
5
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L16)
6
6
 
7
7
  @xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
8
8
 
@@ -23,7 +23,7 @@ new VueRouterBridge(
23
23
  routeMap): VueRouterBridge;
24
24
  ```
25
25
 
26
- Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L21)
26
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L21)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -45,15 +45,15 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xma
45
45
 
46
46
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
47
47
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L99) |
49
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L87) |
50
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L86) |
51
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L89) |
52
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L88) |
53
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L100) |
54
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L102) |
55
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L101) |
56
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L90) |
48
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L99) |
49
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L87) |
50
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L86) |
51
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L89) |
52
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L88) |
53
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L100) |
54
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L102) |
55
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L101) |
56
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L90) |
57
57
 
58
58
  ## Methods
59
59
 
@@ -63,7 +63,7 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:21](https://gitlab.com/xma
63
63
  connect(): void;
64
64
  ```
65
65
 
66
- Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L126)
66
+ Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L126)
67
67
 
68
68
  Connect the router bridge to the Actor.
69
69
 
@@ -95,7 +95,7 @@ Adapters that need custom initial-sync behavior should override
95
95
  disconnect(): void;
96
96
  ```
97
97
 
98
- Defined in: [play-router/src/router-bridge-base.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L209)
98
+ Defined in: [play-router/src/router-bridge-base.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L209)
99
99
 
100
100
  Disconnect the router bridge from the Actor.
101
101
 
@@ -117,7 +117,7 @@ Stops signal watching and unregisters framework-specific router listener.
117
117
  dispose(): void;
118
118
  ```
119
119
 
120
- Defined in: [play-vue-router/src/vue-router-bridge.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L135)
120
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L135)
121
121
 
122
122
  Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`).
123
123
 
@@ -133,7 +133,7 @@ Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`
133
133
  protected extractParams(pathname, stateId): Record<string, string>;
134
134
  ```
135
135
 
136
- Defined in: [play-router/src/router-bridge-base.ts:318](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L318)
136
+ Defined in: [play-router/src/router-bridge-base.ts:318](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L318)
137
137
 
138
138
  Extract path parameters from URL using the URLPattern API.
139
139
 
@@ -171,7 +171,7 @@ When URLPattern is absent and the route is parameterized
171
171
  protected extractQuery(search): Record<string, string>;
172
172
  ```
173
173
 
174
- Defined in: [play-router/src/router-bridge-base.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L355)
174
+ Defined in: [play-router/src/router-bridge-base.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L355)
175
175
 
176
176
  Extract query parameters from URL search string.
177
177
 
@@ -199,7 +199,7 @@ Extracted query parameters or empty object
199
199
  protected getInitialRouterPath(): string | null;
200
200
  ```
201
201
 
202
- Defined in: [play-vue-router/src/vue-router-bridge.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L115)
202
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L115)
203
203
 
204
204
  Return the router's current pathname at connect() time.
205
205
 
@@ -235,7 +235,7 @@ bridges that have not yet implemented this hook.
235
235
  protected getInitialRouterSearch(): string | undefined;
236
236
  ```
237
237
 
238
- Defined in: [play-vue-router/src/vue-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L127)
238
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L127)
239
239
 
240
240
  Return the initial URL search string for query-param forwarding on `connect()`.
241
241
 
@@ -260,7 +260,7 @@ from the first `"?"`. Returns `undefined` when no query string is present so
260
260
  protected navigateRouter(path): void;
261
261
  ```
262
262
 
263
- Defined in: [play-vue-router/src/vue-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L64)
263
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L64)
264
264
 
265
265
  Navigate Vue Router to the given path.
266
266
 
@@ -290,7 +290,7 @@ are skipped. Navigation errors are thrown as [VueRouterNavigationError](#).
290
290
  protected resolveNavigationPath(route): string | null;
291
291
  ```
292
292
 
293
- Defined in: [play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L340)
293
+ Defined in: [play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L340)
294
294
 
295
295
  Resolve an actor route value to a concrete URL path for navigation.
296
296
 
@@ -329,7 +329,7 @@ Concrete URL path, or `null` if navigation should be skipped
329
329
  protected syncActorFromRouter(pathname, search?): void;
330
330
  ```
331
331
 
332
- Defined in: [play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L260)
332
+ Defined in: [play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L260)
333
333
 
334
334
  Sync actor state when router location changes.
335
335
 
@@ -359,7 +359,7 @@ Prevents circular updates via isProcessingNavigation flag.
359
359
  protected syncRouterFromActor(route): void;
360
360
  ```
361
361
 
362
- Defined in: [play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L240)
362
+ Defined in: [play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/router-bridge-base.ts#L240)
363
363
 
364
364
  Sync router location when actor route signal changes.
365
365
 
@@ -392,7 +392,7 @@ suppressed as circular echoes.
392
392
  protected unwatchRouterChanges(): void;
393
393
  ```
394
394
 
395
- Defined in: [play-vue-router/src/vue-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L110)
395
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L110)
396
396
 
397
397
  Stop watching for router location changes.
398
398
 
@@ -414,7 +414,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
414
414
  protected watchRouterChanges(): void;
415
415
  ```
416
416
 
417
- Defined in: [play-vue-router/src/vue-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/vue-router-bridge.ts#L78)
417
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/vue-router-bridge.ts#L78)
418
418
 
419
419
  Subscribe to Vue Router changes using `afterEach`.
420
420
 
package/api/@xmachines/play-vue-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-vue-router/src/create-route-map.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-vue-router/src/create-route-map.ts#L5)
9
+ Defined in: [play-vue-router/src/create-route-map.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/create-route-map.ts#L5)
10
10
 
11
11
  ## Parameters
12
12
 
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:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L224) |
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:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L59) |
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:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L61) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L59) |
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:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L287)
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:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/types.ts#L303)
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,6 +6,6 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
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.29/packages/play-vue-router/src/play-router-provider.ts#L10)
9
+ Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/play-router-provider.ts#L10)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
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.29/packages/play-vue-router/src/play-router-provider.ts#L19)
67
+ Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/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:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L348)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L348)
6
6
 
7
7
  Concrete XState actor implementing Play Architecture signal protocol
8
8
 
@@ -109,7 +109,7 @@ new PlayerActor<TMachine>(
109
109
  _cachedInitialRoute?): PlayerActor<TMachine>;
110
110
  ```
111
111
 
112
- Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L426)
112
+ Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L426)
113
113
 
114
114
  #### Parameters
115
115
 
@@ -135,16 +135,16 @@ Defined in: [packages/play-xstate/src/player-actor.ts:426](https://gitlab.com/xm
135
135
  | ------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136
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
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:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L378) |
139
- | <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.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 `ViewMetadata` has its spec 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.component); // e.g. "Dashboard" console.log(view.spec); // @json-render/core Spec object }` | - | - | [packages/play-xstate/src/player-actor.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L424) |
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:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L378) |
139
+ | <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.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 `ViewMetadata` has its spec 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.component); // e.g. "Dashboard" console.log(view.spec); // @json-render/core Spec object }` | - | - | [packages/play-xstate/src/player-actor.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L424) |
140
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:398](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L398) |
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:398](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L398) |
142
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
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
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
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
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)\<[`AnyMachineSnapshot`](https://www.jsdocs.io/package/xstate#AnyMachineSnapshot)\> | 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:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L358) |
147
+ | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`AnyMachineSnapshot`](https://www.jsdocs.io/package/xstate#AnyMachineSnapshot)\> | 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:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L358) |
148
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
149
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
150
150
 
@@ -174,7 +174,7 @@ Defined in: `xstate`
174
174
  dispose(): void;
175
175
  ```
176
176
 
177
- Defined in: [packages/play-xstate/src/player-actor.ts:638](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L638)
177
+ Defined in: [packages/play-xstate/src/player-actor.ts:638](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L638)
178
178
 
179
179
  Convenience dispose method for cleanup
180
180
 
@@ -226,7 +226,7 @@ https://stately.ai/docs/persistence
226
226
  getSnapshot(): SnapshotFrom<TMachine>;
227
227
  ```
228
228
 
229
- Defined in: [packages/play-xstate/src/player-actor.ts:607](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L607)
229
+ Defined in: [packages/play-xstate/src/player-actor.ts:607](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L607)
230
230
 
231
231
  Get current snapshot
232
232
 
@@ -308,7 +308,7 @@ Defined in: `xstate`
308
308
  send(event): void;
309
309
  ```
310
310
 
311
- Defined in: [packages/play-xstate/src/player-actor.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L584)
311
+ Defined in: [packages/play-xstate/src/player-actor.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L584)
312
312
 
313
313
  Send an event to the underlying XState actor.
314
314
 
@@ -352,7 +352,7 @@ actor.send({ type: "play.route", to: "#home" });
352
352
  start(): this;
353
353
  ```
354
354
 
355
- Defined in: [packages/play-xstate/src/player-actor.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L538)
355
+ Defined in: [packages/play-xstate/src/player-actor.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L538)
356
356
 
357
357
  Start the actor
358
358
 
@@ -374,7 +374,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
374
374
  stop(): this;
375
375
  ```
376
376
 
377
- Defined in: [packages/play-xstate/src/player-actor.ts:552](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/player-actor.ts#L552)
377
+ Defined in: [packages/play-xstate/src/player-actor.ts:552](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/player-actor.ts#L552)
378
378
 
379
379
  Stop the actor and cleanup
380
380
 
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.29/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.30/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:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/guards/compose.ts#L77)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/compose.ts#L77)
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:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/guards/compose.ts#L143)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/compose.ts#L143)
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:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/guards/helpers.ts#L68)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/helpers.ts#L68)
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.29/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.30/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:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/derive-route.ts#L90)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/derive-route.ts#L90)
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:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/guards/helpers.ts#L49)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/helpers.ts#L49)
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.29/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.30/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:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/guards/helpers.ts#L23)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/helpers.ts#L23)
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:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/routing/derive-route.ts#L150)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/routing/derive-route.ts#L150)
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:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-xstate/src/guards/compose.ts#L203)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/guards/compose.ts#L203)
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.29/packages/play-xstate/src/types.ts#L7)
5
+ Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-xstate/src/types.ts#L7)
6
6
 
7
7
  Configuration for definePlayer()
8
8
 
@@ -16,5 +16,5 @@ Configuration for definePlayer()
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ---------------------------------------- | ------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/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.29/packages/play-xstate/src/types.ts#L12) |
19
+ | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/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.30/packages/play-xstate/src/types.ts#L12) |