@xmachines/docs 1.0.0-beta.31 → 1.0.0-beta.33

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 (289) hide show
  1. package/api/@xmachines/play/README.md +5 -0
  2. package/api/@xmachines/play/classes/NonNullableError.md +189 -0
  3. package/api/@xmachines/play/classes/PlayError.md +9 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +9 -9
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/README.md +228 -39
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +39 -26
  15. package/api/@xmachines/play-dom/functions/connectRenderer.md +39 -20
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +43 -0
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +5 -5
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +43 -9
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +11 -9
  21. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
  22. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +14 -9
  23. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +7 -5
  25. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +23 -7
  26. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +114 -0
  28. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +25 -0
  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 +39 -0
  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/SetState.md +30 -0
  36. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  37. package/api/@xmachines/play-dom-router/README.md +166 -59
  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/RouteMap.md +3 -3
  47. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  51. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  52. package/api/@xmachines/play-react/README.md +1 -0
  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/useSignalEffect.md +1 -1
  56. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  57. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  58. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +9 -8
  59. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  60. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +22 -0
  61. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  62. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  63. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  64. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  65. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  66. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  67. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  68. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  69. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  70. package/api/@xmachines/play-router/README.md +1 -1
  71. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  72. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  73. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  74. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  75. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  76. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  77. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  78. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  81. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  82. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  83. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  84. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  86. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  87. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  88. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  89. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  90. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  91. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  92. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  93. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  94. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  96. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  98. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  99. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  101. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  102. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  103. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  104. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  105. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  108. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  109. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  110. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  111. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  112. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  113. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  114. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  115. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  116. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  117. package/api/@xmachines/play-solid/README.md +1 -0
  118. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  119. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +9 -8
  120. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  121. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +22 -0
  122. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  123. package/api/@xmachines/play-solid-router/README.md +2 -2
  124. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  125. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  126. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +28 -1
  127. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  129. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  130. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  131. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  132. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  133. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  135. package/api/@xmachines/play-svelte/README.md +52 -12
  136. package/api/@xmachines/play-svelte/functions/defineRegistry.md +12 -35
  137. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +24 -0
  138. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +9 -8
  139. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
  140. package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
  141. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +23 -0
  142. package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
  143. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  144. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  145. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  146. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  147. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  148. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  149. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  150. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  151. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  152. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  153. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  154. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  155. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  156. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  157. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  158. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  159. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  160. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  161. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  162. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  163. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +8 -1
  164. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  165. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  166. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  167. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  168. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  169. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  171. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  172. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  173. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  174. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  175. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  176. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +9 -1
  177. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  178. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  179. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  180. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  181. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  182. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  183. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  184. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  185. package/api/@xmachines/play-vue/README.md +1 -0
  186. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  187. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  188. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +7 -6
  189. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  190. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  191. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  192. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  193. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +22 -0
  194. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  195. package/api/@xmachines/play-vue-router/README.md +3 -3
  196. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  197. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  198. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +39 -26
  199. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  200. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  201. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  202. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  203. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  204. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  205. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  206. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  207. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  208. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  209. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  210. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  211. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  212. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  213. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  214. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  215. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  216. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  217. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  218. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  219. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  220. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  221. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  222. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  223. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  224. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  225. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  226. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  227. package/api/@xmachines/shared/README.md +47 -47
  228. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  229. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  230. package/api/_media/README.md +321 -0
  231. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  232. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  233. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  234. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  235. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  236. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  237. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  238. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  239. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  240. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  241. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  242. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  243. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  244. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  245. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  246. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  247. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  248. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  249. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  250. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  251. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  252. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  253. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  254. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  255. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  256. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  257. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  258. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  259. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  260. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  261. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  262. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  263. package/examples/@xmachines/play-react-router-demo/README.md +1 -3
  264. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  267. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  268. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  269. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  270. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  271. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  272. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  273. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  274. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  275. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  276. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  277. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  278. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  279. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  280. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  281. package/examples/@xmachines/play-solid-router-demo/README.md +1 -3
  282. package/examples/README.md +2 -2
  283. package/examples/form-validation.md +80 -0
  284. package/examples/routing-patterns.md +9 -19
  285. package/guides/getting-started.md +51 -38
  286. package/guides/installation.md +6 -6
  287. package/package.json +6 -6
  288. package/rfc/play.md +19 -19
  289. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +0 -23
package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L6)
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-sveltekit-router/src/connect-router.ts#L6)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | - | [play-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L7) |
12
- | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L13) |
13
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-sveltekit-router/src/connect-router.ts#L8) |
11
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | - | [play-sveltekit-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-sveltekit-router/src/connect-router.ts#L7) |
12
+ | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-sveltekit-router/src/connect-router.ts#L13) |
13
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-sveltekit-router/src/connect-router.ts#L8) |
package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L344)
5
+ Defined in: [play-router/src/types.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L344)
6
6
 
7
7
  Minimal location interface required by adapters that read the current URL at
8
8
  `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
23
23
 
24
24
  | Property | Modifier | Type | Defined in |
25
25
  | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L345) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L346) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L345) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L346) |
package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L223)
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:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L224) |
package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md CHANGED
@@ -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.31/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.33/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: BaseRouteMapping = { stateId: "settings", path: "/setting
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.31/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.31/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.33/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.33/packages/play-router/src/base-route-map.ts#L59) |
package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L271)
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:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md CHANGED
@@ -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.31/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.33/packages/play-sveltekit-router/src/types.ts#L10)
package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-tanstack-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/route-map.ts#L12)
5
+ Defined in: [play-tanstack-react-router/src/route-map.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/route-map.ts#L12)
6
6
 
7
7
  Bidirectional route mapper for TanStack React Router.
8
8
 
@@ -20,7 +20,7 @@ Alias for [BaseRouteMap](../../play-dom-router/interfaces/RouteMap.md) from `@xm
20
20
  new RouteMap(mappings, options?): RouteMap;
21
21
  ```
22
22
 
23
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L125)
23
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L125)
24
24
 
25
25
  Build a route map from an array of state ID ↔ path mappings.
26
26
 
@@ -54,7 +54,7 @@ BaseRouteMap.constructor;
54
54
  getPathByStateId(stateId): string | null;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
57
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L209)
58
58
 
59
59
  Look up the path pattern registered for a state ID.
60
60
 
@@ -89,7 +89,7 @@ map.getPathByStateId("missing"); // null
89
89
  getStateIdByPath(path): string | null;
90
90
  ```
91
91
 
92
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
92
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L174)
93
93
 
94
94
  Resolve a URL path to its mapped state ID.
95
95
 
package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackReactRouterBridge
4
4
 
5
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L84)
5
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L84)
6
6
 
7
7
  TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
@@ -47,7 +47,7 @@ new TanStackReactRouterBridge(
47
47
  routeMap): TanStackReactRouterBridge;
48
48
  ```
49
49
 
50
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L94)
50
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L94)
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` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L99) |
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:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L87) |
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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L86) |
77
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L89) |
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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L88) |
79
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L100) |
80
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L102) |
81
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L101) |
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:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L90) |
74
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L99) |
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:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L87) |
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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L86) |
77
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L89) |
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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L88) |
79
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L100) |
80
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L102) |
81
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L101) |
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:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L90) |
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:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L126)
92
+ Defined in: [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L126)
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:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L209)
124
+ Defined in: [play-router/src/router-bridge-base.ts:214](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L214)
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:318](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L318)
146
+ Defined in: [play-router/src/router-bridge-base.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L322)
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:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L355)
184
+ Defined in: [play-router/src/router-bridge-base.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L359)
185
185
 
186
186
  Extract query parameters from URL search string.
187
187
 
@@ -209,7 +209,7 @@ Extracted query parameters or empty object
209
209
  protected getInitialRouterPath(): string | null;
210
210
  ```
211
211
 
212
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L128)
212
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L128)
213
213
 
214
214
  Read the router's current pathname for initial sync.
215
215
 
@@ -244,7 +244,7 @@ The base class `connect()` uses `actor.initialRoute` to distinguish:
244
244
  protected getInitialRouterSearch(): string | undefined;
245
245
  ```
246
246
 
247
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L144)
247
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L144)
248
248
 
249
249
  Return the initial URL search string for query-param forwarding on `connect()`.
250
250
 
@@ -269,7 +269,7 @@ so `syncActorFromRouter` produces `query: {}` rather than parsing an empty strin
269
269
  protected navigateRouter(path): void;
270
270
  ```
271
271
 
272
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L106)
272
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L106)
273
273
 
274
274
  Navigate the framework router to the given path.
275
275
 
@@ -298,7 +298,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
298
298
  protected resolveNavigationPath(route): string | null;
299
299
  ```
300
300
 
301
- Defined in: [play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L340)
301
+ Defined in: [play-router/src/router-bridge-base.ts:344](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L344)
302
302
 
303
303
  Resolve an actor route value to a concrete URL path for navigation.
304
304
 
@@ -337,7 +337,7 @@ Concrete URL path, or `null` if navigation should be skipped
337
337
  protected syncActorFromRouter(pathname, search?): void;
338
338
  ```
339
339
 
340
- Defined in: [play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L260)
340
+ Defined in: [play-router/src/router-bridge-base.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L264)
341
341
 
342
342
  Sync actor state when router location changes.
343
343
 
@@ -367,7 +367,7 @@ Prevents circular updates via isProcessingNavigation flag.
367
367
  protected syncRouterFromActor(route): void;
368
368
  ```
369
369
 
370
- Defined in: [play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/router-bridge-base.ts#L240)
370
+ Defined in: [play-router/src/router-bridge-base.ts:244](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/router-bridge-base.ts#L244)
371
371
 
372
372
  Sync router location when actor route signal changes.
373
373
 
@@ -400,7 +400,7 @@ suppressed as circular echoes.
400
400
  protected unwatchRouterChanges(): void;
401
401
  ```
402
402
 
403
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L166)
403
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L166)
404
404
 
405
405
  Stop watching for router location changes.
406
406
 
@@ -422,7 +422,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
422
422
  protected watchRouterChanges(): void;
423
423
  ```
424
424
 
425
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L157)
425
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L157)
426
426
 
427
427
  Subscribe to ALL navigation events via router.history.
428
428
 
package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md CHANGED
@@ -6,7 +6,14 @@
6
6
  function PlayRouterProvider<TActor>(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L41)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L67)
10
+
11
+ Connects a `PlayerActor` to TanStack React Router, keeping actor state and
12
+ browser URL in sync bidirectionally.
13
+
14
+ The bridge is created once on mount and torn down on unmount. It is also
15
+ rebuilt if `actor`, `router`, or `routeMap` change identity — so all three
16
+ props must be **stable references** (created outside JSX or memoized).
10
17
 
11
18
  ## Type Parameters
12
19
 
package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map.ts#L74)
9
+ Defined in: [play-router/src/create-route-map.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map.ts#L74)
10
10
 
11
11
  Create a RouteMap from a RouteTree for efficient path lookups.
12
12
 
package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMapFromTree(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-tree.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-tree.ts#L31)
9
+ Defined in: [play-router/src/create-route-map-from-tree.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/create-route-map-from-tree.ts#L31)
10
10
 
11
11
  Create a `BaseRouteMap` from a `RouteTree` node structure.
12
12
 
package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md CHANGED
@@ -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.31/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.33/packages/play-router/src/extract-routes.ts#L93)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L223)
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:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L224) |
package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -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:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L30)
5
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L30)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,9 +12,9 @@ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:30](https:/
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Type | Description | Defined in |
16
- | ----------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | `TActor` | - | [play-tanstack-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L34) |
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:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L38) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [play-tanstack-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L36) |
20
- | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | - | [play-tanstack-react-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L35) |
15
+ | Property | Type | Description | Defined in |
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:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L39) |
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:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L56) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMap(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMap(routeTree), [routeTree]);` | [play-tanstack-react-router/src/play-router-provider.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L54) |
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:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L41) |
package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md CHANGED
@@ -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.31/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.33/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: BaseRouteMapping = { stateId: "settings", path: "/setting
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.31/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.31/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.33/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.33/packages/play-router/src/base-route-map.ts#L59) |
package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md CHANGED
@@ -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.31/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.33/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.31/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.31/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.33/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.33/packages/play-tanstack-react-router/src/types.ts#L23) |
package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L271)
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:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md CHANGED
@@ -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:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/play-router-provider.tsx#L28)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/play-router-provider.tsx#L28)
package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L42)
9
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L42)
10
10
 
11
11
  ## Properties
12
12
 
@@ -16,7 +16,7 @@ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https:
16
16
  history: object;
17
17
  ```
18
18
 
19
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L45)
19
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L45)
20
20
 
21
21
  #### location
22
22
 
@@ -64,7 +64,7 @@ subscribe(handler): () => void;
64
64
  optional load(): void | Promise<void>;
65
65
  ```
66
66
 
67
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L44)
67
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L44)
68
68
 
69
69
  #### Returns
70
70
 
@@ -78,7 +78,7 @@ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https:
78
78
  navigate(args): void;
79
79
  ```
80
80
 
81
- Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L43)
81
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L43)
82
82
 
83
83
  #### Parameters
84
84