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

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 (289) hide show
  1. package/api/@xmachines/play/README.md +5 -0
  2. package/api/@xmachines/play/classes/NonNullableError.md +189 -0
  3. package/api/@xmachines/play/classes/PlayError.md +9 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +9 -9
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/README.md +40 -10
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +20 -12
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  16. package/api/@xmachines/play-dom/functions/defineRegistry.md +8 -21
  17. package/api/@xmachines/play-dom/functions/renderSpec.md +15 -13
  18. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -48
  19. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +7 -9
  21. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -8
  22. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +9 -12
  23. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -20
  24. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  25. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +30 -0
  26. package/api/@xmachines/play-dom/type-aliases/Actions.md +18 -0
  27. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -28
  28. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -7
  29. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -17
  30. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -6
  31. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +9 -0
  32. package/api/@xmachines/play-dom/variables/schema.md +56 -0
  33. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  34. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  35. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  36. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  37. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  38. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  39. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  40. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  41. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  42. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  43. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  44. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  45. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  46. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  47. package/api/@xmachines/play-react/README.md +29 -32
  48. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  49. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  50. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  51. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  52. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  53. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +11 -12
  54. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  55. package/api/@xmachines/play-react/variables/PlayRenderer.md +12 -5
  56. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  57. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  58. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  59. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  60. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  61. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  62. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  63. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  64. package/api/@xmachines/play-router/README.md +1 -1
  65. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  66. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  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/createRouteMapFromMachine.md +1 -1
  71. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  72. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  74. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  75. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  76. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  77. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  78. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  81. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  82. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  83. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  84. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  85. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  86. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  87. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  88. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  89. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  91. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  92. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  93. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  94. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  96. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  97. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  98. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  99. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  100. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  101. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  102. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  103. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  104. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  105. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  107. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  108. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  109. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  110. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  111. package/api/@xmachines/play-solid/README.md +28 -29
  112. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  113. package/api/@xmachines/play-solid/functions/useBoundProp.md +45 -0
  114. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +11 -12
  115. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  116. package/api/@xmachines/play-solid/variables/PlayRenderer.md +4 -25
  117. package/api/@xmachines/play-solid-router/README.md +2 -2
  118. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  119. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  120. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +28 -1
  121. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  122. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  123. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  124. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  125. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  126. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  127. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  128. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  129. package/api/@xmachines/play-svelte/README.md +23 -7
  130. package/api/@xmachines/play-svelte/functions/defineRegistry.md +12 -35
  131. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +23 -0
  132. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +8 -9
  133. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
  134. package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
  135. package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
  136. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  137. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  138. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  139. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  140. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  141. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  143. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  144. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  145. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  146. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  147. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  148. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  149. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  150. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  151. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  152. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  153. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  154. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  155. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  156. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +8 -1
  157. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  158. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  159. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  160. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  161. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  162. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  163. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  164. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  166. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  167. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  168. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  169. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +9 -1
  170. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  171. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  172. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  173. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  174. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  175. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  176. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  177. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  178. package/api/@xmachines/play-vue/README.md +33 -33
  179. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  180. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  181. package/api/@xmachines/play-vue/functions/useBoundProp.md +45 -0
  182. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +9 -10
  183. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  184. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  185. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  186. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  187. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  188. package/api/@xmachines/play-vue-router/README.md +3 -3
  189. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  190. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  191. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +39 -26
  192. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  193. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  194. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  195. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  196. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  197. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  198. package/api/@xmachines/play-xstate/README.md +1 -0
  199. package/api/@xmachines/play-xstate/classes/PlayerActor.md +54 -23
  200. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  201. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  202. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  203. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  204. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  205. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  206. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  207. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  208. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  209. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  210. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  211. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  212. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  213. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  214. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  215. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  216. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  217. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  218. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  219. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  220. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  221. package/api/@xmachines/shared/README.md +47 -47
  222. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  223. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  224. package/examples/@xmachines/play-dom-demo/README.md +7 -0
  225. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +23 -0
  226. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  227. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +9 -0
  228. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  229. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  230. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  231. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  232. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  233. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +9 -0
  234. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  235. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  236. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  237. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  238. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  239. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +172 -0
  240. package/examples/@xmachines/play-react-demo/README.md +9 -3
  241. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  242. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +1 -1
  243. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +1 -1
  244. package/examples/@xmachines/play-react-demo/functions/Shell.md +1 -1
  245. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +9 -0
  246. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  247. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  248. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  249. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +11 -0
  250. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  251. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  252. package/examples/@xmachines/play-react-demo/variables/NavBar.md +11 -0
  253. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +9 -0
  254. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  255. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  256. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  257. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  258. package/examples/@xmachines/play-react-demo/variables/Shell.md +13 -0
  259. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  260. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +172 -0
  261. package/examples/@xmachines/play-react-router-demo/README.md +1 -3
  262. package/examples/@xmachines/play-solid-demo/README.md +9 -3
  263. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  264. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/functions/Shell.md +1 -1
  267. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +9 -0
  268. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  269. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  270. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  271. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +11 -0
  272. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  273. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  274. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +11 -0
  275. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +12 -0
  276. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  277. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  278. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  279. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  280. package/examples/@xmachines/play-solid-demo/variables/Shell.md +13 -0
  281. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  282. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +172 -0
  283. package/examples/@xmachines/play-solid-router-demo/README.md +1 -3
  284. package/examples/README.md +2 -2
  285. package/package.json +6 -6
  286. package/rfc/play.md +19 -19
  287. package/api/@xmachines/play-react/functions/useStateBinding.md +0 -34
  288. package/api/@xmachines/play-solid/functions/useStateBinding.md +0 -25
  289. package/api/@xmachines/play-vue/functions/useStateBinding.md +0 -32
@@ -38,7 +38,7 @@ without muting console output.
38
38
  - `PlayRenderer` — main renderer component (Vue SFC)
39
39
  - `useActor` — composable for accessing the actor inside a `PlayRenderer` tree
40
40
  - `defineRegistry` — SFC-aware wrapper; auto-wraps `.vue` SFCs via `h(SFC, ctx)`
41
- - `useStateBinding` — re-exported from `@json-render/vue`
41
+ - `useBoundProp` — re-exported from `@json-render/vue`
42
42
  - `ComponentFn` (type) — re-exported from `@json-render/vue`
43
43
  - `ComponentContext` (type) — re-exported from `@json-render/vue`
44
44
  - `PlayRendererProps` (type)
@@ -62,14 +62,14 @@ export type Catalog = typeof catalog;
62
62
  ```
63
63
 
64
64
  ```vue
65
- <!-- Login.vue — Vue SFC; useStateBinding works in <script setup> -->
65
+ <!-- Login.vue — Vue SFC; useBoundProp works in <script setup> -->
66
66
  <script setup lang="ts">
67
- import { useStateBinding } from "@xmachines/play-vue";
67
+ import { useBoundProp } from "@xmachines/play-vue";
68
68
  import type { ComponentContext } from "@xmachines/play-vue";
69
69
  import type { Catalog } from "./catalog.js";
70
70
 
71
71
  const { props, emit, bindings } = defineProps<ComponentContext<Catalog, "Login">>();
72
- const [username, setUsername] = useStateBinding<string>(bindings?.username ?? "/username");
72
+ const [username, setUsername] = useBoundProp<string>(bindings?.username ?? "/username");
73
73
  </script>
74
74
 
75
75
  <template>
@@ -90,9 +90,17 @@ import { catalog } from "./catalog.js";
90
90
  import LoginSFC from "./Login.vue";
91
91
  import DashboardSFC from "./Dashboard.vue";
92
92
 
93
- export const { registry } = defineRegistry(catalog, {
93
+ export const registryResult = defineRegistry(catalog, {
94
94
  components: { Login: LoginSFC, Dashboard: DashboardSFC },
95
- actions: { login: async () => {}, logout: async () => {} },
95
+ actions: {
96
+ login: async (params) => {
97
+ if (!params) return;
98
+ actor.send({ type: "auth.login", username: params.username });
99
+ },
100
+ logout: async (params) => {
101
+ actor.send({ type: "auth.logout" });
102
+ },
103
+ },
96
104
  });
97
105
  ```
98
106
 
@@ -173,7 +181,7 @@ export const machine = setup({
173
181
  import { definePlayer } from "@xmachines/play-xstate";
174
182
  import { PlayRenderer } from "@xmachines/play-vue";
175
183
  import { machine } from "./machine.js";
176
- import { registry } from "./registry.js";
184
+ import { registryResult } from "./registry.js";
177
185
 
178
186
  const createPlayer = definePlayer({ machine });
179
187
  const actor = createPlayer();
@@ -181,11 +189,7 @@ actor.start();
181
189
  </script>
182
190
 
183
191
  <template>
184
- <PlayRenderer
185
- :actor="actor"
186
- :registry="registry"
187
- :actions="{ login: 'auth.login', logout: 'auth.logout' }"
188
- />
192
+ <PlayRenderer :actor="actor" :registryResult="registryResult" />
189
193
  </template>
190
194
  ```
191
195
 
@@ -196,23 +200,16 @@ actor.start();
196
200
  Main Vue component. Subscribes to `actor.currentView` and renders the spec.
197
201
 
198
202
  ```vue
199
- <PlayRenderer
200
- :actor="actor"
201
- :registry="registry"
202
- :actions="{ login: 'auth.login' }"
203
- :store="myStore"
204
- />
203
+ <PlayRenderer :actor="actor" :registryResult="registryResult" :store="myStore" />
205
204
  ```
206
205
 
207
206
  **`actor`** — A `PlayerActor` (or any `AbstractActor & Viewable`). Provides the `currentView` signal.
208
207
 
209
- **`registry`** — Built with `defineRegistry(catalog, { components, actions })` from `@xmachines/play-vue`. Pass `.vue` SFCs directly — they are auto-wrapped via `h(SFC, ctx)` so `useStateBinding` and other composables work inside `<script setup>`.
208
+ **`registryResult`** — The full `DefineRegistryResult` returned by `defineRegistry(catalog, { components, actions })` from `@xmachines/play-vue`. Pass `.vue` SFCs directly — they are auto-wrapped via `h(SFC, ctx)` so `useBoundProp` and other composables work inside `<script setup>`.
210
209
 
211
210
  `defineRegistry` also accepts `onRenderError(error, elementType)`, which receives errors
212
211
  caught by `@json-render/vue`'s inner element boundary before the default logger is used.
213
212
 
214
- **`actions`** — Maps json-render action names (from spec `on` bindings) to XState event type strings. Type-checked against `EventFromLogic<TLogic>["type"]` when `TLogic` is specified.
215
-
216
213
  **`store`** (optional) — Controls per-view UI state (`$state` bindings, form values):
217
214
 
218
215
  - **Omitted (uncontrolled, default):** A fresh `@xstate/store` atom is created per view transition, seeded from `view.spec.state`.
@@ -230,9 +227,17 @@ const store: StateStore = xstateStoreStateStore({ atom: createAtom({ username: "
230
227
  overriding the outer Vue error boundary:
231
228
 
232
229
  ```ts
233
- export const { registry } = defineRegistry(catalog, {
230
+ export const registryResult = defineRegistry(catalog, {
234
231
  components: { Login: LoginSFC, Dashboard: DashboardSFC },
235
- actions: { login: async () => {}, logout: async () => {} },
232
+ actions: {
233
+ login: async (params) => {
234
+ if (!params) return;
235
+ actor.send({ type: "auth.login", username: params.username });
236
+ },
237
+ logout: async (params) => {
238
+ actor.send({ type: "auth.logout" });
239
+ },
240
+ },
236
241
  onRenderError(error, elementType) {
237
242
  reportExpectedRenderError(error, elementType);
238
243
  },
@@ -240,12 +245,7 @@ export const { registry } = defineRegistry(catalog, {
240
245
  ```
241
246
 
242
247
  ```vue
243
- <PlayRenderer
244
- :actor="actor"
245
- :registry="registry"
246
- :store="store"
247
- :actions="{ login: 'auth.login' }"
248
- />
248
+ <PlayRenderer :actor="actor" :registryResult="registryResult" :store="store" />
249
249
  ```
250
250
 
251
251
  ---
@@ -285,8 +285,8 @@ Priority: **route param fills `undefined` slots; explicit non-`undefined` spec p
285
285
  - Vue reactivity is only used to trigger re-renders — not for business logic
286
286
  - `actor.currentView` (TC39 Signal) is bridged to Vue's reactive system inside `PlayRenderer`
287
287
  - Per-view UI state lives in an `@xstate/store` atom, not in Vue reactive state
288
- - `@json-render/vue` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useStateBinding` from `@xmachines/play-vue`
289
- - Vue views should be `.vue` SFCs using `ComponentContext<MyCatalog, "X">` — `defineRegistry` from `@xmachines/play-vue` auto-wraps them via `h(SFC, ctx)`, giving each SFC its own `setup()` context where `useStateBinding` and Vue composables work correctly
288
+ - `@json-render/vue` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useBoundProp` from `@xmachines/play-vue`
289
+ - Vue views should be `.vue` SFCs using `ComponentContext<MyCatalog, "X">` — `defineRegistry` from `@xmachines/play-vue` auto-wraps them via `h(SFC, ctx)`, giving each SFC its own `setup()` context where `useBoundProp` and Vue composables work correctly
290
290
 
291
291
  @xmachines/play-vue - Vue 3 renderer for XMachines Play architecture
292
292
 
@@ -295,7 +295,7 @@ and renders UI components via @json-render/vue. Vue reactivity is only used
295
295
  to trigger re-renders — signals are the source of truth.
296
296
 
297
297
  Re-exports `defineRegistry` (SFC-aware — auto-wraps `.vue` SFCs via `h()`),
298
- `useStateBinding`, `ComponentFn`, and `ComponentContext` so consumers import
298
+ `useBoundProp`, `ComponentFn`, and `ComponentContext` so consumers import
299
299
  everything from `@xmachines/play-vue` rather than `@json-render/vue` directly.
300
300
 
301
301
  ## Interfaces
@@ -319,4 +319,4 @@ everything from `@xmachines/play-vue` rather than `@json-render/vue` directly.
319
319
 
320
320
  - [defineRegistry](functions/defineRegistry.md)
321
321
  - [useActor](functions/useActor.md)
322
- - [useStateBinding](functions/useStateBinding.md)
322
+ - [useBoundProp](functions/useBoundProp.md)
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/define-registry.ts#L116)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L122)
10
10
 
11
11
  Create a component registry, automatically wrapping `.vue` SFCs so they work
12
12
  correctly with `@json-render/vue`'s rendering pipeline.
@@ -6,7 +6,7 @@
6
6
  function useActor(): PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/useActor.ts#L42)
9
+ Defined in: [packages/play-vue/src/useActor.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/useActor.ts#L43)
10
10
 
11
11
  ## Returns
12
12
 
@@ -0,0 +1,45 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / useBoundProp
2
+
3
+ # Function: useBoundProp()
4
+
5
+ ```ts
6
+ function useBoundProp<T>(propValue, bindingPath): [T | undefined, (value) => void];
7
+ ```
8
+
9
+ Defined in: `@json-render/vue`
10
+
11
+ Composable for two-way bound props. Returns `[value, setValue]` where:
12
+
13
+ - `value` is the already-resolved prop value (passed through from render props)
14
+ - `setValue` writes back to the bound state path (no-op if not bound)
15
+
16
+ Designed to work with the `bindings` map that the renderer provides when
17
+ a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
18
+
19
+ ## Type Parameters
20
+
21
+ | Type Parameter |
22
+ | -------------- |
23
+ | `T` |
24
+
25
+ ## Parameters
26
+
27
+ | Parameter | Type |
28
+ | ------------- | ----------------------- |
29
+ | `propValue` | `T` \| `undefined` |
30
+ | `bindingPath` | `string` \| `undefined` |
31
+
32
+ ## Returns
33
+
34
+ \[`T` \| `undefined`, (`value`) => `void`\]
35
+
36
+ ## Example
37
+
38
+ ```ts
39
+ import { useBoundProp } from "@json-render/vue";
40
+
41
+ const Input: ComponentFn<AppCatalog, "Input"> = ({ props, bindings }) => {
42
+ const [value, setValue] = useBoundProp<string>(props.value as string, bindings?.value);
43
+ return h("input", { value: value ?? "", onInput: (e) => setValue(e.target.value) });
44
+ };
45
+ ```
@@ -2,21 +2,20 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/types.ts#L25)
5
+ Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/types.ts#L23)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
9
9
  ## Type Parameters
10
10
 
11
- | Type Parameter | Default type | Description |
12
- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. When a specific machine type is provided, the `actions` values are constrained to the event type strings that the machine actually accepts. |
11
+ | Type Parameter | Default type | Description |
12
+ | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
13
+ | `TLogic` _extends_ [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | The XState actor logic type. Defaults to `AnyActorLogic` for non-generic usage. |
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Type | Description | Defined in |
18
- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-actions"></a> `actions?` | `object` | Optional map of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified. | [packages/play-vue/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/types.ts#L46) |
20
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/types.ts#L27) |
21
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from @json-render/vue defineRegistry | [packages/play-vue/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/types.ts#L30) |
22
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-vue/src/types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/types.ts#L39) |
17
+ | Property | Type | Description | Defined in |
18
+ | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/types.ts#L25) |
20
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() in @json-render/vue. Contains both the component registry and the action handlers factory. Action handlers are real async functions dispatching to the actor (not string-mapped event types). | [packages/play-vue/src/types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/types.ts#L32) |
21
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-vue/src/types.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/types.ts#L41) |
@@ -6,7 +6,7 @@
6
6
  type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/define-registry.ts#L90)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L96)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/define-registry.ts#L94)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L100)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
7
7
  object;
8
8
  ```
9
9
 
10
- Defined in: [packages/play-vue/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/define-registry.ts#L98)
10
+ Defined in: [packages/play-vue/src/define-registry.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L104)
11
11
 
12
12
  ## Type Declaration
13
13
 
14
14
  | Name | Type | Defined in |
15
15
  | ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/define-registry.ts#L102) |
16
+ | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/define-registry.ts#L108) |
17
17
 
18
18
  ## Type Parameters
19
19
 
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/useActor.ts#L25)
9
+ Defined in: [packages/play-vue/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/useActor.ts#L26)
@@ -6,4 +6,4 @@
6
6
  const PlayRenderer: DefineComponent<{}, {}, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue/src/vue-shim.d.ts#L3)
9
+ Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue/src/vue-shim.d.ts#L3)
@@ -159,9 +159,9 @@ class RouteMap extends VueBaseRouteMap {
159
159
  **Constructor Parameters:**
160
160
 
161
161
  - `mappings` - Array of mapping objects with:
162
- - `stateId` - State machine state ID (e.g., `'#profile'`)
163
- - `routeName` - Vue Router route name (e.g., `'profile'`)
164
- - `pattern` - Optional path pattern for URL resolution (e.g., `'/profile/:userId'`)
162
+ - `stateId` - State machine state ID (e.g., `'#profile'`)
163
+ - `routeName` - Vue Router route name (e.g., `'profile'`)
164
+ - `pattern` - Optional path pattern for URL resolution (e.g., `'/profile/:userId'`)
165
165
 
166
166
  **Methods (inherited from `VueBaseRouteMap`):**
167
167
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-vue-router/src/route-map.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-vue-router/src/route-map.ts#L10)
5
+ Defined in: [play-vue-router/src/route-map.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-vue-router/src/route-map.ts#L10)
6
6
 
7
7
  Bidirectional route mapper for Vue Router.
8
8
 
@@ -20,7 +20,7 @@ Alias for [BaseRouteMap](VueBaseRouteMap.md) from `@xmachines/play-router`.
20
20
  new RouteMap(mappings, options?): RouteMap;
21
21
  ```
22
22
 
23
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L125)
23
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L125)
24
24
 
25
25
  Build a route map from an array of state ID ↔ path mappings.
26
26
 
@@ -52,7 +52,7 @@ buckets for efficient candidate selection.
52
52
  getPathByStateId(stateId): string | null;
53
53
  ```
54
54
 
55
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L209)
55
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L209)
56
56
 
57
57
  Look up the path pattern registered for a state ID.
58
58
 
@@ -87,7 +87,7 @@ map.getPathByStateId("missing"); // null
87
87
  getStateIdByPath(path): string | null;
88
88
  ```
89
89
 
90
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L174)
90
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L174)
91
91
 
92
92
  Resolve a URL path to its mapped state ID.
93
93
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueBaseRouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -54,7 +54,7 @@ map.getPathByStateId("missing"); // null
54
54
  new VueBaseRouteMap(mappings, options?): BaseRouteMap;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L125)
57
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L125)
58
58
 
59
59
  Build a route map from an array of state ID ↔ path mappings.
60
60
 
@@ -82,7 +82,7 @@ buckets for efficient candidate selection.
82
82
  getPathByStateId(stateId): string | null;
83
83
  ```
84
84
 
85
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L209)
85
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L209)
86
86
 
87
87
  Look up the path pattern registered for a state ID.
88
88
 
@@ -113,7 +113,7 @@ map.getPathByStateId("missing"); // null
113
113
  getStateIdByPath(path): string | null;
114
114
  ```
115
115
 
116
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.30/packages/play-router/src/base-route-map.ts#L174)
116
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L174)
117
117
 
118
118
  Resolve a URL path to its mapped state ID.
119
119