@xmachines/docs 1.0.0-beta.43 → 1.0.0-beta.45

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 (432) hide show
  1. package/api/@xmachines/play/README.md +5 -5
  2. package/api/@xmachines/play/classes/NonNullableError.md +5 -5
  3. package/api/@xmachines/play/classes/PlayError.md +5 -5
  4. package/api/@xmachines/play/functions/assertNonNullable.md +2 -2
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  6. package/api/@xmachines/play-actor/README.md +7 -7
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +2 -2
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +6 -6
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +6 -6
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  14. package/api/@xmachines/play-dom/README.md +3 -2
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +5 -5
  16. package/api/@xmachines/play-dom/functions/connectRenderer.md +2 -2
  17. package/api/@xmachines/play-dom/functions/createPlayUI.md +2 -2
  18. package/api/@xmachines/play-dom/functions/createRenderer.md +2 -2
  19. package/api/@xmachines/play-dom/functions/defineRegistry.md +2 -2
  20. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  21. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +8 -8
  22. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +14 -14
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +5 -5
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -13
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +4 -4
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  29. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
  30. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +2 -2
  31. package/api/@xmachines/play-dom/type-aliases/Actions.md +2 -2
  32. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +8 -8
  33. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +3 -3
  37. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +2 -2
  38. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +2 -2
  40. package/api/@xmachines/play-dom/type-aliases/MountFn.md +2 -2
  41. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/SetState.md +2 -2
  43. package/api/@xmachines/play-dom/variables/schema.md +2 -2
  44. package/api/@xmachines/play-dom-router/README.md +13 -11
  45. package/api/@xmachines/play-dom-router/functions/connectRouter.md +2 -2
  46. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +2 -2
  47. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +9 -8
  48. package/api/@xmachines/play-dom-router/functions/createRouter.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +15 -15
  51. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +5 -5
  52. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
  53. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +4 -4
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
  58. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
  59. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +2 -2
  60. package/api/@xmachines/play-react/README.md +10 -4
  61. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  62. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  63. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  65. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  69. package/api/@xmachines/play-react/functions/useActor.md +2 -2
  70. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  71. package/api/@xmachines/play-react/functions/usePlayView.md +2 -2
  72. package/api/@xmachines/play-react/functions/useSignalEffect.md +2 -2
  73. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  74. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +9 -9
  75. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +5 -5
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +9 -9
  80. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  81. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +6 -6
  84. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/PlayActor.md +2 -2
  87. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  88. package/api/@xmachines/play-react/variables/ActorProvider.md +2 -2
  89. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  90. package/api/@xmachines/play-react/variables/PlayUIProvider.md +2 -2
  91. package/api/@xmachines/play-react-router/README.md +13 -7
  92. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -30
  93. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
  94. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +2 -2
  95. package/api/@xmachines/play-react-router/functions/createRouteMap.md +25 -7
  96. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +12 -11
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
  98. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +8 -8
  99. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
  100. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
  101. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
  102. package/api/@xmachines/play-router/README.md +14 -13
  103. package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
  104. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +38 -34
  105. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  106. package/api/@xmachines/play-router/functions/buildRouteTree.md +2 -2
  107. package/api/@xmachines/play-router/functions/createRouteMap.md +22 -36
  108. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +12 -11
  109. package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
  110. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +2 -2
  111. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
  112. package/api/@xmachines/play-router/functions/extractQuery.md +2 -2
  113. package/api/@xmachines/play-router/functions/extractRouteParams.md +2 -2
  114. package/api/@xmachines/play-router/functions/findRouteById.md +2 -2
  115. package/api/@xmachines/play-router/functions/findRouteByPath.md +2 -2
  116. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +2 -2
  117. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +2 -2
  118. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +2 -2
  119. package/api/@xmachines/play-router/functions/isRouteReachable.md +2 -2
  120. package/api/@xmachines/play-router/functions/machineToGraph.md +2 -2
  121. package/api/@xmachines/play-router/functions/routeExists.md +2 -2
  122. package/api/@xmachines/play-router/functions/sanitizePathname.md +2 -2
  123. package/api/@xmachines/play-router/functions/validateRouteFormat.md +2 -2
  124. package/api/@xmachines/play-router/functions/validateStateExists.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/LocationLike.md +4 -4
  127. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +4 -4
  128. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +6 -6
  129. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  130. package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
  131. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
  132. package/api/@xmachines/play-router/interfaces/RouteMapping.md +4 -4
  133. package/api/@xmachines/play-router/interfaces/RouteMatch.md +4 -4
  134. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +9 -9
  135. package/api/@xmachines/play-router/interfaces/RouteNode.md +13 -13
  136. package/api/@xmachines/play-router/interfaces/RouteObject.md +3 -3
  137. package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
  138. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouterBridge.md +5 -5
  140. package/api/@xmachines/play-router/interfaces/WindowLike.md +4 -4
  141. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +2 -2
  142. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
  143. package/api/@xmachines/play-signals/README.md +3 -3
  144. package/api/@xmachines/play-signals/functions/watchSignal.md +2 -2
  145. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +3 -3
  146. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
  147. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +3 -3
  148. package/api/@xmachines/play-signals/interfaces/SignalState.md +4 -4
  149. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +5 -5
  150. package/api/@xmachines/play-signals/namespaces/Signal/README.md +1 -1
  151. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +1 -1
  152. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +1 -1
  153. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  154. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md +1 -1
  155. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +1 -1
  156. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  167. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +2 -2
  168. package/api/@xmachines/play-solid/README.md +11 -5
  169. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  170. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  171. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  172. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  173. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  174. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  176. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  177. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useActor.md +2 -2
  179. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  183. package/api/@xmachines/play-solid/functions/usePlayView.md +2 -2
  184. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  188. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  189. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +9 -9
  190. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  191. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  192. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +9 -9
  194. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  196. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +6 -6
  198. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  199. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  200. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +2 -2
  201. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  204. package/api/@xmachines/play-solid/variables/ActorContext.md +2 -2
  205. package/api/@xmachines/play-solid/variables/ActorProvider.md +2 -2
  206. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  207. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +2 -2
  208. package/api/@xmachines/play-solid-router/README.md +18 -13
  209. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
  210. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +35 -31
  211. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
  212. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +9 -8
  213. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
  214. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
  215. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  216. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
  217. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
  218. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
  219. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +2 -2
  220. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +5 -5
  221. package/api/@xmachines/play-svelte/README.md +9 -2
  222. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  223. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  224. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +2 -2
  225. package/api/@xmachines/play-svelte/functions/setActorContext.md +2 -2
  226. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +13 -9
  227. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  228. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  229. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +5 -5
  230. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
  231. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +6 -6
  232. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  233. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  234. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  235. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +2 -2
  236. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  237. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  239. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  240. package/api/@xmachines/play-svelte-spa-router/README.md +7 -1
  241. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
  242. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +2 -2
  243. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +9 -8
  244. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
  245. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +4 -4
  250. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +2 -2
  251. package/api/@xmachines/play-sveltekit-router/README.md +8 -2
  252. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
  253. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +2 -2
  254. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +9 -8
  255. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +5 -5
  256. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +4 -4
  257. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
  258. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
  259. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
  261. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
  262. package/api/@xmachines/play-tanstack-react-router/README.md +15 -9
  263. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
  264. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +34 -30
  265. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
  266. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +25 -7
  267. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +12 -11
  268. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
  269. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
  270. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +8 -8
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +4 -4
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
  275. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
  276. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  277. package/api/@xmachines/play-tanstack-solid-router/README.md +17 -11
  278. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
  279. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -31
  280. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
  281. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +9 -8
  282. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
  283. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  284. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
  285. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
  286. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
  287. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +2 -2
  288. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +2 -2
  289. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-vue/README.md +12 -6
  291. package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
  292. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +2 -2
  293. package/api/@xmachines/play-vue/functions/useActor.md +2 -2
  294. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  295. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  296. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  297. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  298. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  299. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  300. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  301. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  302. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  303. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  304. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +6 -6
  305. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
  306. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +2 -2
  307. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  308. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +2 -2
  309. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +3 -3
  310. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +2 -2
  311. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  312. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  313. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  314. package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
  315. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  316. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  317. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  318. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  319. package/api/@xmachines/play-vue-router/README.md +18 -13
  320. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  321. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +41 -31
  322. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +26 -6
  323. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
  324. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
  325. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  326. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +5 -5
  327. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +2 -2
  328. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +2 -2
  329. package/api/@xmachines/play-xstate/README.md +11 -11
  330. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  331. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +2 -2
  332. package/api/@xmachines/play-xstate/functions/composeGuards.md +2 -2
  333. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +2 -2
  334. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +5 -3
  335. package/api/@xmachines/play-xstate/functions/definePlayer.md +3 -3
  336. package/api/@xmachines/play-xstate/functions/deriveRoute.md +3 -3
  337. package/api/@xmachines/play-xstate/functions/eventMatches.md +2 -2
  338. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +2 -2
  339. package/api/@xmachines/play-xstate/functions/hasContext.md +2 -2
  340. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
  341. package/api/@xmachines/play-xstate/functions/negateGuard.md +2 -2
  342. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  343. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +3 -3
  344. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  345. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +6 -6
  346. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +2 -2
  347. package/api/@xmachines/play-xstate/type-aliases/Guard.md +2 -2
  348. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +2 -2
  349. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +2 -2
  350. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +5 -5
  351. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +5 -5
  352. package/api/@xmachines/shared/README.md +1 -1
  353. package/api/@xmachines/shared/vite-aliases/README.md +1 -1
  354. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  355. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +2 -2
  356. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +2 -2
  357. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  358. package/api/@xmachines/shared/vitest/README.md +1 -1
  359. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +2 -2
  360. package/api/llms.txt +2 -2
  361. package/examples/@xmachines/play-dom-demo/README.md +4 -4
  362. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
  363. package/examples/@xmachines/play-dom-demo/functions/initShell.md +2 -2
  364. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +2 -2
  365. package/examples/@xmachines/play-dom-demo/variables/About.md +2 -2
  366. package/examples/@xmachines/play-dom-demo/variables/Contact.md +2 -2
  367. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +2 -2
  368. package/examples/@xmachines/play-dom-demo/variables/Home.md +2 -2
  369. package/examples/@xmachines/play-dom-demo/variables/Login.md +2 -2
  370. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +2 -2
  371. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +2 -2
  372. package/examples/@xmachines/play-dom-demo/variables/Overview.md +2 -2
  373. package/examples/@xmachines/play-dom-demo/variables/Profile.md +2 -2
  374. package/examples/@xmachines/play-dom-demo/variables/Settings.md +2 -2
  375. package/examples/@xmachines/play-dom-demo/variables/Stats.md +2 -2
  376. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +2 -2
  377. package/examples/@xmachines/play-dom-router-demo/README.md +5 -5
  378. package/examples/@xmachines/play-react-demo/README.md +4 -4
  379. package/examples/@xmachines/play-react-demo/functions/App.md +2 -2
  380. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +2 -2
  381. package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
  382. package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
  383. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
  384. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +2 -2
  385. package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
  386. package/examples/@xmachines/play-react-demo/variables/Login.md +2 -2
  387. package/examples/@xmachines/play-react-demo/variables/NavBar.md +2 -2
  388. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +2 -2
  389. package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
  390. package/examples/@xmachines/play-react-demo/variables/Overview.md +2 -2
  391. package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
  392. package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
  393. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -2
  394. package/examples/@xmachines/play-react-demo/variables/Stats.md +2 -2
  395. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +2 -2
  396. package/examples/@xmachines/play-react-router-demo/README.md +4 -4
  397. package/examples/@xmachines/play-solid-demo/README.md +4 -4
  398. package/examples/@xmachines/play-solid-demo/functions/App.md +2 -2
  399. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +2 -2
  400. package/examples/@xmachines/play-solid-demo/variables/About.md +2 -2
  401. package/examples/@xmachines/play-solid-demo/variables/Contact.md +2 -2
  402. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +2 -2
  403. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +2 -2
  404. package/examples/@xmachines/play-solid-demo/variables/Home.md +2 -2
  405. package/examples/@xmachines/play-solid-demo/variables/Login.md +2 -2
  406. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +2 -2
  407. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +2 -2
  408. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +2 -2
  409. package/examples/@xmachines/play-solid-demo/variables/Overview.md +2 -2
  410. package/examples/@xmachines/play-solid-demo/variables/Profile.md +2 -2
  411. package/examples/@xmachines/play-solid-demo/variables/Settings.md +2 -2
  412. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -2
  413. package/examples/@xmachines/play-solid-demo/variables/Stats.md +2 -2
  414. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +2 -2
  415. package/examples/@xmachines/play-solid-router-demo/README.md +5 -5
  416. package/examples/@xmachines/play-svelte-demo/README.md +3 -3
  417. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  418. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +2 -2
  419. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  420. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +2 -2
  421. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +4 -4
  422. package/examples/@xmachines/play-sveltekit-router-demo/README.md +4 -4
  423. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +5 -5
  424. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +6 -6
  425. package/examples/@xmachines/play-vue-demo/README.md +4 -4
  426. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +2 -2
  427. package/examples/@xmachines/play-vue-demo/variables/App.md +2 -2
  428. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +2 -2
  429. package/examples/@xmachines/play-vue-router-demo/README.md +4 -4
  430. package/package.json +2 -2
  431. package/rfc/play.md +1 -1
  432. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
@@ -1,4 +1,4 @@
1
- [Documentation](../../README.md) / @xmachines/play-react-router
1
+ [API](../../README.md) / @xmachines/play-react-router
2
2
 
3
3
  # @xmachines/play-react-router
4
4
 
@@ -14,7 +14,7 @@ The package provides:
14
14
  - `PlayRouterProvider` for React lifecycle wiring
15
15
  - `RouteMap` utilities for state ID <-> URL path resolution
16
16
 
17
- Internally, `ReactRouterBridge` extends `RouterBridgeBase` from `@xmachines/play-router`, so behavior matches other bridge adapters in the monorepo.
17
+ Internally, `ReactRouterBridge` extends `RouterBridgeBase` from, so behavior matches other bridge adapters in the monorepo.
18
18
 
19
19
  ## Installation
20
20
 
@@ -36,7 +36,7 @@ Peer dependencies:
36
36
  - `react` `^18 || ^19`
37
37
  - `react-router` `^7.0.0`
38
38
 
39
- Use `@xmachines/play-react` for framework-native rendering (`PlayRenderer`).
39
+ Use).
40
40
 
41
41
  ## Quick Start
42
42
 
@@ -103,7 +103,7 @@ interface PlayRouterProviderProps {
103
103
 
104
104
  ### `RouteMap` and `createRouteMapFromTree`
105
105
 
106
- `RouteMap` extends `BaseRouteMap` from `@xmachines/play-router`, inheriting bucket-indexed
106
+ `RouteMap` extends `BaseRouteMap` from, inheriting bucket-indexed
107
107
  bidirectional route matching. No routing logic lives in the adapter itself.
108
108
 
109
109
  ```ts
@@ -168,9 +168,14 @@ This keeps infrastructure passive and preserves Actor Authority.
168
168
 
169
169
  ## Related Packages
170
170
 
171
- - [@xmachines/play-router](../play-router)
172
- - [@xmachines/play-xstate](../play-xstate)
173
- - [@xmachines/play-react](../play-react)
171
+ - [@xmachines/play-router](../play-router/README.md)
172
+ - [@xmachines/play-xstate](../play-xstate/README.md)
173
+ - [@xmachines/play-react](../play-react/README.md)
174
+
175
+ ## Learn More
176
+
177
+ - [Demo](../../../examples/@xmachines/play-react-router-demo/README.md)
178
+ - [React renderer](../play-react/README.md)
174
179
 
175
180
  ## License
176
181
 
@@ -193,6 +198,7 @@ Synchronizes browser URL with actor state using createBrowserRouter data API.
193
198
 
194
199
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
195
200
  - [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
201
+ - [RouteMapOptions](interfaces/RouteMapOptions.md)
196
202
  - [RouteMapping](interfaces/RouteMapping.md)
197
203
  - [RouterBridge](interfaces/RouterBridge.md)
198
204
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / ReactRouterBridge
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / ReactRouterBridge
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.43/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.45/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.43/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.45/packages/play-react-router/src/react-router-bridge.ts#L31)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -45,17 +45,17 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
45
45
 
46
46
  ## Properties
47
47
 
48
- | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
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:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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.43/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.43/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.43/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.43/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.43/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.43/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.43/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.43/packages/play-router/src/router-bridge-base.ts#L95) |
48
+ | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
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:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L126) |
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:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L104) |
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:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L103) |
53
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L116) |
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:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L105) |
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(machine)` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L127) |
56
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L129) |
57
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L128) |
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:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L117) |
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:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L131)
68
+ Defined in: [play-router/src/router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L153)
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:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L218)
100
+ Defined in: [play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L249)
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:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L326)
122
+ Defined in: [play-router/src/router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L373)
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:363](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L363)
160
+ Defined in: [play-router/src/router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L410)
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.43/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.45/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.43/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.45/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.43/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.45/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:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L348)
264
+ Defined in: [play-router/src/router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L395)
265
265
 
266
266
  Resolve an actor route value to a concrete URL path for navigation.
267
267
 
@@ -300,7 +300,7 @@ 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:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L268)
303
+ Defined in: [play-router/src/router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L315)
304
304
 
305
305
  Sync actor state when router location changes.
306
306
 
@@ -330,16 +330,20 @@ 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:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/router-bridge-base.ts#L248)
333
+ Defined in: [play-router/src/router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L290)
334
334
 
335
335
  Sync router location when actor route signal changes.
336
336
 
337
337
  Calls navigateRouter() for framework-specific navigation.
338
- Prevents circular updates via isProcessingNavigation flag.
339
338
 
340
- `lastSyncedPath` is updated before `navigateRouter()` and the processing flag is
341
- released in a microtask so synchronous router callbacks triggered by navigation are
342
- suppressed as circular echoes.
339
+ Echo suppression preventing the router's own callback from re-driving the
340
+ actor is handled entirely by `lastSyncedPath`: it is set to `route` before
341
+ `navigateRouter()` is called, so any `syncActorFromRouter` invocation for the
342
+ same path short-circuits at the `sanitized === lastSyncedPath` check and sends
343
+ no event regardless of whether the callback fires synchronously or asynchronously.
344
+
345
+ `isProcessingNavigation` is NOT set here — it is only used inside
346
+ `syncActorFromRouter` to guard against re-entrant guard-redirect loops.
343
347
 
344
348
  #### Parameters
345
349
 
@@ -363,7 +367,7 @@ suppressed as circular echoes.
363
367
  protected unwatchRouterChanges(): void;
364
368
  ```
365
369
 
366
- Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/react-router-bridge.ts#L70)
370
+ Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/react-router-bridge.ts#L70)
367
371
 
368
372
  Stop watching for router location changes.
369
373
 
@@ -385,7 +389,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
385
389
  protected watchRouterChanges(): void;
386
390
  ```
387
391
 
388
- Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/react-router-bridge.ts#L64)
392
+ Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/react-router-bridge.ts#L64)
389
393
 
390
394
  Start watching for router location changes.
391
395
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouteMap
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouteMap
2
2
 
3
3
  # Class: RouteMap
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.43/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.45/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): RouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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.45/packages/play-router/src/base-route-map.ts#L125)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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.45/packages/play-router/src/base-route-map.ts#L209)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/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.45/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayRouterProvider
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayRouterProvider
2
2
 
3
3
  # Function: PlayRouterProvider()
4
4
 
@@ -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:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/play-router-provider.tsx#L47)
9
+ Defined in: [play-react-router/src/play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/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.
@@ -1,21 +1,39 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / createRouteMap
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / createRouteMap
2
2
 
3
3
  # Function: createRouteMap()
4
4
 
5
5
  ```ts
6
- function createRouteMap(machine): RouteMap;
6
+ function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/route-map.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/route-map.ts#L15)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
- Create a [RouteMap](../classes/RouteMap.md) from an XState machine.
11
+ Create a `RouteMap` from an XState state machine.
12
+
13
+ Extracts all routable states (those with `meta.route`) and builds a bidirectional
14
+ path ↔ stateId lookup structure. The returned map is used by `RouterBridgeBase`
15
+ subclasses to translate browser URL changes into `play.route` actor events and
16
+ vice-versa.
12
17
 
13
18
  ## Parameters
14
19
 
15
- | Parameter | Type | Description |
16
- | --------- | ------------------------------------------------------------------------- | ------------------------------------------------ |
17
- | `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 machine with `meta.route` annotations. |
20
+ | Parameter | Type | Description |
21
+ | ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
22
+ | `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states. |
23
+ | `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | Optional configuration. Pass `{ cacheSize }` to override the default LRU cache size for parameterized path lookups. |
18
24
 
19
25
  ## Returns
20
26
 
21
27
  [`RouteMap`](../classes/RouteMap.md)
28
+
29
+ A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
30
+
31
+ ## Example
32
+
33
+ ```typescript
34
+ import { createRouteMap } from "@xmachines/play-router";
35
+ import { connectRouter } from "@xmachines/play-dom-router";
36
+
37
+ const routeMap = createRouteMap(myMachine);
38
+ const disconnect = connectRouter({ actor, router, routeMap });
39
+ ```
@@ -1,29 +1,30 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / createRouteMapFromTree
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / createRouteMapFromTree
2
2
 
3
3
  # Function: createRouteMapFromTree()
4
4
 
5
5
  ```ts
6
- function createRouteMapFromTree(routeTree): RouteMap;
6
+ function createRouteMapFromTree(routeTree, options?): 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.43/packages/play-router/src/create-route-map-from-tree.ts#L31)
9
+ Defined in: [play-router/src/create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map-from-tree.ts#L33)
10
10
 
11
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
15
- `createRouteMapFromMachine()` directly.
15
+ `createRouteMap()` directly.
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
19
  which is what `RouteMap` needs for browser URL matching. This matches the
20
- behaviour of `createRouteMapFromMachine`, which also uses `node.fullPath`.
20
+ behaviour of `createRouteMap(machine)`, which also uses `node.fullPath`.
21
21
 
22
22
  ## Parameters
23
23
 
24
- | Parameter | Type | Description |
25
- | ----------- | -------------------------------------------------------- | ------------------------------------------------------ |
26
- | `routeTree` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | A `RouteTree` as returned by `extractMachineRoutes()`. |
24
+ | Parameter | Type | Description |
25
+ | ----------- | -------------------------------------------------------- | ----------------------------------------------------------------------------- |
26
+ | `routeTree` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | A `RouteTree` as returned by `extractMachineRoutes()`. |
27
+ | `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | Optional configuration (e.g. `{ cacheSize }` to override the LRU cache size). |
27
28
 
28
29
  ## Returns
29
30
 
@@ -35,10 +36,10 @@ A `RouteMap` for use with any `RouterBridgeBase`-based adapter.
35
36
 
36
37
  ```typescript
37
38
  // Preferred — single call for XState machines:
38
- import { createRouteMapFromMachine } from "@xmachines/play-router";
39
- const routeMap = createRouteMapFromMachine(machine);
39
+ import { createRouteMap } from "@xmachines/play-router";
40
+ const routeMap = createRouteMap(machine); // takes AnyStateMachine
40
41
 
41
- // Equivalent two-step form used by framework adapters:
42
+ // Two-step form used by framework adapters that work with route trees:
42
43
  import { extractMachineRoutes, createRouteMapFromTree } from "@xmachines/play-router";
43
44
  const routeTree = extractMachineRoutes(machine);
44
45
  const routeMap = createRouteMapFromTree(routeTree); // uses node.fullPath (absolute)
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayRouteEvent
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayRouteEvent
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.43/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.45/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -94,7 +94,7 @@ actor.send(event);
94
94
 
95
95
  ## See
96
96
 
97
- [Play RFC](../../docs/rfc/play.md)
97
+ [Play RFC](../../../../rfc/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -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.43/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.43/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.43/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.43/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.43/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.45/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.45/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.45/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.45/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.45/packages/play-router/src/types.ts#L224) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayRouterProviderProps
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayRouterProviderProps
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/play-router-provider.tsx#L10)
5
+ Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/play-router-provider.tsx#L10)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,9 +12,9 @@ Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.c
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Type | Description | Defined in |
16
- | ----------------------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with React Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | [play-react-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/play-router-provider.tsx#L19) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | Renderer callback receives the same concrete actor type that was passed in. | [play-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/play-router-provider.tsx#L36) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMap(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMap(routeTree), [routeTree]);` | [play-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/play-router-provider.tsx#L34) |
20
- | <a id="property-router"></a> `router` | `Router` | The React Router instance returned by `createBrowserRouter`. | [play-react-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-react-router/src/play-router-provider.tsx#L21) |
15
+ | Property | Type | Description | Defined in |
16
+ | ----------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with React Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | [play-react-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/play-router-provider.tsx#L19) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | Renderer callback receives the same concrete actor type that was passed in. | [play-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/play-router-provider.tsx#L36) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [play-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/play-router-provider.tsx#L34) |
20
+ | <a id="property-router"></a> `router` | `Router` | The React Router instance returned by `createBrowserRouter`. | [play-react-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-react-router/src/play-router-provider.tsx#L21) |
@@ -0,0 +1,13 @@
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouteMapOptions
2
+
3
+ # Interface: RouteMapOptions
4
+
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L9)
6
+
7
+ Options for `createRouteMap` and `createRouteMapFromTree`.
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/create-route-map.ts#L20) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouteMapping
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouteMapping
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L61) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/base-route-map.ts#L59) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouterBridge
1
+ [API](../../../README.md) / [@xmachines/play-react-router](../README.md) / RouterBridge
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
44
44
 
45
45
  ## See
46
46
 
47
- [Play RFC](../../docs/rfc/play.md) - Invariant INV-04
47
+ [Play RFC](../../../../rfc/play.md) - Invariant INV-04
48
48
 
49
49
  ## Methods
50
50
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89