@xmachines/docs 1.0.0-beta.54 → 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 (334) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  6. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  7. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  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 -28
  15. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -16
  23. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  25. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -9
  26. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +11 -14
  27. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
  28. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  31. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.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/functions/connectRouter.md +1 -1
  43. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  46. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  47. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  48. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  49. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  50. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  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 +2 -2
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  56. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  57. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  58. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  59. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  60. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  61. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  63. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  64. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  65. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  66. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  67. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  69. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  70. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -378
  71. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  72. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  73. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  74. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  75. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  77. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  78. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  79. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  80. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  81. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  82. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  83. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  84. package/api/@xmachines/play-router/README.md +6 -2
  85. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  86. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -353
  87. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  88. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  89. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  90. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  91. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +4 -4
  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/PlayActor.md +5 -5
  111. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  112. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +17 -0
  113. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  114. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  115. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  116. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  118. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  119. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  120. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  121. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  122. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  123. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  124. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  125. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  126. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  127. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  128. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  129. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  130. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  131. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  132. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.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/AnyPlayActor.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/classes/RouteMap.md +4 -4
  144. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -367
  145. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  146. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  147. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  148. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  149. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  150. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  151. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  152. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  153. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  154. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  155. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  156. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  157. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  158. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  159. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  160. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  161. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  162. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  163. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  164. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  165. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  166. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  167. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  168. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  169. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  170. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  171. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  172. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  173. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  174. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  175. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  176. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  177. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  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 +1 -1
  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 +6 -6
  184. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  185. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  186. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  187. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  189. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -384
  190. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  191. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  193. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  194. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  195. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  196. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  197. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  198. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  199. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  200. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  201. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  202. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  203. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  204. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  205. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  206. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -382
  207. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  208. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  209. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  210. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -385
  211. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  212. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  213. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  214. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  215. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  216. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  217. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  218. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  219. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  220. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  221. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  222. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  223. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  224. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  225. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  226. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  227. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  228. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  229. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  230. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  231. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  232. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  233. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  234. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  235. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  236. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  237. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  238. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -405
  239. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  240. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  241. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  242. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  243. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  244. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  245. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  246. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  247. package/api/@xmachines/play-xstate/classes/PlayerActor.md +22 -24
  248. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  249. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  250. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  252. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  253. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  254. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  255. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  256. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  257. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  258. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  259. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  260. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  261. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  262. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  263. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  264. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  265. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  266. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  267. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  268. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  269. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  270. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  271. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  272. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  273. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  274. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  275. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  276. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  277. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  278. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  279. package/contributing/testing.md +4 -4
  280. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  281. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  282. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  283. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  284. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  285. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  286. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  287. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  288. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  289. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  290. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  291. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  292. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  293. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  294. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  295. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  296. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  297. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  298. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  299. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  300. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  301. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  302. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  303. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  304. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  305. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  306. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  307. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  308. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  309. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  310. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  311. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  312. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  313. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  314. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  315. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  316. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  317. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  318. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  319. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  320. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  321. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  322. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  323. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  324. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  325. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  326. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  327. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  328. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  329. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  330. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  331. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  332. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  333. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  334. package/package.json +2 -2
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L51)
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:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/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.54/packages/play-router/src/base-route-map.ts#L53) |
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,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteNavigateEvent
4
4
 
5
- Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/types.ts#L21)
5
+ Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-react-router/src/types.ts#L21)
6
6
 
7
7
  Event sent to actor when browser navigates.
8
8
 
@@ -22,5 +22,5 @@ actor.send({ type: "route.navigate", path: "/dashboard" });
22
22
 
23
23
  | Property | Modifier | Type | Description | Defined in |
24
24
  | --------------------------------- | ---------- | ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | <a id="property-path"></a> `path` | `readonly` | `string` | Target route path (may include parameters, e.g., /posts/123) | [play-tanstack-react-router/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/types.ts#L25) |
26
- | <a id="property-type"></a> `type` | `readonly` | `"route.navigate"` | Event type discriminant (extends XState event pattern) | [play-tanstack-react-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/types.ts#L23) |
25
+ | <a id="property-path"></a> `path` | `readonly` | `string` | Target route path (may include parameters, e.g., /posts/123) | [play-tanstack-react-router/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-react-router/src/types.ts#L25) |
26
+ | <a id="property-type"></a> `type` | `readonly` | `"route.navigate"` | Event type discriminant (extends XState event pattern) | [play-tanstack-react-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-react-router/src/types.ts#L23) |
@@ -2,7 +2,7 @@
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.54/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
 
@@ -54,7 +54,7 @@ class MyRouterBridge 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.54/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.54/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,7 +6,7 @@
6
6
  type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L31)
9
+ Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L31)
10
10
 
11
11
  Constructor shape a bridge class must satisfy to be used with
12
12
  `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
@@ -6,4 +6,4 @@
6
6
  type TanStackRouterInstance = ConstructorParameters<typeof TanStackReactRouterBridge>[0];
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/play-router-provider.tsx#L34)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-react-router/src/play-router-provider.tsx#L34)
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
10
10
 
11
11
  Structural (type-only) interface for the TanStack Router surface used by
12
12
  `TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
@@ -20,7 +20,7 @@ Structural (type-only) interface for the TanStack Router surface used by
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
24
24
 
25
25
  #### location
26
26
 
@@ -68,7 +68,7 @@ subscribe(handler): () => void;
68
68
  optional load(): void | Promise<void>;
69
69
  ```
70
70
 
71
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
71
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
72
72
 
73
73
  Re-runs TanStack route matching and loaders for the current location.
74
74
  Optional: the bridge calls it (fire-and-forget) after every navigation so
@@ -86,7 +86,7 @@ matching/loaders stay in sync even without a mounted `<RouterProvider>`.
86
86
  navigate(args): void;
87
87
  ```
88
88
 
89
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
89
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
90
90
 
91
91
  #### Parameters
92
92
 
@@ -6,7 +6,7 @@
6
6
  const PlayRouterProvider: <TActor>(__namedParameters) => Element;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/play-router-provider.tsx#L57)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-react-router/src/play-router-provider.tsx#L57)
10
10
 
11
11
  Connects a `PlayerActor` to TanStack React Router, keeping actor state and
12
12
  browser URL in sync bidirectionally.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackRouterBridgeBase
4
4
 
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.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L102)
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
7
  Shared TanStack Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
@@ -56,7 +56,7 @@ new TanStackRouterBridgeBase(
56
56
  routeMap): TanStackRouterBridgeBase;
57
57
  ```
58
58
 
59
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
59
+ 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)
60
60
 
61
61
  Create a TanStack Router bridge
62
62
 
@@ -76,21 +76,6 @@ Create a TanStack Router bridge
76
76
 
77
77
  [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
78
78
 
79
- ## Properties
80
-
81
- | Property | Modifier | Type | Description | Inherited from | Defined in |
82
- | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
83
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | play-router/dist/router-bridge-base.d.ts:73 |
84
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | play-router/dist/router-bridge-base.d.ts:79 |
85
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | play-router/dist/router-bridge-base.d.ts:78 |
86
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | 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/dist/router-bridge-base.d.ts:91 |
87
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | play-router/dist/router-bridge-base.d.ts:80 |
88
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. `getPathByStateId` may be keyed on either the `"#stateId"` or the bare `"stateId"` form — both forms are tried automatically by the bridge, so custom implementations (e.g. plain test objects) need only handle one. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | play-router/dist/router-bridge-base.d.ts:74 |
89
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | - | - | play-router/dist/router-bridge-base.d.ts:76 |
90
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | - | - | play-router/dist/router-bridge-base.d.ts:75 |
91
- | <a id="property-router"></a> `router` | `readonly` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | TanStack Router instance (from `createRouter`) | - | [play-tanstack-router/src/tanstack-router-bridge-base.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L113) |
92
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | play-router/dist/router-bridge-base.d.ts:92 |
93
-
94
79
  ## Methods
95
80
 
96
81
  ### connect()
@@ -144,368 +129,3 @@ Stops signal watching and unregisters framework-specific router listener.
144
129
  #### Inherited from
145
130
 
146
131
  [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)
147
-
148
- ---
149
-
150
- ### extractParams()
151
-
152
- ```ts
153
- protected extractParams(pathname, stateId): Record<string, string>;
154
- ```
155
-
156
- Defined in: play-router/dist/router-bridge-base.d.ts:192
157
-
158
- Extract path parameters from URL using the URLPattern API.
159
-
160
- Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
161
- library. If `URLPattern` is unavailable and the matched route has parameterized
162
- segments, a `URLPatternUnavailableError` is thrown — callers must provide a polyfill
163
- for environments without native URLPattern support (Node.js < 24, older browsers).
164
-
165
- #### Parameters
166
-
167
- | Parameter | Type | Description |
168
- | ---------- | -------- | ----------------------------------------------------- |
169
- | `pathname` | `string` | The actual URL path (e.g., '/profile/john') |
170
- | `stateId` | `string` | The matched state ID for looking up the route pattern |
171
-
172
- #### Returns
173
-
174
- `Record`\<`string`, `string`\>
175
-
176
- Extracted path parameters, or empty object if no match
177
-
178
- #### Throws
179
-
180
- When URLPattern is absent and the route is parameterized
181
-
182
- #### Inherited from
183
-
184
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
185
-
186
- ---
187
-
188
- ### extractQuery()
189
-
190
- ```ts
191
- protected extractQuery(search): Record<string, string>;
192
- ```
193
-
194
- Defined in: play-router/dist/router-bridge-base.d.ts:232
195
-
196
- Extract query parameters from URL search string.
197
-
198
- #### Parameters
199
-
200
- | Parameter | Type | Description |
201
- | --------- | -------- | ------------------------------------------------ |
202
- | `search` | `string` | URL search string (e.g., '?tab=security&page=1') |
203
-
204
- #### Returns
205
-
206
- `Record`\<`string`, `string`\>
207
-
208
- Extracted query parameters or empty object
209
-
210
- #### Inherited from
211
-
212
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
213
-
214
- ---
215
-
216
- ### getInitialRouterPath()
217
-
218
- ```ts
219
- protected getInitialRouterPath(): string | null;
220
- ```
221
-
222
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L153)
223
-
224
- Read the router's current pathname for initial sync.
225
-
226
- Called once in connect() to handle cold-load / deep-link scenarios where
227
- the URL differs from the actor's initial state (e.g. user pastes /dashboard
228
- while logged out — the actor must be redirected to /login before rendering).
229
-
230
- Uses `router.history.location.pathname` — reflects `window.location` immediately,
231
- before the router has been loaded or a `<RouterProvider>` mounted.
232
- `router.state.location` is only populated after `router.load()` which may not
233
- have run yet when the bridge first connects in a component effect.
234
-
235
- The base class `connect()` uses `actor.initialRoute` to distinguish:
236
-
237
- - **Deep-link:** router URL differs from machine's initial route → router wins.
238
- - **Restore:** router at machine's initial route, actor at a different restored
239
- route → actor wins, bridge pushes actor's restored route to the router.
240
-
241
- #### Returns
242
-
243
- `string` \| `null`
244
-
245
- #### Overrides
246
-
247
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
248
-
249
- ---
250
-
251
- ### getInitialRouterSearch()
252
-
253
- ```ts
254
- protected getInitialRouterSearch(): string | undefined;
255
- ```
256
-
257
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L169)
258
-
259
- Return the initial URL search string for query-param forwarding on `connect()`.
260
-
261
- Reads `router.history.location.search` — the same source used by
262
- `getInitialRouterPath()`, which reflects `window.location` immediately before
263
- `router.load()` or `<RouterProvider>` mounts. An empty string returns `undefined`
264
- so `syncActorFromRouter` produces `query: {}` rather than parsing an empty string.
265
-
266
- #### Returns
267
-
268
- `string` \| `undefined`
269
-
270
- #### Overrides
271
-
272
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterSearch`](../../play-router/classes/RouterBridgeBase.md#getinitialroutersearch)
273
-
274
- ---
275
-
276
- ### navigateRouter()
277
-
278
- ```ts
279
- protected navigateRouter(path): void;
280
- ```
281
-
282
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L131)
283
-
284
- Navigate TanStack Router to the given path.
285
-
286
- Calls `router.load()` (fire-and-forget) after `navigate` so TanStack re-runs
287
- route matching and loaders — `navigate` alone does not when no
288
- `<RouterProvider>` (Transitioner) is mounted.
289
-
290
- #### Parameters
291
-
292
- | Parameter | Type |
293
- | --------- | -------- |
294
- | `path` | `string` |
295
-
296
- #### Returns
297
-
298
- `void`
299
-
300
- #### Overrides
301
-
302
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
303
-
304
- ---
305
-
306
- ### resolveNavigationPath()
307
-
308
- ```ts
309
- protected resolveNavigationPath(route): string | null;
310
- ```
311
-
312
- Defined in: play-router/dist/router-bridge-base.d.ts:211
313
-
314
- Resolve an actor route value to a concrete URL path for navigation.
315
-
316
- Bridges that receive raw `actor.currentRoute` values in `navigateRouter`
317
- can call this to normalize stateIds (with or without `#` prefix) to paths.
318
- Returns `null` when navigation is not possible:
319
-
320
- - unknown stateId with no route map entry
321
- - parameterized or wildcard pattern (e.g. `/profile/:id`, `/docs/*`) — no
322
- concrete values available to build a real URL
323
- - non-path string that isn't a known stateId
324
-
325
- StateId lookups try both the `"#stateId"` and bare `"stateId"` forms
326
- automatically (via `lookupPathByStateId`), so custom route maps keyed on
327
- only one form still resolve.
328
-
329
- #### Parameters
330
-
331
- | Parameter | Type | Description |
332
- | --------- | -------- | -------------------------------------------------------------- |
333
- | `route` | `string` | Raw actor route value (stateId, `#`-stateId, or concrete path) |
334
-
335
- #### Returns
336
-
337
- `string` \| `null`
338
-
339
- Concrete URL path, or `null` if navigation should be skipped
340
-
341
- #### Inherited from
342
-
343
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`resolveNavigationPath`](../../play-router/classes/RouterBridgeBase.md#resolvenavigationpath)
344
-
345
- ---
346
-
347
- ### sanitizePath()
348
-
349
- ```ts
350
- protected sanitizePath(pathname): string | null;
351
- ```
352
-
353
- Defined in: play-router/dist/router-bridge-base.d.ts:259
354
-
355
- Sanitize and validate a raw URL pathname received from the router.
356
-
357
- Applies the path-length cap (2048 chars), strips query strings and fragments
358
- that may have been included in the pathname segment, and normalises
359
- consecutive slashes.
360
-
361
- Implementations that bypass `syncActorFromRouter()` (e.g. when using
362
- framework-native reactive watchers that receive pre-parsed route objects)
363
- MUST call this method before passing the path to any route-map lookup.
364
- `syncActorFromRouter()` calls this internally, so bridges that delegate
365
- to it do not need to call `sanitizePath` themselves.
366
-
367
- #### Parameters
368
-
369
- | Parameter | Type | Description |
370
- | ---------- | -------- | ------------------------------------------- |
371
- | `pathname` | `string` | Raw URL pathname from the framework router. |
372
-
373
- #### Returns
374
-
375
- `string` \| `null`
376
-
377
- Sanitized pathname, or `null` if the path is invalid / too long.
378
-
379
- #### Inherited from
380
-
381
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`sanitizePath`](../../play-router/classes/RouterBridgeBase.md#sanitizepath)
382
-
383
- ---
384
-
385
- ### syncActorFromRouter()
386
-
387
- ```ts
388
- protected syncActorFromRouter(pathname, search?): void;
389
- ```
390
-
391
- Defined in: play-router/dist/router-bridge-base.d.ts:178
392
-
393
- Sync actor state when router location changes.
394
-
395
- **Known path:** sends a `play.route` event to the actor with the matched
396
- stateId, params, and query. Prevents circular updates via the
397
- `isProcessingNavigation` flag.
398
-
399
- **Unknown/unmapped path:** does NOT send a `play.route` event (actor state
400
- is unchanged). Instead, actively corrects the browser URL by calling
401
- `navigateRouter(actor.currentRoute.get())` — keeping the URL in sync with
402
- actor state even when the user types an invalid path into the address bar
403
- or pushes one programmatically mid-session. `lastSyncedPath` is set to the
404
- resolved concrete path before calling `navigateRouter` so the router's own
405
- callback for that navigation short-circuits the echo-suppression guard and
406
- sends no spurious event.
407
-
408
- #### Parameters
409
-
410
- | Parameter | Type |
411
- | ---------- | -------- |
412
- | `pathname` | `string` |
413
- | `search?` | `string` |
414
-
415
- #### Returns
416
-
417
- `void`
418
-
419
- #### Inherited from
420
-
421
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
422
-
423
- ---
424
-
425
- ### syncRouterFromActor()
426
-
427
- ```ts
428
- protected syncRouterFromActor(route): void;
429
- ```
430
-
431
- Defined in: play-router/dist/router-bridge-base.d.ts:146
432
-
433
- Sync router location when actor route signal changes.
434
-
435
- Resolves the actor route to a concrete URL path and calls navigateRouter()
436
- for framework-specific navigation. When the route cannot be resolved
437
- (unknown stateId, parameterized pattern with no concrete values) the push
438
- is skipped entirely — `navigateRouter` is never called with a raw stateId
439
- or pattern.
440
-
441
- Echo suppression — preventing the router's own callback from re-driving the
442
- actor — is handled entirely by `lastSyncedPath`: it is set to the resolved
443
- path before `navigateRouter()` is called, so any `syncActorFromRouter`
444
- invocation for the same path short-circuits at the
445
- `sanitized === lastSyncedPath` check and sends no event regardless of
446
- whether the callback fires synchronously or asynchronously.
447
-
448
- `isProcessingNavigation` is NOT set here — it is only used inside
449
- `syncActorFromRouter` to guard against re-entrant guard-redirect loops.
450
-
451
- #### Parameters
452
-
453
- | Parameter | Type |
454
- | --------- | --------- |
455
- | `route` | `unknown` |
456
-
457
- #### Returns
458
-
459
- `void`
460
-
461
- #### Inherited from
462
-
463
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
464
-
465
- ---
466
-
467
- ### unwatchRouterChanges()
468
-
469
- ```ts
470
- protected unwatchRouterChanges(): void;
471
- ```
472
-
473
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:196](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L196)
474
-
475
- Stop watching TanStack Router changes.
476
-
477
- #### Returns
478
-
479
- `void`
480
-
481
- #### Overrides
482
-
483
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
484
-
485
- ---
486
-
487
- ### watchRouterChanges()
488
-
489
- ```ts
490
- protected watchRouterChanges(): void;
491
- ```
492
-
493
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L184)
494
-
495
- Subscribe to ALL navigation events via router.history.
496
-
497
- router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
498
- covering both link clicks and browser back/forward button presses.
499
-
500
- The subscriber callback receives { location, action } where location is the
501
- new history location with pathname and search already updated. It calls
502
- `router.load()` (fire-and-forget) so TanStack re-runs matching/loaders for the
503
- new location, mirroring what Transitioner does when `<RouterProvider>` is mounted.
504
-
505
- #### Returns
506
-
507
- `void`
508
-
509
- #### Overrides
510
-
511
- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)
@@ -6,7 +6,7 @@
6
6
  type TanStackRouteMapLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L66)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L66)
10
10
 
11
11
  Narrow route-map surface required by `TanStackRouterBridgeBase`.
12
12
  `RouteMap` from `@xmachines/play-router` satisfies it (null returns are
@@ -24,7 +24,7 @@ implementations keyed on a single form still resolve.
24
24
  getPathByStateId(id): string | null | undefined;
25
25
  ```
26
26
 
27
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L68)
27
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L68)
28
28
 
29
29
  #### Parameters
30
30
 
@@ -44,7 +44,7 @@ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https:/
44
44
  getStateIdByPath(path): string | null | undefined;
45
45
  ```
46
46
 
47
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L67)
47
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L67)
48
48
 
49
49
  #### Parameters
50
50
 
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
10
10
 
11
11
  Structural (type-only) interface for the TanStack Router surface used by
12
12
  `TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
@@ -20,7 +20,7 @@ Structural (type-only) interface for the TanStack Router surface used by
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
24
24
 
25
25
  #### location
26
26
 
@@ -68,7 +68,7 @@ subscribe(handler): () => void;
68
68
  optional load(): void | Promise<void>;
69
69
  ```
70
70
 
71
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
71
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
72
72
 
73
73
  Re-runs TanStack route matching and loaders for the current location.
74
74
  Optional: the bridge calls it (fire-and-forget) after every navigation so
@@ -86,7 +86,7 @@ matching/loaders stay in sync even without a mounted `<RouterProvider>`.
86
86
  navigate(args): void;
87
87
  ```
88
88
 
89
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
89
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
90
90
 
91
91
  #### Parameters
92
92