@xmachines/docs 1.0.0-beta.34 → 1.0.0-beta.35

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 (321) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/README.md +9 -9
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  11. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/README.md +4 -3
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -23
  19. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  20. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +8 -8
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  28. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  29. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  32. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  41. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  42. package/api/@xmachines/play-dom-router/README.md +3 -3
  43. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +3 -3
  46. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  48. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  49. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  50. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  51. package/api/@xmachines/play-dom-router/interfaces/{RouteMapLike.md → RouteLookupContract.md} +7 -7
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +6 -11
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +8 -8
  54. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  56. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  57. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  58. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  59. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  60. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  61. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  63. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  64. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  65. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  66. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  67. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  69. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  70. package/api/@xmachines/play-react-router/README.md +1 -0
  71. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
  72. package/api/@xmachines/play-react-router/classes/RouteMap.md +38 -22
  73. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  74. package/api/@xmachines/play-react-router/functions/createRouteMap.md +21 -0
  75. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  77. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  78. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +8 -8
  79. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-router/README.md +6 -6
  81. package/api/@xmachines/play-router/classes/{BaseRouteMap.md → RouteMap.md} +11 -11
  82. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
  83. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  84. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  85. package/api/@xmachines/play-router/functions/createRouteMap.md +6 -6
  86. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +5 -5
  87. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +6 -6
  88. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  89. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  90. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  91. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  92. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  93. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  94. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  96. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  98. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  99. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  100. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  101. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  102. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  103. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  104. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  105. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  107. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  108. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  109. package/api/@xmachines/play-router/interfaces/RouteMapping.md +8 -8
  110. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  111. package/api/@xmachines/play-router/interfaces/{RouteMap.md → RouteMatcher.md} +13 -13
  112. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  113. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  114. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  115. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  118. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  119. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  120. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  121. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  124. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  125. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  126. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  127. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  128. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  129. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  131. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  132. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  134. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  136. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  137. package/api/@xmachines/play-solid-router/README.md +2 -2
  138. package/api/@xmachines/play-solid-router/classes/RouteMap.md +9 -9
  139. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
  140. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  141. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +3 -3
  142. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  143. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  144. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  145. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +8 -8
  146. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  156. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +9 -9
  158. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  159. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +3 -3
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +8 -8
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  166. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +9 -9
  167. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  168. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +3 -3
  169. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  170. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  171. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  172. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +8 -8
  173. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  174. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  175. package/api/@xmachines/play-tanstack-react-router/README.md +1 -1
  176. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +38 -22
  177. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
  178. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +7 -39
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +8 -8
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  187. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  189. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  190. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +9 -9
  191. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +25 -25
  192. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  193. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +3 -3
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +8 -8
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  198. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  199. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  201. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  202. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  203. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  204. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  205. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  206. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  207. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  208. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  209. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  210. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  211. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  212. package/api/@xmachines/play-vue-router/README.md +9 -4
  213. package/api/@xmachines/play-vue-router/classes/RouteMap.md +38 -20
  214. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
  215. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  216. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  217. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +8 -8
  218. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  219. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  220. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  221. package/api/@xmachines/play-xstate/README.md +1 -1
  222. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  223. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  224. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  225. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  227. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  228. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  234. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  235. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  236. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  237. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  238. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  239. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  240. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  242. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  243. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  244. package/api/@xmachines/shared/README.md +47 -47
  245. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  246. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  247. package/api/llms.txt +4 -2
  248. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  249. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +4 -3
  250. package/examples/@xmachines/play-dom-demo/functions/initShell.md +5 -1
  251. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  252. package/examples/@xmachines/play-dom-demo/variables/About.md +4 -1
  253. package/examples/@xmachines/play-dom-demo/variables/Contact.md +4 -1
  254. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +5 -1
  255. package/examples/@xmachines/play-dom-demo/variables/Home.md +5 -1
  256. package/examples/@xmachines/play-dom-demo/variables/Login.md +5 -1
  257. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +8 -1
  258. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +5 -1
  259. package/examples/@xmachines/play-dom-demo/variables/Overview.md +5 -1
  260. package/examples/@xmachines/play-dom-demo/variables/Profile.md +5 -1
  261. package/examples/@xmachines/play-dom-demo/variables/Settings.md +5 -1
  262. package/examples/@xmachines/play-dom-demo/variables/Stats.md +5 -1
  263. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  264. package/examples/@xmachines/play-dom-router-demo/README.md +26 -22
  265. package/examples/@xmachines/play-react-demo/README.md +2 -2
  266. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  267. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  268. package/examples/@xmachines/play-react-demo/variables/About.md +6 -1
  269. package/examples/@xmachines/play-react-demo/variables/Contact.md +6 -1
  270. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +7 -1
  271. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +5 -1
  272. package/examples/@xmachines/play-react-demo/variables/Home.md +6 -1
  273. package/examples/@xmachines/play-react-demo/variables/Login.md +8 -1
  274. package/examples/@xmachines/play-react-demo/variables/NavBar.md +6 -1
  275. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +7 -1
  276. package/examples/@xmachines/play-react-demo/variables/Navigation.md +6 -1
  277. package/examples/@xmachines/play-react-demo/variables/Overview.md +6 -1
  278. package/examples/@xmachines/play-react-demo/variables/Profile.md +6 -1
  279. package/examples/@xmachines/play-react-demo/variables/Settings.md +6 -1
  280. package/examples/@xmachines/play-react-demo/variables/Shell.md +6 -1
  281. package/examples/@xmachines/play-react-demo/variables/Stats.md +6 -1
  282. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  283. package/examples/@xmachines/play-react-router-demo/README.md +5 -3
  284. package/examples/@xmachines/play-solid-demo/README.md +2 -2
  285. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  286. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  288. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  289. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  290. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +5 -1
  291. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +6 -3
  295. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Shell.md +5 -1
  300. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  302. package/examples/@xmachines/play-solid-router-demo/README.md +6 -4
  303. package/examples/@xmachines/play-svelte-demo/README.md +11 -1
  304. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +9 -0
  305. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +9 -0
  306. package/examples/@xmachines/play-svelte-demo/variables/App.md +9 -0
  307. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +172 -0
  308. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +2 -2
  309. package/examples/@xmachines/play-sveltekit-router-demo/README.md +2 -2
  310. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +3 -3
  311. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +4 -4
  312. package/examples/@xmachines/play-vue-demo/README.md +11 -2
  313. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +9 -0
  314. package/examples/@xmachines/play-vue-demo/variables/App.md +9 -0
  315. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +172 -0
  316. package/examples/@xmachines/play-vue-router-demo/README.md +21 -24
  317. package/examples/README.md +2 -0
  318. package/package.json +2 -2
  319. package/rfc/play.md +19 -19
  320. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +0 -141
  321. package/api/_media/README.md +0 -404
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L14)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L14)
6
6
 
7
7
  Props for PlayErrorBoundary
8
8
 
@@ -10,6 +10,6 @@ Props for PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `ReactNode` | Child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Fallback UI to render when a child component throws. Defaults to null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Fallback UI to render when a child component throws. Defaults to null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryState
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L28)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L28)
6
6
 
7
7
  Internal state shape for PlayErrorBoundary
8
8
 
@@ -10,5 +10,5 @@ Internal state shape for PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Defined in |
12
12
  | ----------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
- | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
13
+ | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
+ | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayUIProvider.tsx#L34)
5
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayUIProvider.tsx#L34)
6
6
 
7
7
  Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own props.
8
8
 
@@ -14,13 +14,13 @@ Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own p
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L154) |
18
- | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L37) |
19
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L33) |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L154) |
18
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/ActorProvider.tsx#L37) |
19
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/ActorProvider.tsx#L33) |
20
20
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
21
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L35) |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L167) |
24
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L156) |
25
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L162) |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/ActorProvider.tsx#L35) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L167) |
24
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L156) |
25
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L162) |
26
26
  | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-react/src/ActorProvider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L45)
5
+ Defined in: [packages/play-react/src/ActorProvider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/ActorProvider.tsx#L45)
6
6
 
7
7
  Value provided by ViewContext (accessible via usePlayView()).
8
8
 
@@ -14,7 +14,7 @@ Value provided by ViewContext (accessible via usePlayView()).
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L122) |
18
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L124) |
19
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L120) |
20
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-actor/src/abstract-actor.ts#L126) |
17
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L122) |
18
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L124) |
19
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L120) |
20
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-actor/src/abstract-actor.ts#L126) |
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/useActor.ts#L27)
9
+ Defined in: [packages/play-react/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/useActor.ts#L27)
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: React.FC<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/ActorProvider.tsx:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/ActorProvider.tsx#L151)
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/ActorProvider.tsx#L151)
10
10
 
11
11
  ActorProvider — escape hatch primitive for composing actor lifecycle with custom providers.
12
12
 
@@ -3,10 +3,10 @@
3
3
  # Variable: PlayRenderer
4
4
 
5
5
  ```ts
6
- const PlayRenderer: React.FC;
6
+ const PlayRenderer: React.FC<Record<string, never>>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayRenderer.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayRenderer.tsx#L39)
9
+ Defined in: [packages/play-react/src/PlayRenderer.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayRenderer.tsx#L39)
10
10
 
11
11
  Zero-prop leaf component that renders the current actor view.
12
12
 
@@ -6,7 +6,7 @@
6
6
  const PlayUIProvider: React.FC<PlayUIProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react/src/PlayUIProvider.tsx#L102)
9
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react/src/PlayUIProvider.tsx#L102)
10
10
 
11
11
  PlayUIProvider — batteries-included entry point for actor-driven UI rendering.
12
12
 
@@ -198,5 +198,6 @@ Synchronizes browser URL with actor state using createBrowserRouter data API.
198
198
 
199
199
  ## Functions
200
200
 
201
+ - [createRouteMap](functions/createRouteMap.md)
201
202
  - [createRouteMapFromTree](functions/createRouteMapFromTree.md)
202
203
  - [PlayRouterProvider](functions/PlayRouterProvider.md)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReactRouterBridge
4
4
 
5
- Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L28)
5
+ Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L28)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -25,7 +25,7 @@ new ReactRouterBridge(
25
25
  routeMap): ReactRouterBridge;
26
26
  ```
27
27
 
28
- Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L31)
28
+ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L31)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -47,15 +47,15 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
47
47
 
48
48
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
49
49
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
- | <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.34/packages/play-router/src/router-bridge-base.ts#L99) |
51
- | <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.34/packages/play-router/src/router-bridge-base.ts#L87) |
52
- | <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.34/packages/play-router/src/router-bridge-base.ts#L86) |
53
- | <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.34/packages/play-router/src/router-bridge-base.ts#L89) |
54
- | <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.34/packages/play-router/src/router-bridge-base.ts#L88) |
55
- | <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.34/packages/play-router/src/router-bridge-base.ts#L100) |
56
- | `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.34/packages/play-router/src/router-bridge-base.ts#L102) |
57
- | `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.34/packages/play-router/src/router-bridge-base.ts#L101) |
58
- | <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.34/packages/play-router/src/router-bridge-base.ts#L90) |
50
+ | <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:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L104) |
51
+ | <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:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L92) |
52
+ | <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:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L91) |
53
+ | <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:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L94) |
54
+ | <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:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L93) |
55
+ | <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:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L105) |
56
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L107) |
57
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L106) |
58
+ | <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:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L95) |
59
59
 
60
60
  ## Methods
61
61
 
@@ -65,7 +65,7 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
65
65
  connect(): void;
66
66
  ```
67
67
 
68
- Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L126)
68
+ Defined in: [play-router/src/router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L131)
69
69
 
70
70
  Connect the router bridge to the Actor.
71
71
 
@@ -97,7 +97,7 @@ Adapters that need custom initial-sync behavior should override
97
97
  disconnect(): void;
98
98
  ```
99
99
 
100
- Defined in: [play-router/src/router-bridge-base.ts:214](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L214)
100
+ Defined in: [play-router/src/router-bridge-base.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L218)
101
101
 
102
102
  Disconnect the router bridge from the Actor.
103
103
 
@@ -119,7 +119,7 @@ Stops signal watching and unregisters framework-specific router listener.
119
119
  protected extractParams(pathname, stateId): Record<string, string>;
120
120
  ```
121
121
 
122
- Defined in: [play-router/src/router-bridge-base.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L322)
122
+ Defined in: [play-router/src/router-bridge-base.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L326)
123
123
 
124
124
  Extract path parameters from URL using the URLPattern API.
125
125
 
@@ -157,7 +157,7 @@ When URLPattern is absent and the route is parameterized
157
157
  protected extractQuery(search): Record<string, string>;
158
158
  ```
159
159
 
160
- Defined in: [play-router/src/router-bridge-base.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L359)
160
+ Defined in: [play-router/src/router-bridge-base.ts:363](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L363)
161
161
 
162
162
  Extract query parameters from URL search string.
163
163
 
@@ -185,7 +185,7 @@ Extracted query parameters or empty object
185
185
  protected getInitialRouterPath(): string | null;
186
186
  ```
187
187
 
188
- Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L49)
188
+ Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L49)
189
189
 
190
190
  Return the router's current pathname so connect() can sync the actor to
191
191
  the URL on initial load. router.subscribe() only fires on future navigations
@@ -208,7 +208,7 @@ the page on /about would leave the actor in its default "home" state.
208
208
  protected getInitialRouterSearch(): string | undefined;
209
209
  ```
210
210
 
211
- Defined in: [play-react-router/src/react-router-bridge.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L60)
211
+ Defined in: [play-react-router/src/react-router-bridge.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L60)
212
212
 
213
213
  Return the initial URL search string for query-param forwarding on `connect()`.
214
214
 
@@ -232,7 +232,7 @@ so `syncActorFromRouter` produces `query: {}` rather than parsing an empty strin
232
232
  protected navigateRouter(path): void;
233
233
  ```
234
234
 
235
- Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L39)
235
+ Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L39)
236
236
 
237
237
  Navigate the framework router to the given path.
238
238
 
@@ -261,7 +261,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
261
261
  protected resolveNavigationPath(route): string | null;
262
262
  ```
263
263
 
264
- Defined in: [play-router/src/router-bridge-base.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L344)
264
+ Defined in: [play-router/src/router-bridge-base.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L348)
265
265
 
266
266
  Resolve an actor route value to a concrete URL path for navigation.
267
267
 
@@ -300,11 +300,11 @@ Concrete URL path, or `null` if navigation should be skipped
300
300
  protected syncActorFromRouter(pathname, search?): void;
301
301
  ```
302
302
 
303
- Defined in: [play-router/src/router-bridge-base.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L264)
303
+ Defined in: [play-router/src/router-bridge-base.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L268)
304
304
 
305
305
  Sync actor state when router location changes.
306
306
 
307
- Sends play.route event to actor with resolved stateId, params, and query.
307
+ Sends play.route event to actor with matched stateId, params, and query.
308
308
  Prevents circular updates via isProcessingNavigation flag.
309
309
 
310
310
  #### Parameters
@@ -330,7 +330,7 @@ Prevents circular updates via isProcessingNavigation flag.
330
330
  protected syncRouterFromActor(route): void;
331
331
  ```
332
332
 
333
- Defined in: [play-router/src/router-bridge-base.ts:244](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/router-bridge-base.ts#L244)
333
+ Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/router-bridge-base.ts#L248)
334
334
 
335
335
  Sync router location when actor route signal changes.
336
336
 
@@ -363,7 +363,7 @@ suppressed as circular echoes.
363
363
  protected unwatchRouterChanges(): void;
364
364
  ```
365
365
 
366
- Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L70)
366
+ Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L70)
367
367
 
368
368
  Stop watching for router location changes.
369
369
 
@@ -385,7 +385,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
385
385
  protected watchRouterChanges(): void;
386
386
  ```
387
387
 
388
- Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/react-router-bridge.ts#L64)
388
+ Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/react-router-bridge.ts#L64)
389
389
 
390
390
  Start watching for router location changes.
391
391
 
@@ -2,15 +2,45 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/route-map.ts#L12)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
- Bidirectional route mapper for React Router.
7
+ Shared bidirectional route map base class.
8
8
 
9
- Alias for [BaseRouteMap](../../play-dom-router/interfaces/RouteMap.md) from `@xmachines/play-router`.
9
+ All framework adapters use this class as their route map — they add no logic of their
10
+ own and inherit the full public API from here.
10
11
 
11
- ## Extends
12
+ **Lookup strategy:**
12
13
 
13
- - [`RouteMap`](../../play-dom-router/interfaces/RouteMap.md)
14
+ - Static paths (no `:param`) → O(1) `Map` lookup
15
+ - Dynamic paths → O(k) bucket-indexed scan using `URLPattern`, where `k` is the number
16
+ of routes sharing the same first path segment
17
+ - Results are cached after the first match in an LRU cache (default 500 entries,
18
+ configurable via the `cacheSize` constructor option)
19
+
20
+ **Pattern syntax** (`:param` / `:param?`):
21
+
22
+ - `:param` — required segment, matches exactly one non-`/` segment
23
+ - `:param?` — optional segment, matches zero or one non-`/` segment
24
+
25
+ ## Example
26
+
27
+ ```typescript
28
+ import { RouteMap } from "@xmachines/play-router";
29
+
30
+ const map = new RouteMap([
31
+ { stateId: "home", path: "/" },
32
+ { stateId: "profile", path: "/profile/:userId" },
33
+ { stateId: "settings", path: "/settings/:section?" },
34
+ ]);
35
+
36
+ map.getStateIdByPath("/"); // "home"
37
+ map.getStateIdByPath("/profile/123"); // "profile"
38
+ map.getStateIdByPath("/settings"); // "settings"
39
+ map.getStateIdByPath("/unknown"); // null
40
+
41
+ map.getPathByStateId("profile"); // "/profile/:userId"
42
+ map.getPathByStateId("missing"); // null
43
+ ```
14
44
 
15
45
  ## Constructors
16
46
 
@@ -20,7 +50,7 @@ Alias for [BaseRouteMap](../../play-dom-router/interfaces/RouteMap.md) from `@xm
20
50
  new RouteMap(mappings, options?): RouteMap;
21
51
  ```
22
52
 
23
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L125)
24
54
 
25
55
  Build a route map from an array of state ID ↔ path mappings.
26
56
 
@@ -40,12 +70,6 @@ buckets for efficient candidate selection.
40
70
 
41
71
  `RouteMap`
42
72
 
43
- #### Inherited from
44
-
45
- ```ts
46
- BaseRouteMap.constructor;
47
- ```
48
-
49
73
  ## Methods
50
74
 
51
75
  ### getPathByStateId()
@@ -54,7 +78,7 @@ BaseRouteMap.constructor;
54
78
  getPathByStateId(stateId): string | null;
55
79
  ```
56
80
 
57
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L209)
58
82
 
59
83
  Look up the path pattern registered for a state ID.
60
84
 
@@ -77,10 +101,6 @@ map.getPathByStateId("profile"); // "/profile/:userId"
77
101
  map.getPathByStateId("missing"); // null
78
102
  ```
79
103
 
80
- #### Inherited from
81
-
82
- [`RouteMap`](../../play-dom-router/interfaces/RouteMap.md).[`getPathByStateId`](../../play-dom-router/interfaces/RouteMap.md#getpathbystateid)
83
-
84
104
  ---
85
105
 
86
106
  ### getStateIdByPath()
@@ -89,7 +109,7 @@ map.getPathByStateId("missing"); // null
89
109
  getStateIdByPath(path): string | null;
90
110
  ```
91
111
 
92
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L174)
93
113
 
94
114
  Resolve a URL path to its mapped state ID.
95
115
 
@@ -115,7 +135,3 @@ The mapped state ID, or `null` if no route matches
115
135
  map.getStateIdByPath("/profile/123"); // "profile"
116
136
  map.getStateIdByPath("/unknown"); // null
117
137
  ```
118
-
119
- #### Inherited from
120
-
121
- [`RouteMap`](../../play-dom-router/interfaces/RouteMap.md).[`getStateIdByPath`](../../play-dom-router/interfaces/RouteMap.md#getstateidbypath)
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/play-router-provider.tsx:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-react-router/src/play-router-provider.tsx#L48)
9
+ Defined in: [play-react-router/src/play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/play-router-provider.tsx#L47)
10
10
 
11
11
  Connects a `PlayerActor` to React Router, keeping actor state and browser URL
12
12
  in sync bidirectionally.
@@ -0,0 +1,21 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / createRouteMap
2
+
3
+ # Function: createRouteMap()
4
+
5
+ ```ts
6
+ function createRouteMap(machine): RouteMap;
7
+ ```
8
+
9
+ Defined in: [play-react-router/src/route-map.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-react-router/src/route-map.ts#L15)
10
+
11
+ Create a [RouteMap](../classes/RouteMap.md) from an XState machine.
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --------- | ------------------------------------------------------------------------- | ------------------------------------------------ |
17
+ | `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 machine with `meta.route` annotations. |
18
+
19
+ ## Returns
20
+
21
+ [`RouteMap`](../classes/RouteMap.md)
@@ -6,9 +6,9 @@
6
6
  function createRouteMapFromTree(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-tree.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.34/packages/play-router/src/create-route-map-from-tree.ts#L31)
9
+ Defined in: [play-router/src/create-route-map-from-tree.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/create-route-map-from-tree.ts#L31)
10
10
 
11
- Create a `BaseRouteMap` from a `RouteTree` node structure.
11
+ Create a `RouteMap` from a `RouteTree` node structure.
12
12
 
13
13
  Used by framework-router adapters (React Router, TanStack Router) that pass a
14
14
  `RouteTree` produced by `extractMachineRoutes()` rather than calling
@@ -16,7 +16,7 @@ Used by framework-router adapters (React Router, TanStack Router) that pass a
16
16
 
17
17
  Traverses all nodes collecting `{ stateId: node.id, path: node.fullPath }` pairs.
18
18
  `node.fullPath` is always the absolute resolved path (e.g. `"/dashboard/overview"`),
19
- which is what `BaseRouteMap` needs for browser URL matching. This matches the
19
+ which is what `RouteMap` needs for browser URL matching. This matches the
20
20
  behaviour of `createRouteMapFromMachine`, which also uses `node.fullPath`.
21
21
 
22
22
  ## Parameters
@@ -27,9 +27,9 @@ behaviour of `createRouteMapFromMachine`, which also uses `node.fullPath`.
27
27
 
28
28
  ## Returns
29
29
 
30
- [`RouteMap`](../../play-dom-router/interfaces/RouteMap.md)
30
+ [`RouteMap`](../classes/RouteMap.md)
31
31
 
32
- A `BaseRouteMap` for use with any `RouterBridgeBase`-based adapter.
32
+ A `RouteMap` for use with any `RouterBridgeBase`-based adapter.
33
33
 
34
34
  ## Example
35
35
 
@@ -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.34/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.35/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.34/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.34/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.34/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.34/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.34/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.35/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.35/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.35/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.35/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.35/packages/play-router/src/types.ts#L224) |