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

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 (315) 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/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  8. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  12. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  13. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  14. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  16. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  17. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +6 -6
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  20. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +15 -15
  21. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +8 -8
  24. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  25. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  28. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  32. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  37. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  38. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  39. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  40. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  42. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  43. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  44. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  45. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  46. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  47. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  53. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  54. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  55. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  56. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  57. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  58. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  59. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  60. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  62. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  63. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  64. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  65. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  66. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
  67. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  68. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  69. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  70. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  72. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  73. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  74. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  75. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  76. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  77. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  78. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
  79. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  80. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  81. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  82. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  83. package/api/@xmachines/play-router/functions/createRouteMatcher.md +1 -1
  84. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  86. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  87. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  88. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  89. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  90. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  91. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  92. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  94. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  95. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  96. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  97. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  98. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  99. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  101. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  102. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  103. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  104. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  105. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  106. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  107. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  108. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  110. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +4 -4
  111. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  112. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  113. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  114. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  117. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  118. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  119. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  120. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  121. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  122. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  123. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  124. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  127. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  128. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  129. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  130. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  131. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  132. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  133. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  136. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  137. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
  138. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  140. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  143. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  144. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  145. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  146. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  156. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  157. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  158. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  160. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  167. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  168. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  169. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  170. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  171. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  172. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  173. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  174. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  175. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  176. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  177. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  178. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  179. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
  180. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  189. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  190. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  191. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  193. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  194. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +25 -25
  195. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  196. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  200. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  201. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  202. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  203. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  204. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  205. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  206. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  207. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  208. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  209. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  210. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  211. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  212. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  213. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  214. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  215. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  216. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  217. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  218. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  219. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
  220. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  221. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  222. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  223. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  224. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  225. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  226. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  227. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  228. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  229. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  236. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  237. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  238. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  239. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  240. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  241. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  242. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  243. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  244. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  245. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  246. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  247. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  248. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  249. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  250. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  251. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  252. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  253. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  254. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  255. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  256. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  257. package/contributing/architecture.md +68 -68
  258. package/contributing/configuration.md +1 -1
  259. package/contributing/development.md +2 -2
  260. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  270. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  271. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  272. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  273. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  274. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  275. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  276. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  287. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  288. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  289. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  290. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  291. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  304. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  305. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  306. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  307. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  308. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  309. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  310. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  311. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  312. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  313. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  314. package/guides/getting-started.md +37 -37
  315. package/package.json +2 -2
@@ -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.52/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): RouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L125)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L209)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L27)
9
+ Defined in: [play-sveltekit-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-sveltekit-router/src/connect-router.ts#L27)
10
10
 
11
11
  Connect SvelteKit router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-sveltekit-router/src/connect-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L4)
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-sveltekit-router/src/connect-router.ts#L4)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------ | ---------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | - | [play-sveltekit-router/src/connect-router.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L5) |
12
- | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L11) |
13
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L6) |
11
+ | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | - | [play-sveltekit-router/src/connect-router.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-sveltekit-router/src/connect-router.ts#L5) |
12
+ | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-sveltekit-router/src/connect-router.ts#L11) |
13
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-sveltekit-router/src/connect-router.ts#L6) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [play-router/src/types.ts:414](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L414)
5
+ Defined in: [play-router/src/types.ts:414](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L414)
6
6
 
7
7
  Minimal location interface required by adapters that read the current URL at
8
8
  `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
23
23
 
24
24
  | Property | Modifier | Type | Defined in |
25
25
  | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:415](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L415) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:416](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L416) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:415](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L415) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:416](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L416) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L230) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L228) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L229) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L227) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L226) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L230) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L228) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L229) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L227) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L226) |
@@ -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.52/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.53/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.52/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.53/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/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.52/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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) |
@@ -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.52/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.53/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -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.52/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.53/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.52/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.53/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.52/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.53/packages/play-sveltekit-router/src/types.ts#L10)
@@ -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.52/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): RouteMap;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L125)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L209)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackReactRouterBridge
4
4
 
5
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L83)
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)
6
6
 
7
7
  TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
@@ -47,7 +47,7 @@ new TanStackReactRouterBridge(
47
47
  routeMap): TanStackReactRouterBridge;
48
48
  ```
49
49
 
50
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L93)
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)
51
51
 
52
52
  Create TanStack React Router bridge
53
53
 
@@ -71,15 +71,15 @@ Create TanStack React Router bridge
71
71
 
72
72
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
73
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.52/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.52/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.52/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.52/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.52/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.52/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.52/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.52/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.52/packages/play-router/src/router-bridge-base.ts#L116) |
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
83
 
84
84
  ## Methods
85
85
 
@@ -89,7 +89,7 @@ Create TanStack React Router bridge
89
89
  connect(): void;
90
90
  ```
91
91
 
92
- Defined in: [play-router/src/router-bridge-base.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L152)
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)
93
93
 
94
94
  Connect the router bridge to the Actor.
95
95
 
@@ -121,7 +121,7 @@ Adapters that need custom initial-sync behavior should override
121
121
  disconnect(): void;
122
122
  ```
123
123
 
124
- Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L248)
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)
125
125
 
126
126
  Disconnect the router bridge from the Actor.
127
127
 
@@ -143,7 +143,7 @@ Stops signal watching and unregisters framework-specific router listener.
143
143
  protected extractParams(pathname, stateId): Record<string, string>;
144
144
  ```
145
145
 
146
- Defined in: [play-router/src/router-bridge-base.ts:402](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L402)
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
147
 
148
148
  Extract path parameters from URL using the URLPattern API.
149
149
 
@@ -181,7 +181,7 @@ When URLPattern is absent and the route is parameterized
181
181
  protected extractQuery(search): Record<string, string>;
182
182
  ```
183
183
 
184
- Defined in: [play-router/src/router-bridge-base.ts:439](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L439)
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
185
 
186
186
  Extract query parameters from URL search string.
187
187
 
@@ -209,7 +209,7 @@ Extracted query parameters or empty object
209
209
  protected getInitialRouterPath(): string | null;
210
210
  ```
211
211
 
212
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L127)
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
213
 
214
214
  Read the router's current pathname for initial sync.
215
215
 
@@ -244,7 +244,7 @@ The base class `connect()` uses `actor.initialRoute` to distinguish:
244
244
  protected getInitialRouterSearch(): string | undefined;
245
245
  ```
246
246
 
247
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L143)
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
248
 
249
249
  Return the initial URL search string for query-param forwarding on `connect()`.
250
250
 
@@ -269,7 +269,7 @@ so `syncActorFromRouter` produces `query: {}` rather than parsing an empty strin
269
269
  protected navigateRouter(path): void;
270
270
  ```
271
271
 
272
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L105)
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
273
 
274
274
  Must trigger the framework router's navigation (e.g., router.navigate(path)).
275
275
 
@@ -295,7 +295,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
295
295
  protected resolveNavigationPath(route): string | null;
296
296
  ```
297
297
 
298
- Defined in: [play-router/src/router-bridge-base.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L424)
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
299
 
300
300
  Resolve an actor route value to a concrete URL path for navigation.
301
301
 
@@ -334,7 +334,7 @@ Concrete URL path, or `null` if navigation should be skipped
334
334
  protected sanitizePath(pathname): string | null;
335
335
  ```
336
336
 
337
- Defined in: [play-router/src/router-bridge-base.ts:466](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L466)
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
338
 
339
339
  Sanitize and validate a raw URL pathname received from the router.
340
340
 
@@ -372,7 +372,7 @@ Sanitized pathname, or `null` if the path is invalid / too long.
372
372
  protected syncActorFromRouter(pathname, search?): void;
373
373
  ```
374
374
 
375
- Defined in: [play-router/src/router-bridge-base.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L324)
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
376
 
377
377
  Sync actor state when router location changes.
378
378
 
@@ -412,7 +412,7 @@ sends no spurious event.
412
412
  protected syncRouterFromActor(route): void;
413
413
  ```
414
414
 
415
- Defined in: [play-router/src/router-bridge-base.ts:289](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/router-bridge-base.ts#L289)
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
416
 
417
417
  Sync router location when actor route signal changes.
418
418
 
@@ -449,7 +449,7 @@ no event regardless of whether the callback fires synchronously or asynchronousl
449
449
  protected unwatchRouterChanges(): void;
450
450
  ```
451
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.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L165)
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
453
 
454
454
  Stop watching for router location changes.
455
455
 
@@ -471,7 +471,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
471
471
  protected watchRouterChanges(): void;
472
472
  ```
473
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.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L156)
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
475
 
476
476
  Subscribe to ALL navigation events via router.history.
477
477
 
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L63)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/play-router-provider.tsx#L63)
10
10
 
11
11
  Connects a `PlayerActor` to TanStack React Router, keeping actor state and
12
12
  browser URL in sync bidirectionally.
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMapFromTree(routeTree, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map-from-tree.ts#L33)
9
+ Defined in: [play-router/src/create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/create-route-map-from-tree.ts#L33)
10
10
 
11
11
  Create a `RouteMap` from a `RouteTree` node structure.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function extractMachineRoutes(machine): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/extract-routes.ts#L93)
9
+ Defined in: [play-router/src/extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/extract-routes.ts#L93)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L297)
5
+ Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
8
  adapters (`play-solid-router`, `play-tanstack-solid-router`, `play-vue-router`,
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L269)
52
+ Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L230) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L228) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L229) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L227) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L226) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L230) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L228) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L229) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L227) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L29)
5
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/play-router-provider.tsx#L29)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,7 +14,7 @@ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:29](https:/
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with TanStack Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | [play-tanstack-react-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L35) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-react-router/src/play-router-provider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L52) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [play-tanstack-react-router/src/play-router-provider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L50) |
20
- | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The TanStack Router instance returned by `createRouter`. | [play-tanstack-react-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L37) |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with TanStack Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | [play-tanstack-react-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/play-router-provider.tsx#L35) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-react-router/src/play-router-provider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/play-router-provider.tsx#L52) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [play-tanstack-react-router/src/play-router-provider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/play-router-provider.tsx#L50) |
20
+ | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The TanStack Router instance returned by `createRouter`. | [play-tanstack-react-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-tanstack-react-router/src/play-router-provider.tsx#L37) |