@xmachines/docs 1.0.0-beta.48 → 1.0.0-beta.50

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 (311) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  3. package/api/@xmachines/play/classes/PlayError.md +4 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  8. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  11. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  14. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  21. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +6 -6
  22. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  23. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  24. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  26. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  28. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  31. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  40. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  42. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  43. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  45. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  46. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  47. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  48. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  49. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  54. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  55. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  56. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  57. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  58. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  59. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  60. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  63. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  64. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  65. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  66. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  67. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  69. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  70. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  71. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  72. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  73. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  74. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  75. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  77. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  78. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  79. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  80. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  81. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  82. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  83. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  84. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  85. package/api/@xmachines/play-router/functions/createRouteMatcher.md +1 -1
  86. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  87. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  88. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  89. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  90. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  91. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  92. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  94. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  96. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  97. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  98. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  99. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  100. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  101. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  102. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  104. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  105. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  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/PlayActor.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 +24 -24
  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/PlayRouteEvent.md +6 -6
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  143. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  144. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  145. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  146. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  147. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  148. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  149. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  152. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  153. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  154. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  155. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  156. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  158. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  159. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  168. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  169. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  170. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  172. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  173. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  174. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  175. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  176. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  177. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  178. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  179. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  180. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  182. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  184. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  185. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  186. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  189. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  190. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  191. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  192. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  193. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  194. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  201. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  202. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  203. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  204. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  205. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  206. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  207. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  208. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  209. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  211. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  212. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  213. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  214. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  215. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  217. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  218. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  219. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  220. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  221. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  222. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  223. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  224. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  225. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  227. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  228. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  236. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  237. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  238. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  239. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  240. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  242. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  243. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  244. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  245. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  246. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  247. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  248. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  249. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  250. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  251. package/contributing/README.md +10 -0
  252. package/{guides → contributing}/configuration.md +19 -35
  253. package/{guides → contributing}/deployment.md +0 -22
  254. package/{guides → contributing}/development.md +2 -2
  255. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  256. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  257. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  258. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  259. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  260. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  270. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  271. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  272. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  273. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  274. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  275. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  276. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  288. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  289. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  290. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  291. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  304. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  305. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  306. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  307. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  308. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  309. package/guides/README.md +4 -0
  310. package/package.json +4 -2
  311. /package/{guides → contributing}/testing.md +0 -0
package/api/@xmachines/play-react/variables/PlayUIProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayUIProvider: React.FC<PlayUIProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react/src/PlayUIProvider.tsx#L102)
9
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react/src/PlayUIProvider.tsx#L102)
10
10
 
11
11
  PlayUIProvider — batteries-included entry point for actor-driven UI rendering.
12
12
 
package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReactRouterBridge
4
4
 
5
- Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L28)
5
+ Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L28)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -25,7 +25,7 @@ new ReactRouterBridge(
25
25
  routeMap): ReactRouterBridge;
26
26
  ```
27
27
 
28
- Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L31)
28
+ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L31)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -47,15 +47,15 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
47
47
 
48
48
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
49
49
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L126) |
51
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L104) |
52
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L103) |
53
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L116) |
54
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L105) |
55
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L127) |
56
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L129) |
57
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L128) |
58
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L117) |
50
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L126) |
51
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L104) |
52
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L103) |
53
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L116) |
54
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L105) |
55
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L127) |
56
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L129) |
57
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L128) |
58
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L117) |
59
59
 
60
60
  ## Methods
61
61
 
@@ -65,7 +65,7 @@ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com
65
65
  connect(): void;
66
66
  ```
67
67
 
68
- Defined in: [play-router/src/router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L153)
68
+ Defined in: [play-router/src/router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L153)
69
69
 
70
70
  Connect the router bridge to the Actor.
71
71
 
@@ -97,7 +97,7 @@ Adapters that need custom initial-sync behavior should override
97
97
  disconnect(): void;
98
98
  ```
99
99
 
100
- Defined in: [play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L249)
100
+ Defined in: [play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L249)
101
101
 
102
102
  Disconnect the router bridge from the Actor.
103
103
 
@@ -119,7 +119,7 @@ Stops signal watching and unregisters framework-specific router listener.
119
119
  protected extractParams(pathname, stateId): Record<string, string>;
120
120
  ```
121
121
 
122
- Defined in: [play-router/src/router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L373)
122
+ Defined in: [play-router/src/router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L373)
123
123
 
124
124
  Extract path parameters from URL using the URLPattern API.
125
125
 
@@ -157,7 +157,7 @@ When URLPattern is absent and the route is parameterized
157
157
  protected extractQuery(search): Record<string, string>;
158
158
  ```
159
159
 
160
- Defined in: [play-router/src/router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L410)
160
+ Defined in: [play-router/src/router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L410)
161
161
 
162
162
  Extract query parameters from URL search string.
163
163
 
@@ -185,7 +185,7 @@ Extracted query parameters or empty object
185
185
  protected getInitialRouterPath(): string | null;
186
186
  ```
187
187
 
188
- Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L49)
188
+ Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L49)
189
189
 
190
190
  Return the router's current pathname so connect() can sync the actor to
191
191
  the URL on initial load. router.subscribe() only fires on future navigations
@@ -208,7 +208,7 @@ the page on /about would leave the actor in its default "home" state.
208
208
  protected getInitialRouterSearch(): string | undefined;
209
209
  ```
210
210
 
211
- Defined in: [play-react-router/src/react-router-bridge.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L60)
211
+ Defined in: [play-react-router/src/react-router-bridge.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L60)
212
212
 
213
213
  Return the initial URL search string for query-param forwarding on `connect()`.
214
214
 
@@ -232,7 +232,7 @@ so `syncActorFromRouter` produces `query: {}` rather than parsing an empty strin
232
232
  protected navigateRouter(path): void;
233
233
  ```
234
234
 
235
- Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L39)
235
+ Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L39)
236
236
 
237
237
  Navigate the framework router to the given path.
238
238
 
@@ -261,7 +261,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
261
261
  protected resolveNavigationPath(route): string | null;
262
262
  ```
263
263
 
264
- Defined in: [play-router/src/router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L395)
264
+ Defined in: [play-router/src/router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L395)
265
265
 
266
266
  Resolve an actor route value to a concrete URL path for navigation.
267
267
 
@@ -300,7 +300,7 @@ Concrete URL path, or `null` if navigation should be skipped
300
300
  protected syncActorFromRouter(pathname, search?): void;
301
301
  ```
302
302
 
303
- Defined in: [play-router/src/router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L315)
303
+ Defined in: [play-router/src/router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L315)
304
304
 
305
305
  Sync actor state when router location changes.
306
306
 
@@ -330,7 +330,7 @@ Prevents circular updates via isProcessingNavigation flag.
330
330
  protected syncRouterFromActor(route): void;
331
331
  ```
332
332
 
333
- Defined in: [play-router/src/router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/router-bridge-base.ts#L290)
333
+ Defined in: [play-router/src/router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/router-bridge-base.ts#L290)
334
334
 
335
335
  Sync router location when actor route signal changes.
336
336
 
@@ -367,7 +367,7 @@ no event regardless of whether the callback fires synchronously or asynchronousl
367
367
  protected unwatchRouterChanges(): void;
368
368
  ```
369
369
 
370
- Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L70)
370
+ Defined in: [play-react-router/src/react-router-bridge.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L70)
371
371
 
372
372
  Stop watching for router location changes.
373
373
 
@@ -389,7 +389,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
389
389
  protected watchRouterChanges(): void;
390
390
  ```
391
391
 
392
- Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/react-router-bridge.ts#L64)
392
+ Defined in: [play-react-router/src/react-router-bridge.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/react-router-bridge.ts#L64)
393
393
 
394
394
  Start watching for router location changes.
395
395
 
package/api/@xmachines/play-react-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/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.50/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.48/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.50/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.48/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.50/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.48/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.50/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/play-router-provider.tsx#L47)
9
+ Defined in: [play-react-router/src/play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/play-router-provider.tsx#L47)
10
10
 
11
11
  Connects a `PlayerActor` to React Router, keeping actor state and browser URL
12
12
  in sync bidirectionally.
package/api/@xmachines/play-react-router/functions/createRouteMap.md CHANGED
@@ -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.48/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.50/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md CHANGED
@@ -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.48/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.50/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
 
package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/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.50/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.48/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.48/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.48/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.48/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.48/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.50/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.50/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.50/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.50/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.50/packages/play-router/src/types.ts#L224) |
package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/play-router-provider.tsx#L10)
5
+ Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/play-router-provider.tsx#L10)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,7 +14,7 @@ Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.c
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with React Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | [play-react-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/play-router-provider.tsx#L19) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | Renderer callback receives the same concrete actor type that was passed in. | [play-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/play-router-provider.tsx#L36) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [play-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/play-router-provider.tsx#L34) |
20
- | <a id="property-router"></a> `router` | `Router` | The React Router instance returned by `createBrowserRouter`. | [play-react-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-react-router/src/play-router-provider.tsx#L21) |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with React Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | [play-react-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/play-router-provider.tsx#L19) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | Renderer callback receives the same concrete actor type that was passed in. | [play-react-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/play-router-provider.tsx#L36) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [play-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/play-router-provider.tsx#L34) |
20
+ | <a id="property-router"></a> `router` | `Router` | The React Router instance returned by `createBrowserRouter`. | [play-react-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-react-router/src/play-router-provider.tsx#L21) |
package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md CHANGED
@@ -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.48/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.50/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.48/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.50/packages/play-router/src/create-route-map.ts#L20) |
package/api/@xmachines/play-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.48/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.50/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.48/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.48/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.50/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.50/packages/play-router/src/base-route-map.ts#L59) |
package/api/@xmachines/play-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.48/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.50/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.48/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.50/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.48/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.50/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/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: [base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/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: [base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/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: [base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.48/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.50/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115