@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
package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/PlayUIProvider.tsx#L34)
5
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/PlayUIProvider.tsx#L34)
6
6
 
7
7
  Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own props.
8
8
 
@@ -14,13 +14,13 @@ Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own p
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L154) |
18
- | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/ActorProvider.tsx#L37) |
19
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/ActorProvider.tsx#L33) |
17
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L154) |
18
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/ActorProvider.tsx#L37) |
19
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/ActorProvider.tsx#L33) |
20
20
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
21
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/ActorProvider.tsx#L35) |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L167) |
24
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L156) |
25
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L162) |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/ActorProvider.tsx#L35) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L167) |
24
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L156) |
25
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L162) |
26
26
  | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
package/api/@xmachines/play-react/interfaces/ViewContextValue.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-react/src/ActorProvider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/ActorProvider.tsx#L45)
5
+ Defined in: [packages/play-react/src/ActorProvider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/ActorProvider.tsx#L45)
6
6
 
7
7
  Value provided by ViewContext (accessible via usePlayView()).
8
8
 
@@ -14,7 +14,7 @@ Value provided by ViewContext (accessible via usePlayView()).
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L122) |
18
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L124) |
19
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L120) |
20
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-actor/src/abstract-actor.ts#L126) |
17
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L122) |
18
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L124) |
19
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L120) |
20
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-actor/src/abstract-actor.ts#L126) |
package/api/@xmachines/play-react/type-aliases/PlayActor.md CHANGED
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/useActor.ts#L27)
9
+ Defined in: [packages/play-react/src/useActor.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/useActor.ts#L27)
package/api/@xmachines/play-react/variables/ActorProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: React.FC<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/ActorProvider.tsx:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/ActorProvider.tsx#L151)
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/ActorProvider.tsx#L168)
10
10
 
11
11
  ActorProvider — escape hatch primitive for composing actor lifecycle with custom providers.
12
12
 
package/api/@xmachines/play-react/variables/PlayRenderer.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: React.FC<Record<string, never>>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayRenderer.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/PlayRenderer.tsx#L39)
9
+ Defined in: [packages/play-react/src/PlayRenderer.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/PlayRenderer.tsx#L39)
10
10
 
11
11
  Zero-prop leaf component that renders the current actor view.
12
12
 
package/api/@xmachines/play-react/variables/PlayUIProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayUIProvider: React.FC<PlayUIProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/packages/play-react/src/PlayUIProvider.tsx#L102)
9
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-react/src/PlayUIProvider.tsx#L102)
10
10
 
11
11
  PlayUIProvider — batteries-included entry point for actor-driven UI rendering.
12
12
 
package/api/@xmachines/play-react-router/README.md CHANGED
@@ -193,6 +193,7 @@ Synchronizes browser URL with actor state using createBrowserRouter data API.
193
193
 
194
194
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
195
195
  - [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
196
+ - [RouteMapOptions](interfaces/RouteMapOptions.md)
196
197
  - [RouteMapping](interfaces/RouteMapping.md)
197
198
  - [RouterBridge](interfaces/RouterBridge.md)
198
199
 
package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReactRouterBridge
4
4
 
5
- Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/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.44/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.42/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.44/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.42/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.42/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.42/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.42/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.42/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.42/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.42/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.42/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.42/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.44/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.44/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.44/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.44/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.44/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.44/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.44/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.44/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/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.42/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.44/packages/play-react-router/src/react-router-bridge.ts#L64)
389
393
 
390
394
  Start watching for router location changes.
391
395
 
package/api/@xmachines/play-react-router/classes/RouteMap.md CHANGED
@@ -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
 
package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md CHANGED
@@ -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.42/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.44/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.
package/api/@xmachines/play-react-router/functions/createRouteMap.md CHANGED
@@ -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-react-router/src/route-map.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.42/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.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
+ ```
package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md CHANGED
@@ -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)
package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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) |
package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -2,7 +2,7 @@
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.42/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.44/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.42/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.42/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.42/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.42/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.44/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.44/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.44/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.44/packages/play-react-router/src/play-router-provider.tsx#L21) |