@xmachines/docs 1.0.0-beta.42 → 1.0.0-beta.44

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 (324) hide show
  1. package/api/@xmachines/play/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  3. package/api/@xmachines/play/classes/PlayError.md +4 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  6. package/api/@xmachines/play-actor/README.md +2 -2
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  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 -1
  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 +6 -6
  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 +1 -0
  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 +8 -7
  46. package/api/@xmachines/play-dom-router/functions/createRouter.md +2 -2
  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 +7 -7
  51. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  56. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  57. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  58. package/api/@xmachines/play-react/README.md +1 -1
  59. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  60. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  61. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  62. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  63. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  64. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  65. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  66. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  67. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  68. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  69. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  70. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  71. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  72. package/api/@xmachines/play-react-router/README.md +1 -0
  73. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +33 -29
  74. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  75. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  76. package/api/@xmachines/play-react-router/functions/createRouteMap.md +24 -6
  77. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +11 -10
  78. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  79. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  80. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
  81. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  82. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  83. package/api/@xmachines/play-router/README.md +9 -8
  84. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  85. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +37 -33
  86. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  87. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  88. package/api/@xmachines/play-router/functions/createRouteMap.md +21 -35
  89. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +11 -10
  90. package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
  91. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  92. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  94. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  95. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  96. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  97. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  99. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  100. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  101. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  102. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  103. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  104. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  105. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  106. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  107. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  108. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  110. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  111. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  112. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
  113. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  114. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +8 -8
  116. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  117. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  118. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  119. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  120. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  121. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  122. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  123. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  124. package/api/@xmachines/play-signals/README.md +2 -2
  125. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  126. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  127. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  128. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  129. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  130. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  131. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  132. package/api/@xmachines/play-solid/README.md +1 -1
  133. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  134. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  135. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  136. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  137. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  138. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  139. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  140. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  141. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  142. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  143. package/api/@xmachines/play-solid-router/README.md +2 -1
  144. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +34 -30
  146. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  147. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +8 -7
  148. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  149. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  150. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  151. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
  152. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  153. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  154. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  155. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  156. package/api/@xmachines/play-svelte/README.md +1 -0
  157. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  158. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  159. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  160. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  161. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +12 -8
  162. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  163. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
  164. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  165. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  166. package/api/@xmachines/play-svelte-spa-router/README.md +1 -0
  167. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  168. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  169. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +8 -7
  170. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  171. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  172. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
  173. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  174. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  175. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  176. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  177. package/api/@xmachines/play-sveltekit-router/README.md +1 -0
  178. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  179. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  180. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +8 -7
  181. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  182. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  183. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  184. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
  185. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  186. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  187. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/README.md +1 -0
  189. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  190. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +33 -29
  191. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +24 -6
  193. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +11 -10
  194. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  195. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  196. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  197. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
  198. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  200. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  201. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  202. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  203. package/api/@xmachines/play-tanstack-solid-router/README.md +2 -1
  204. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  205. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +34 -30
  206. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  207. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +8 -7
  208. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  209. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  210. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
  211. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  212. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  213. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  214. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  215. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  216. package/api/@xmachines/play-vue/README.md +2 -1
  217. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  218. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  219. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  220. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  221. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  222. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  223. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
  224. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  225. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  226. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  227. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  228. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  229. package/api/@xmachines/play-vue-router/README.md +2 -1
  230. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  231. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +40 -30
  232. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +25 -5
  233. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  234. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
  235. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  236. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  237. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  238. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  239. package/api/@xmachines/play-xstate/README.md +1 -1
  240. package/api/@xmachines/play-xstate/classes/PlayerActor.md +13 -13
  241. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  242. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  243. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  244. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +4 -2
  245. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  246. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  247. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  248. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  249. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  250. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  252. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  253. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  254. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  255. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  256. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  257. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  258. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  259. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  260. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  261. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  262. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  263. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  264. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  265. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  266. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  267. package/api/llms.txt +2 -2
  268. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  270. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  271. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  272. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  273. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  274. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  275. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  276. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  277. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  278. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  279. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  280. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  281. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  282. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  283. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  284. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  287. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  288. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  289. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  290. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  291. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  292. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  293. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  294. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  295. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  296. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  297. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  298. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  299. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  304. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  305. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  306. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  307. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  308. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  309. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  310. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  311. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  312. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  313. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  314. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  315. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  316. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  317. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  318. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  319. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  320. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  321. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  322. package/package.json +2 -2
  323. package/rfc/play.md +1 -1
  324. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-sveltekit-router/src/connect-router.ts#L6)
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-sveltekit-router/src/connect-router.ts#L6)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <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) | - | [play-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-sveltekit-router/src/connect-router.ts#L7) |
12
- | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-sveltekit-router/src/connect-router.ts#L13) |
13
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-sveltekit-router/src/connect-router.ts#L8) |
11
+ | <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) | - | [play-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-sveltekit-router/src/connect-router.ts#L7) |
12
+ | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-sveltekit-router/src/connect-router.ts#L13) |
13
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-sveltekit-router/src/connect-router.ts#L8) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/types.ts#L344)
5
+ Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L344)
6
6
 
7
7
  Minimal location interface required by adapters that read the current URL at
8
8
  `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
23
23
 
24
24
  | Property | Modifier | Type | Defined in |
25
25
  | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/types.ts#L345) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/types.ts#L346) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L345) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L346) |
@@ -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.42/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.44/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.42/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.42/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.42/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.42/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.42/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.44/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.44/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.44/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.44/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.44/packages/play-router/src/types.ts#L224) |
@@ -0,0 +1,13 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-sveltekit-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.44/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.44/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/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.44/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.42/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.42/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.44/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.44/packages/play-router/src/base-route-map.ts#L59) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/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.44/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.42/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.44/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.42/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.44/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-sveltekit-router/src/types.ts#L10)
9
+ Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-sveltekit-router/src/types.ts#L10)
@@ -204,6 +204,7 @@ Synchronizes browser URL with actor state through passive infrastructure.
204
204
 
205
205
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
206
206
  - [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
207
+ - [RouteMapOptions](interfaces/RouteMapOptions.md)
207
208
  - [RouteMapping](interfaces/RouteMapping.md)
208
209
  - [RouteNavigateEvent](interfaces/RouteNavigateEvent.md)
209
210
  - [RouterBridge](interfaces/RouterBridge.md)
@@ -2,7 +2,7 @@
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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackReactRouterBridge
4
4
 
5
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L84)
5
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L84)
6
6
 
7
7
  TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
@@ -47,7 +47,7 @@ new TanStackReactRouterBridge(
47
47
  routeMap): TanStackReactRouterBridge;
48
48
  ```
49
49
 
50
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L94)
50
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L94)
51
51
 
52
52
  Create TanStack React Router bridge
53
53
 
@@ -69,17 +69,17 @@ Create TanStack React Router bridge
69
69
 
70
70
  ## Properties
71
71
 
72
- | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
73
- | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74
- | <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.42/packages/play-router/src/router-bridge-base.ts#L104) |
75
- | <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.42/packages/play-router/src/router-bridge-base.ts#L92) |
76
- | <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.42/packages/play-router/src/router-bridge-base.ts#L91) |
77
- | <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.42/packages/play-router/src/router-bridge-base.ts#L94) |
78
- | <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.42/packages/play-router/src/router-bridge-base.ts#L93) |
79
- | <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.42/packages/play-router/src/router-bridge-base.ts#L105) |
80
- | `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.42/packages/play-router/src/router-bridge-base.ts#L107) |
81
- | `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.42/packages/play-router/src/router-bridge-base.ts#L106) |
82
- | <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.42/packages/play-router/src/router-bridge-base.ts#L95) |
72
+ | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
73
+ | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L126) |
75
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L104) |
76
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L103) |
77
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L116) |
78
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L105) |
79
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L127) |
80
+ | `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.44/packages/play-router/src/router-bridge-base.ts#L129) |
81
+ | `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.44/packages/play-router/src/router-bridge-base.ts#L128) |
82
+ | <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.44/packages/play-router/src/router-bridge-base.ts#L117) |
83
83
 
84
84
  ## Methods
85
85
 
@@ -89,7 +89,7 @@ Create TanStack React Router bridge
89
89
  connect(): void;
90
90
  ```
91
91
 
92
- Defined in: [play-router/src/router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L131)
92
+ Defined in: [play-router/src/router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L153)
93
93
 
94
94
  Connect the router bridge to the Actor.
95
95
 
@@ -121,7 +121,7 @@ Adapters that need custom initial-sync behavior should override
121
121
  disconnect(): void;
122
122
  ```
123
123
 
124
- Defined in: [play-router/src/router-bridge-base.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L218)
124
+ Defined in: [play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L249)
125
125
 
126
126
  Disconnect the router bridge from the Actor.
127
127
 
@@ -143,7 +143,7 @@ Stops signal watching and unregisters framework-specific router listener.
143
143
  protected extractParams(pathname, stateId): Record<string, string>;
144
144
  ```
145
145
 
146
- Defined in: [play-router/src/router-bridge-base.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L326)
146
+ Defined in: [play-router/src/router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L373)
147
147
 
148
148
  Extract path parameters from URL using the URLPattern API.
149
149
 
@@ -181,7 +181,7 @@ When URLPattern is absent and the route is parameterized
181
181
  protected extractQuery(search): Record<string, string>;
182
182
  ```
183
183
 
184
- Defined in: [play-router/src/router-bridge-base.ts:363](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L363)
184
+ Defined in: [play-router/src/router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L410)
185
185
 
186
186
  Extract query parameters from URL search string.
187
187
 
@@ -209,7 +209,7 @@ Extracted query parameters or empty object
209
209
  protected getInitialRouterPath(): string | null;
210
210
  ```
211
211
 
212
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L128)
212
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L128)
213
213
 
214
214
  Read the router's current pathname for initial sync.
215
215
 
@@ -244,7 +244,7 @@ The base class `connect()` uses `actor.initialRoute` to distinguish:
244
244
  protected getInitialRouterSearch(): string | undefined;
245
245
  ```
246
246
 
247
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L144)
247
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L144)
248
248
 
249
249
  Return the initial URL search string for query-param forwarding on `connect()`.
250
250
 
@@ -269,7 +269,7 @@ so `syncActorFromRouter` produces `query: {}` rather than parsing an empty strin
269
269
  protected navigateRouter(path): void;
270
270
  ```
271
271
 
272
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L106)
272
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L106)
273
273
 
274
274
  Navigate the framework router to the given path.
275
275
 
@@ -298,7 +298,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
298
298
  protected resolveNavigationPath(route): string | null;
299
299
  ```
300
300
 
301
- Defined in: [play-router/src/router-bridge-base.ts:348](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L348)
301
+ Defined in: [play-router/src/router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L395)
302
302
 
303
303
  Resolve an actor route value to a concrete URL path for navigation.
304
304
 
@@ -337,7 +337,7 @@ Concrete URL path, or `null` if navigation should be skipped
337
337
  protected syncActorFromRouter(pathname, search?): void;
338
338
  ```
339
339
 
340
- Defined in: [play-router/src/router-bridge-base.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L268)
340
+ Defined in: [play-router/src/router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L315)
341
341
 
342
342
  Sync actor state when router location changes.
343
343
 
@@ -367,16 +367,20 @@ Prevents circular updates via isProcessingNavigation flag.
367
367
  protected syncRouterFromActor(route): void;
368
368
  ```
369
369
 
370
- Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/router-bridge-base.ts#L248)
370
+ Defined in: [play-router/src/router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/router-bridge-base.ts#L290)
371
371
 
372
372
  Sync router location when actor route signal changes.
373
373
 
374
374
  Calls navigateRouter() for framework-specific navigation.
375
- Prevents circular updates via isProcessingNavigation flag.
376
375
 
377
- `lastSyncedPath` is updated before `navigateRouter()` and the processing flag is
378
- released in a microtask so synchronous router callbacks triggered by navigation are
379
- suppressed as circular echoes.
376
+ Echo suppression preventing the router's own callback from re-driving the
377
+ actor is handled entirely by `lastSyncedPath`: it is set to `route` before
378
+ `navigateRouter()` is called, so any `syncActorFromRouter` invocation for the
379
+ same path short-circuits at the `sanitized === lastSyncedPath` check and sends
380
+ no event regardless of whether the callback fires synchronously or asynchronously.
381
+
382
+ `isProcessingNavigation` is NOT set here — it is only used inside
383
+ `syncActorFromRouter` to guard against re-entrant guard-redirect loops.
380
384
 
381
385
  #### Parameters
382
386
 
@@ -400,7 +404,7 @@ suppressed as circular echoes.
400
404
  protected unwatchRouterChanges(): void;
401
405
  ```
402
406
 
403
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L166)
407
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L166)
404
408
 
405
409
  Stop watching for router location changes.
406
410
 
@@ -422,7 +426,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
422
426
  protected watchRouterChanges(): void;
423
427
  ```
424
428
 
425
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L157)
429
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L157)
426
430
 
427
431
  Subscribe to ALL navigation events via router.history.
428
432
 
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-react-router/src/play-router-provider.tsx#L67)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-tanstack-react-router/src/play-router-provider.tsx#L67)
10
10
 
11
11
  Connects a `PlayerActor` to TanStack React Router, keeping actor state and
12
12
  browser URL in sync bidirectionally.
@@ -3,19 +3,37 @@
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-tanstack-react-router/src/route-map.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-tanstack-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.44/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
+ ```
@@ -3,27 +3,28 @@
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.42/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.44/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)
@@ -6,7 +6,7 @@
6
6
  function extractMachineRoutes(machine): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-router/src/extract-routes.ts#L93)
9
+ Defined in: [play-router/src/extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/extract-routes.ts#L93)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
@@ -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.42/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.44/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.42/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.42/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.42/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.42/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.42/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.44/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.44/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.44/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.44/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.44/packages/play-router/src/types.ts#L224) |