@xmachines/docs 1.0.0-beta.53 → 1.0.0-beta.55

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 (442) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  3. package/api/@xmachines/play/classes/PlayError.md +7 -7
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +2 -0
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  8. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
  9. package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
  10. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  11. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  12. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  14. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  15. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  16. package/api/@xmachines/play-dom/README.md +2 -0
  17. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  18. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  19. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  20. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  21. package/api/@xmachines/play-dom/functions/renderSpec.md +12 -30
  22. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -6
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -15
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -8
  29. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +25 -0
  30. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -5
  31. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  34. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +44 -0
  38. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  45. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  48. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  51. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  52. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  53. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +16 -6
  54. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +7 -3
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +16 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +6 -6
  60. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  61. package/api/@xmachines/play-react/README.md +6 -6
  62. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  63. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  65. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  66. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  70. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  71. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  72. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  73. package/api/@xmachines/play-react/functions/useSignalEffect.md +28 -26
  74. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  75. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  76. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  80. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  81. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  85. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  87. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  89. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  90. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  91. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  92. package/api/@xmachines/play-react-router/README.md +10 -1
  93. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -365
  94. package/api/@xmachines/play-react-router/classes/RouteMap.md +17 -5
  95. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
  96. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  97. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
  98. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  99. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +16 -6
  100. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  102. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  103. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  104. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +6 -6
  105. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  106. package/api/@xmachines/play-react-router/{functions → variables}/PlayRouterProvider.md +6 -6
  107. package/api/@xmachines/play-router/README.md +12 -10
  108. package/api/@xmachines/play-router/classes/RouteMap.md +17 -5
  109. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +9 -345
  110. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  111. package/api/@xmachines/play-router/functions/buildRouteTree.md +11 -1
  112. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  113. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
  114. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +13 -6
  115. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  116. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractRouteParams.md +9 -1
  118. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  119. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  120. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  121. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  122. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +7 -2
  123. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  124. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  125. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  126. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  127. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  128. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  129. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  130. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  131. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  132. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  133. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  134. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +16 -6
  135. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +17 -0
  136. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  137. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  138. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  139. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  140. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  141. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  142. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  143. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  144. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  145. package/api/@xmachines/play-router/interfaces/RouterBridge.md +6 -6
  146. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  147. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  148. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  149. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  150. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -2
  151. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  152. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -2
  153. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  154. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  155. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  156. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  157. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  170. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  171. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  172. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  173. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  174. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  179. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  185. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  189. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  190. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  191. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  192. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  199. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  200. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  201. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  204. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  206. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  207. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  208. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  209. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  210. package/api/@xmachines/play-solid-router/README.md +7 -1
  211. package/api/@xmachines/play-solid-router/classes/RouteMap.md +17 -5
  212. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -360
  213. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
  214. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  215. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  216. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  217. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +16 -6
  218. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
  219. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +17 -7
  220. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  221. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  222. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +6 -6
  223. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
  224. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  225. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  226. package/api/@xmachines/play-solid-router/{functions → variables}/PlayRouterProvider.md +6 -6
  227. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  228. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  229. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  230. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  231. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  232. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  233. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  234. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  235. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  236. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  237. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  239. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  240. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  241. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  242. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  243. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  244. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +17 -5
  245. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  246. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +16 -6
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +6 -6
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  253. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  254. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +17 -5
  255. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  256. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  257. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  258. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  259. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +16 -6
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  261. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  262. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +6 -6
  263. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  264. package/api/@xmachines/play-tanstack-react-router/README.md +7 -1
  265. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +17 -5
  266. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -384
  267. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
  268. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  269. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
  270. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +16 -6
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +6 -6
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +12 -4
  282. package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md +8 -6
  283. package/api/@xmachines/play-tanstack-router/README.md +58 -0
  284. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +131 -0
  285. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
  286. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
  287. package/api/@xmachines/play-tanstack-solid-router/README.md +7 -1
  288. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +17 -5
  289. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +25 -378
  290. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
  291. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +16 -6
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +15 -7
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  298. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +6 -6
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  302. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +30 -7
  303. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
  304. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  305. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  306. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  307. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  308. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  309. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  310. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  311. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  312. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  313. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  314. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  315. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  317. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  318. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  319. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  320. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  321. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  322. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  323. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  324. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  325. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  326. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  327. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  328. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  329. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  330. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  331. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  332. package/api/@xmachines/play-vue-router/classes/RouteMap.md +17 -5
  333. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +6 -395
  334. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  335. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  336. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +16 -6
  337. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  338. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  339. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +6 -6
  340. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  341. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +3 -3
  342. package/api/@xmachines/play-xstate/classes/PlayerActor.md +70 -169
  343. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  344. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  345. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  346. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  347. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  348. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  349. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  350. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  351. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  352. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  353. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  354. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  355. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  356. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  357. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  358. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  359. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  360. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  361. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  362. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  363. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  364. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  365. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  366. package/api/@xmachines/shared/vite-aliases/README.md +1 -0
  367. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +7 -3
  368. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  369. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  370. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +6 -5
  371. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
  372. package/api/@xmachines/shared/vitest/README.md +5 -0
  373. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
  374. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  375. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
  376. package/api/README.md +1 -0
  377. package/api/llms.txt +4 -3
  378. package/contributing/architecture.md +6 -6
  379. package/contributing/configuration.md +1 -16
  380. package/contributing/deployment.md +8 -8
  381. package/contributing/testing.md +4 -4
  382. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  383. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  384. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  385. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  386. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  387. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  388. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  389. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  390. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  397. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  398. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  399. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  400. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  401. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  402. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  403. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  404. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  405. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  406. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  407. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  408. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  414. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  415. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  416. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  417. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  418. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  419. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  420. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  421. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  422. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  423. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  424. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  425. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  426. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  431. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  432. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  433. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  434. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  435. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  436. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  437. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  438. package/guides/README.md +6 -44
  439. package/package.json +6 -3
  440. package/api/@xmachines/play-router/functions/createRouteMatcher.md +0 -53
  441. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +0 -56
  442. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -33
@@ -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.53/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L51)
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.53/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.53/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:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L341)
5
+ Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
9
- Defines the lifecycle connection between Infrastructure (e.g., TanStack Router) and
9
+ Defines the lifecycle connection between Infrastructure (e.g., a framework router) and
10
10
  the Actor. Infrastructure "bridges" to the Actor by observing its signals and
11
11
  managing its own lifecycle accordingly.
12
12
 
@@ -16,13 +16,13 @@ a unidirectional observation pattern. Infrastructure connects to observe Actor s
16
16
 
17
17
  ## Example
18
18
 
19
- TanStack Router bridge implementation
19
+ Framework router bridge implementation
20
20
 
21
21
  ```typescript
22
22
  import type { RouterBridge } from "@xmachines/play-router";
23
23
  import { Signal } from "@xmachines/play-signals";
24
24
 
25
- class TanStackRouterBridge implements RouterBridge {
25
+ class MyRouterBridge implements RouterBridge {
26
26
  private watcher: Signal.Watcher | null = null;
27
27
 
28
28
  async connect(): Promise<void> {
@@ -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:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L357)
57
+ Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L357)
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:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L373)
86
+ Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L373)
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.53/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.55/packages/play-sveltekit-router/src/types.ts#L10)
@@ -230,6 +230,7 @@ Synchronizes browser URL with actor state through passive infrastructure.
230
230
 
231
231
  - [PlayActor](interfaces/PlayActor.md)
232
232
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
233
+ - [PlayRouterProviderBaseProps](interfaces/PlayRouterProviderBaseProps.md)
233
234
  - [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
234
235
  - [RouteMapOptions](interfaces/RouteMapOptions.md)
235
236
  - [RouteMapping](interfaces/RouteMapping.md)
@@ -238,12 +239,17 @@ Synchronizes browser URL with actor state through passive infrastructure.
238
239
 
239
240
  ## Type Aliases
240
241
 
242
+ - [PlayRouterBridgeConstructor](type-aliases/PlayRouterBridgeConstructor.md)
241
243
  - [TanStackRouterInstance](type-aliases/TanStackRouterInstance.md)
242
244
  - [TanStackRouterLike](type-aliases/TanStackRouterLike.md)
243
245
 
246
+ ## Variables
247
+
248
+ - [PlayRouterProvider](variables/PlayRouterProvider.md)
249
+
244
250
  ## Functions
245
251
 
252
+ - [createPlayRouterProvider](functions/createPlayRouterProvider.md)
246
253
  - [createRouteMap](functions/createRouteMap.md)
247
254
  - [createRouteMapFromTree](functions/createRouteMapFromTree.md)
248
255
  - [extractMachineRoutes](functions/extractMachineRoutes.md)
249
- - [PlayRouterProvider](functions/PlayRouterProvider.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.53/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L101)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -17,10 +17,17 @@ own and inherit the full public API from here.
17
17
  - Results are cached after the first match in an LRU cache (default 500 entries,
18
18
  configurable via the `cacheSize` constructor option)
19
19
 
20
- **Pattern syntax** (`:param` / `:param?`):
20
+ **Pattern syntax** (`:param` / `:param?` / `*`):
21
21
 
22
22
  - `:param` — required segment, matches exactly one non-`/` segment
23
23
  - `:param?` — optional segment, matches zero or one non-`/` segment
24
+ - `*` — wildcard, matches any number of segments (URLPattern semantics)
25
+
26
+ **StateId forms:** stateIds may be registered and looked up in either
27
+ `"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
28
+ `getStateIdByPath` returns the stateId exactly as registered;
29
+ `getPathByStateId` accepts both forms. Registering the same stateId in both
30
+ forms refers to one entry (the later registration wins for reverse lookup).
24
31
 
25
32
  ## Example
26
33
 
@@ -50,7 +57,7 @@ map.getPathByStateId("missing"); // null
50
57
  new RouteMap(mappings, options?): RouteMap;
51
58
  ```
52
59
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L125)
60
+ Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L127)
54
61
 
55
62
  Build a route map from an array of state ID ↔ path mappings.
56
63
 
@@ -78,10 +85,14 @@ buckets for efficient candidate selection.
78
85
  getPathByStateId(stateId): string | null;
79
86
  ```
80
87
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L209)
88
+ Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L218)
82
89
 
83
90
  Look up the path pattern registered for a state ID.
84
91
 
92
+ Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
93
+ which form was used at registration — lookups are canonicalized internally,
94
+ so consumers never need to try both forms.
95
+
85
96
  #### Parameters
86
97
 
87
98
  | Parameter | Type | Description |
@@ -98,6 +109,7 @@ The registered path pattern, or `null` if the state ID is unknown
98
109
 
99
110
  ```typescript
100
111
  map.getPathByStateId("profile"); // "/profile/:userId"
112
+ map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
101
113
  map.getPathByStateId("missing"); // null
102
114
  ```
103
115
 
@@ -109,7 +121,7 @@ map.getPathByStateId("missing"); // null
109
121
  getStateIdByPath(path): string | null;
110
122
  ```
111
123
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L174)
124
+ Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L178)
113
125
 
114
126
  Resolve a URL path to its mapped state ID.
115
127
 
@@ -2,14 +2,15 @@
2
2
 
3
3
  # Class: TanStackReactRouterBridge
4
4
 
5
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L83)
5
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L102)
6
6
 
7
- TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
7
+ Shared TanStack Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
9
9
  ## Remarks
10
10
 
11
- Extends RouterBridgeBase to handle all common lifecycle and sync logic.
12
- Only 3 TanStack-specific methods are implemented here.
11
+ Extends RouterBridgeBase to handle all common lifecycle and sync logic; adds
12
+ the TanStack-specific navigation and subscription methods shared by the React
13
+ and Solid adapters.
13
14
 
14
15
  Subscribes to router.history (not router.subscribe("onBeforeLoad")) so that
15
16
  back/forward browser navigation (popstate events) are also captured. The
@@ -24,10 +25,14 @@ Architectural Invariants:
24
25
  - INV-02 (Passive Infrastructure): Router reflects actor state, never decides
25
26
  - Actor validates all navigation via guards before URL changes
26
27
 
28
+ The class is concrete — it can be instantiated directly. The framework
29
+ packages re-export or subclass it purely to bind the public adapter name
30
+ (and, for Solid, to add the `dispose()` alias).
31
+
27
32
  ## Example
28
33
 
29
34
  ```typescript
30
- const bridge = new TanStackReactRouterBridge(router, actor, routeMap);
35
+ const bridge = new TanStackRouterBridgeBase(router, actor, routeMap);
31
36
  bridge.connect();
32
37
  return () => bridge.disconnect();
33
38
  ```
@@ -44,43 +49,29 @@ return () => bridge.disconnect();
44
49
  new TanStackReactRouterBridge(
45
50
  router,
46
51
  actor,
47
- routeMap): TanStackReactRouterBridge;
52
+ routeMap): TanStackRouterBridgeBase;
48
53
  ```
49
54
 
50
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L93)
55
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
51
56
 
52
- Create TanStack React Router bridge
57
+ Create a TanStack Router bridge
53
58
 
54
59
  #### Parameters
55
60
 
56
- | Parameter | Type | Description |
57
- | ---------- | -------------------------------------------------------------------- | ------------------------------------------------- |
58
- | `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | TanStack React Router instance |
59
- | `actor` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | XMachines actor instance |
60
- | `routeMap` | [`RouteMap`](RouteMap.md) | Bidirectional mapping between state IDs and paths |
61
+ | Parameter | Type | Description |
62
+ | ---------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------- |
63
+ | `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | TanStack Router instance (from `createRouter`) |
64
+ | `actor` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | XMachines actor instance |
65
+ | `routeMap` | [`TanStackRouteMapLike`](../../play-tanstack-router/type-aliases/TanStackRouteMapLike.md) | Bidirectional mapping between state IDs and paths |
61
66
 
62
67
  #### Returns
63
68
 
64
- `TanStackReactRouterBridge`
69
+ `TanStackRouterBridgeBase`
65
70
 
66
71
  #### Overrides
67
72
 
68
73
  [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
69
74
 
70
- ## Properties
71
-
72
- | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
73
- | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | `undefined` | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L125) |
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:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L103) |
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:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L102) |
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:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L115) |
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:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L104) |
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:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L126) |
80
- | `routeMap.getPathByStateId` | `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.53/packages/play-router/src/router-bridge-base.ts#L128) |
81
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L127) |
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:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L116) |
83
-
84
75
  ## Methods
85
76
 
86
77
  ### connect()
@@ -89,7 +80,7 @@ Create TanStack React Router bridge
89
80
  connect(): void;
90
81
  ```
91
82
 
92
- Defined in: [play-router/src/router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L152)
83
+ Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L151)
93
84
 
94
85
  Connect the router bridge to the Actor.
95
86
 
@@ -121,7 +112,7 @@ Adapters that need custom initial-sync behavior should override
121
112
  disconnect(): void;
122
113
  ```
123
114
 
124
- Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L248)
115
+ Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L256)
125
116
 
126
117
  Disconnect the router bridge from the Actor.
127
118
 
@@ -134,357 +125,3 @@ Stops signal watching and unregisters framework-specific router listener.
134
125
  #### Inherited from
135
126
 
136
127
  [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)
137
-
138
- ---
139
-
140
- ### extractParams()
141
-
142
- ```ts
143
- protected extractParams(pathname, stateId): Record<string, string>;
144
- ```
145
-
146
- Defined in: [play-router/src/router-bridge-base.ts:402](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L402)
147
-
148
- Extract path parameters from URL using the URLPattern API.
149
-
150
- Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
151
- library. If `URLPattern` is unavailable and the matched route has parameterized
152
- segments, a `URLPatternUnavailableError` is thrown — callers must provide a polyfill
153
- for environments without native URLPattern support (Node.js < 24, older browsers).
154
-
155
- #### Parameters
156
-
157
- | Parameter | Type | Description |
158
- | ---------- | -------- | ----------------------------------------------------- |
159
- | `pathname` | `string` | The actual URL path (e.g., '/profile/john') |
160
- | `stateId` | `string` | The matched state ID for looking up the route pattern |
161
-
162
- #### Returns
163
-
164
- `Record`\<`string`, `string`\>
165
-
166
- Extracted path parameters, or empty object if no match
167
-
168
- #### Throws
169
-
170
- When URLPattern is absent and the route is parameterized
171
-
172
- #### Inherited from
173
-
174
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
175
-
176
- ---
177
-
178
- ### extractQuery()
179
-
180
- ```ts
181
- protected extractQuery(search): Record<string, string>;
182
- ```
183
-
184
- Defined in: [play-router/src/router-bridge-base.ts:439](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L439)
185
-
186
- Extract query parameters from URL search string.
187
-
188
- #### Parameters
189
-
190
- | Parameter | Type | Description |
191
- | --------- | -------- | ------------------------------------------------ |
192
- | `search` | `string` | URL search string (e.g., '?tab=security&page=1') |
193
-
194
- #### Returns
195
-
196
- `Record`\<`string`, `string`\>
197
-
198
- Extracted query parameters or empty object
199
-
200
- #### Inherited from
201
-
202
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
203
-
204
- ---
205
-
206
- ### getInitialRouterPath()
207
-
208
- ```ts
209
- protected getInitialRouterPath(): string | null;
210
- ```
211
-
212
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L127)
213
-
214
- Read the router's current pathname for initial sync.
215
-
216
- Called once in connect() to handle cold-load / deep-link scenarios where
217
- the URL differs from the actor's initial state (e.g. user pastes /dashboard
218
- while logged out — the actor must be redirected to /login before rendering).
219
-
220
- Uses `router.history.location.pathname` — reflects `window.location` immediately,
221
- before the router has been loaded or a `<RouterProvider>` mounted.
222
- `router.state.location` is only populated after `router.load()` which may not
223
- have run yet when the bridge first connects in a `useEffect`.
224
-
225
- The base class `connect()` uses `actor.initialRoute` to distinguish:
226
-
227
- - **Deep-link:** router URL differs from machine's initial route → router wins.
228
- - **Restore:** router at machine's initial route, actor at a different restored
229
- route → actor wins, bridge pushes actor's restored route to the router.
230
-
231
- #### Returns
232
-
233
- `string` \| `null`
234
-
235
- #### Overrides
236
-
237
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
238
-
239
- ---
240
-
241
- ### getInitialRouterSearch()
242
-
243
- ```ts
244
- protected getInitialRouterSearch(): string | undefined;
245
- ```
246
-
247
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L143)
248
-
249
- Return the initial URL search string for query-param forwarding on `connect()`.
250
-
251
- Reads `router.history.location.search` — the same source used by
252
- `getInitialRouterPath()`, which reflects `window.location` immediately before
253
- `router.load()` or `<RouterProvider>` mounts. An empty string returns `undefined`
254
- so `syncActorFromRouter` produces `query: {}` rather than parsing an empty string.
255
-
256
- #### Returns
257
-
258
- `string` \| `undefined`
259
-
260
- #### Overrides
261
-
262
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterSearch`](../../play-router/classes/RouterBridgeBase.md#getinitialroutersearch)
263
-
264
- ---
265
-
266
- ### navigateRouter()
267
-
268
- ```ts
269
- protected navigateRouter(path): void;
270
- ```
271
-
272
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L105)
273
-
274
- Must trigger the framework router's navigation (e.g., router.navigate(path)).
275
-
276
- #### Parameters
277
-
278
- | Parameter | Type |
279
- | --------- | -------- |
280
- | `path` | `string` |
281
-
282
- #### Returns
283
-
284
- `void`
285
-
286
- #### Overrides
287
-
288
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
289
-
290
- ---
291
-
292
- ### resolveNavigationPath()
293
-
294
- ```ts
295
- protected resolveNavigationPath(route): string | null;
296
- ```
297
-
298
- Defined in: [play-router/src/router-bridge-base.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L424)
299
-
300
- Resolve an actor route value to a concrete URL path for navigation.
301
-
302
- Bridges that receive raw `actor.currentRoute` values in `navigateRouter`
303
- can call this to normalize stateIds (with or without `#` prefix) to paths.
304
- Returns `null` when navigation is not possible:
305
-
306
- - unknown stateId with no route map entry
307
- - parameterized pattern (e.g. `/profile/:id`) — no concrete values available
308
- - non-path string that isn't a known stateId
309
-
310
- Route maps may store stateIds with or without the `#` prefix; both forms
311
- are tried automatically.
312
-
313
- #### Parameters
314
-
315
- | Parameter | Type | Description |
316
- | --------- | -------- | -------------------------------------------------------------- |
317
- | `route` | `string` | Raw actor route value (stateId, `#`-stateId, or concrete path) |
318
-
319
- #### Returns
320
-
321
- `string` \| `null`
322
-
323
- Concrete URL path, or `null` if navigation should be skipped
324
-
325
- #### Inherited from
326
-
327
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`resolveNavigationPath`](../../play-router/classes/RouterBridgeBase.md#resolvenavigationpath)
328
-
329
- ---
330
-
331
- ### sanitizePath()
332
-
333
- ```ts
334
- protected sanitizePath(pathname): string | null;
335
- ```
336
-
337
- Defined in: [play-router/src/router-bridge-base.ts:466](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L466)
338
-
339
- Sanitize and validate a raw URL pathname received from the router.
340
-
341
- Applies the path-length cap (2048 chars), strips query strings and fragments
342
- that may have been included in the pathname segment, and normalises
343
- consecutive slashes.
344
-
345
- Implementations that bypass `syncActorFromRouter()` (e.g. when using
346
- framework-native reactive watchers that receive pre-parsed route objects)
347
- MUST call this method before passing the path to any route-map lookup.
348
- `syncActorFromRouter()` calls this internally, so bridges that delegate
349
- to it do not need to call `sanitizePath` themselves.
350
-
351
- #### Parameters
352
-
353
- | Parameter | Type | Description |
354
- | ---------- | -------- | ------------------------------------------- |
355
- | `pathname` | `string` | Raw URL pathname from the framework router. |
356
-
357
- #### Returns
358
-
359
- `string` \| `null`
360
-
361
- Sanitized pathname, or `null` if the path is invalid / too long.
362
-
363
- #### Inherited from
364
-
365
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`sanitizePath`](../../play-router/classes/RouterBridgeBase.md#sanitizepath)
366
-
367
- ---
368
-
369
- ### syncActorFromRouter()
370
-
371
- ```ts
372
- protected syncActorFromRouter(pathname, search?): void;
373
- ```
374
-
375
- Defined in: [play-router/src/router-bridge-base.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L324)
376
-
377
- Sync actor state when router location changes.
378
-
379
- **Known path:** sends a `play.route` event to the actor with the matched
380
- stateId, params, and query. Prevents circular updates via the
381
- `isProcessingNavigation` flag.
382
-
383
- **Unknown/unmapped path:** does NOT send a `play.route` event (actor state
384
- is unchanged). Instead, actively corrects the browser URL by calling
385
- `navigateRouter(actor.currentRoute.get())` — keeping the URL in sync with
386
- actor state even when the user types an invalid path into the address bar
387
- or pushes one programmatically mid-session. `lastSyncedPath` is set to the
388
- resolved concrete path before calling `navigateRouter` so the router's own
389
- callback for that navigation short-circuits the echo-suppression guard and
390
- sends no spurious event.
391
-
392
- #### Parameters
393
-
394
- | Parameter | Type |
395
- | ---------- | -------- |
396
- | `pathname` | `string` |
397
- | `search?` | `string` |
398
-
399
- #### Returns
400
-
401
- `void`
402
-
403
- #### Inherited from
404
-
405
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
406
-
407
- ---
408
-
409
- ### syncRouterFromActor()
410
-
411
- ```ts
412
- protected syncRouterFromActor(route): void;
413
- ```
414
-
415
- Defined in: [play-router/src/router-bridge-base.ts:289](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L289)
416
-
417
- Sync router location when actor route signal changes.
418
-
419
- Calls navigateRouter() for framework-specific navigation.
420
-
421
- Echo suppression — preventing the router's own callback from re-driving the
422
- actor — is handled entirely by `lastSyncedPath`: it is set to `route` before
423
- `navigateRouter()` is called, so any `syncActorFromRouter` invocation for the
424
- same path short-circuits at the `sanitized === lastSyncedPath` check and sends
425
- no event regardless of whether the callback fires synchronously or asynchronously.
426
-
427
- `isProcessingNavigation` is NOT set here — it is only used inside
428
- `syncActorFromRouter` to guard against re-entrant guard-redirect loops.
429
-
430
- #### Parameters
431
-
432
- | Parameter | Type |
433
- | --------- | --------- |
434
- | `route` | `unknown` |
435
-
436
- #### Returns
437
-
438
- `void`
439
-
440
- #### Inherited from
441
-
442
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
443
-
444
- ---
445
-
446
- ### unwatchRouterChanges()
447
-
448
- ```ts
449
- protected unwatchRouterChanges(): void;
450
- ```
451
-
452
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L165)
453
-
454
- Stop watching for router location changes.
455
-
456
- Called by disconnect(). Should clean up the framework-specific subscription.
457
-
458
- #### Returns
459
-
460
- `void`
461
-
462
- #### Overrides
463
-
464
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
465
-
466
- ---
467
-
468
- ### watchRouterChanges()
469
-
470
- ```ts
471
- protected watchRouterChanges(): void;
472
- ```
473
-
474
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L156)
475
-
476
- Subscribe to ALL navigation events via router.history.
477
-
478
- router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
479
- covering both link clicks and browser back/forward button presses.
480
-
481
- The subscriber callback receives { location, action } where location is the
482
- new history location with pathname and search already updated.
483
-
484
- #### Returns
485
-
486
- `void`
487
-
488
- #### Overrides
489
-
490
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)