@xmachines/docs 1.0.0-beta.56 → 1.0.0-beta.57

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 (461) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/README.md +3 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  4. package/api/@xmachines/play/classes/PlayError.md +7 -7
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +5 -5
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +4 -4
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  22. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  23. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +1 -1
  24. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  25. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +1 -1
  26. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +1 -1
  27. package/api/@xmachines/play-dom/interfaces/EventHandle.md +1 -1
  28. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  29. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  30. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +1 -1
  31. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  35. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  45. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  46. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  47. package/api/@xmachines/play-dom-router/README.md +4 -4
  48. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  56. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  63. package/api/@xmachines/play-react/README.md +5 -5
  64. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  65. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  68. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  70. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  71. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  72. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  73. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  74. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  75. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  78. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  79. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  80. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  81. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  82. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  83. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  87. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  89. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  90. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  91. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  93. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  94. package/api/@xmachines/play-react-router/README.md +5 -5
  95. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  96. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  97. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  98. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  99. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  100. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  102. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  103. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  104. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  105. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  106. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  108. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-router/README.md +5 -5
  110. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  111. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  112. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  113. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  114. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  115. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  116. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  118. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  119. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  120. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  121. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  122. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  123. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  124. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  125. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  126. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  127. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  128. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  129. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  130. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  131. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  132. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  133. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  134. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  135. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  136. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  140. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  141. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  143. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  144. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  145. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  146. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  147. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  148. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  149. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  150. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  151. package/api/@xmachines/play-signals/README.md +5 -5
  152. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  153. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  154. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  155. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  156. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  157. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  158. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  159. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  160. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  170. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  171. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  172. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  173. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  174. package/api/@xmachines/play-solid/README.md +6 -6
  175. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  178. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  179. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  180. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  181. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  189. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  190. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  192. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  193. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  199. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  200. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  201. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  202. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  203. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  204. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  206. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  207. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  208. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  209. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  212. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  214. package/api/@xmachines/play-solid-router/README.md +5 -5
  215. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  217. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  218. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  226. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  230. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-svelte/README.md +5 -5
  232. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  236. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  237. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  239. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  240. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  241. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  243. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  244. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  246. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  247. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  248. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  249. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  250. package/api/@xmachines/play-svelte-spa-router/README.md +4 -4
  251. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  253. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  256. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  257. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  258. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  259. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  260. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  261. package/api/@xmachines/play-sveltekit-router/README.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  263. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  264. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  265. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  266. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  267. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  268. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  269. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  270. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  271. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/README.md +6 -6
  273. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  275. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  276. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  277. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  278. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  279. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  280. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  281. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  282. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  284. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  285. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  286. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  287. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  288. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  289. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  291. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  292. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  293. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  294. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  295. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  296. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  297. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  298. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  300. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  301. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  304. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  305. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  306. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  307. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  308. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  309. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  310. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  311. package/api/@xmachines/play-vue/README.md +5 -5
  312. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  313. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  314. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  315. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  317. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  318. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  319. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  320. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  321. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  322. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  323. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  324. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  325. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  326. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  327. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  328. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  329. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  330. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  331. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  332. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  333. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  334. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  335. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  336. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  337. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  338. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  339. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  340. package/api/@xmachines/play-vue-router/README.md +4 -4
  341. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  342. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  343. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  344. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  345. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  346. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  347. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  348. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  349. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  350. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  351. package/api/@xmachines/play-xstate/README.md +3 -3
  352. package/api/@xmachines/play-xstate/classes/PlayerActor.md +19 -19
  353. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  354. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  355. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  356. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  357. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  358. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  359. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  360. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  361. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  362. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  363. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  364. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  365. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  366. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  367. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  368. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  369. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  370. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  371. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  372. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  373. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  374. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  375. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  376. package/api/@xmachines/shared/README.md +2 -2
  377. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  378. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  379. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  380. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  381. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  382. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  383. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  384. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  385. package/contributing/configuration.md +12 -12
  386. package/contributing/deployment.md +9 -9
  387. package/contributing/development.md +43 -43
  388. package/contributing/testing.md +15 -15
  389. package/examples/@xmachines/play-dom-demo/README.md +12 -12
  390. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  397. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  398. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  399. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  400. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  401. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  402. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  403. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  404. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  405. package/examples/@xmachines/play-dom-router-demo/README.md +12 -12
  406. package/examples/@xmachines/play-react-demo/README.md +12 -12
  407. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  408. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  414. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  415. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  416. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  417. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  418. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  419. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  420. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  421. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  422. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  423. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  424. package/examples/@xmachines/play-react-router-demo/README.md +12 -12
  425. package/examples/@xmachines/play-solid-demo/README.md +12 -12
  426. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  431. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  432. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  433. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  434. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  435. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  436. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  437. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  438. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  439. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  440. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  441. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  442. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  443. package/examples/@xmachines/play-solid-router-demo/README.md +12 -12
  444. package/examples/@xmachines/play-svelte-demo/README.md +12 -12
  445. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  446. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  447. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  448. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  449. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +12 -12
  450. package/examples/@xmachines/play-sveltekit-router-demo/README.md +12 -12
  451. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +12 -12
  452. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +12 -12
  453. package/examples/@xmachines/play-vue-demo/README.md +12 -12
  454. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  455. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  456. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  457. package/examples/@xmachines/play-vue-router-demo/README.md +12 -12
  458. package/examples/README.md +3 -3
  459. package/guides/getting-started.md +31 -38
  460. package/guides/signals.md +2 -2
  461. package/package.json +2 -2
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L51)
5
+ Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L55) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L53) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteNavigateEvent
4
4
 
5
- Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/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.57/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.56/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.56/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.57/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.57/packages/play-tanstack-react-router/src/types.ts#L23) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L341)
5
+ Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L357)
57
+ Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L357)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L373)
86
+ Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,7 +6,7 @@
6
6
  type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L31)
9
+ Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L31)
10
10
 
11
11
  Constructor shape a bridge class must satisfy to be used with
12
12
  `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
@@ -6,4 +6,4 @@
6
6
  type TanStackRouterInstance = ConstructorParameters<typeof TanStackReactRouterBridge>[0];
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-react-router/src/play-router-provider.tsx#L34)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-react-router/src/play-router-provider.tsx#L34)
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
10
10
 
11
11
  Structural (type-only) interface for the TanStack Router surface used by
12
12
  `TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
@@ -20,7 +20,7 @@ Structural (type-only) interface for the TanStack Router surface used by
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
24
24
 
25
25
  #### location
26
26
 
@@ -68,7 +68,7 @@ subscribe(handler): () => void;
68
68
  optional load(): void | Promise<void>;
69
69
  ```
70
70
 
71
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
71
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
72
72
 
73
73
  Re-runs TanStack route matching and loaders for the current location.
74
74
  Optional: the bridge calls it (fire-and-forget) after every navigation so
@@ -86,7 +86,7 @@ matching/loaders stay in sync even without a mounted `<RouterProvider>`.
86
86
  navigate(args): void;
87
87
  ```
88
88
 
89
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
89
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
90
90
 
91
91
  #### Parameters
92
92
 
@@ -6,7 +6,7 @@
6
6
  const PlayRouterProvider: <TActor>(__namedParameters) => Element;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-react-router/src/play-router-provider.tsx#L57)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-react-router/src/play-router-provider.tsx#L57)
10
10
 
11
11
  Connects a `PlayerActor` to TanStack React Router, keeping actor state and
12
12
  browser URL in sync bidirectionally.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackRouterBridgeBase
4
4
 
5
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L102)
5
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L102)
6
6
 
7
7
  Shared TanStack Router adapter implementing RouterBridge protocol via RouterBridgeBase
8
8
 
@@ -56,7 +56,7 @@ new TanStackRouterBridgeBase(
56
56
  routeMap): TanStackRouterBridgeBase;
57
57
  ```
58
58
 
59
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
59
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
60
60
 
61
61
  Create a TanStack Router bridge
62
62
 
@@ -6,7 +6,7 @@
6
6
  type TanStackRouteMapLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L66)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L66)
10
10
 
11
11
  Narrow route-map surface required by `TanStackRouterBridgeBase`.
12
12
  `RouteMap` from `@xmachines/play-router` satisfies it (null returns are
@@ -24,7 +24,7 @@ implementations keyed on a single form still resolve.
24
24
  getPathByStateId(id): string | null | undefined;
25
25
  ```
26
26
 
27
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L68)
27
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L68)
28
28
 
29
29
  #### Parameters
30
30
 
@@ -44,7 +44,7 @@ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https:/
44
44
  getStateIdByPath(path): string | null | undefined;
45
45
  ```
46
46
 
47
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L67)
47
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L67)
48
48
 
49
49
  #### Parameters
50
50
 
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
10
10
 
11
11
  Structural (type-only) interface for the TanStack Router surface used by
12
12
  `TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
@@ -20,7 +20,7 @@ Structural (type-only) interface for the TanStack Router surface used by
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
24
24
 
25
25
  #### location
26
26
 
@@ -68,7 +68,7 @@ subscribe(handler): () => void;
68
68
  optional load(): void | Promise<void>;
69
69
  ```
70
70
 
71
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
71
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
72
72
 
73
73
  Re-runs TanStack route matching and loaders for the current location.
74
74
  Optional: the bridge calls it (fire-and-forget) after every navigation so
@@ -86,7 +86,7 @@ matching/loaders stay in sync even without a mounted `<RouterProvider>`.
86
86
  navigate(args): void;
87
87
  ```
88
88
 
89
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
89
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
90
90
 
91
91
  #### Parameters
92
92
 
@@ -24,8 +24,8 @@ The bridge extends `RouterBridgeBase` from [`@xmachines/play-router`](../play-ro
24
24
  ## Installation
25
25
 
26
26
  ```bash
27
- npm install @tanstack/solid-router solid-js
28
- npm install @xmachines/play-tanstack-solid-router @xmachines/play-router
27
+ pnpm add @tanstack/solid-router solid-js
28
+ pnpm add @xmachines/play-tanstack-solid-router @xmachines/play-router
29
29
  ```
30
30
 
31
31
  **Peer dependencies:**
@@ -258,20 +258,20 @@ This keeps routing infrastructure passive while preserving business-logic contro
258
258
  Run tests for this package in isolation:
259
259
 
260
260
  ```bash
261
- npm test -w packages/play-tanstack-solid-router
261
+ pnpm --filter @xmachines/play-tanstack-solid-router test
262
262
  ```
263
263
 
264
264
  Or from the package directory:
265
265
 
266
266
  ```bash
267
- npm test
267
+ pnpm test
268
268
  ```
269
269
 
270
270
  **Browser tests** (`test/browser/**/*.browser.test.ts`) run against real Chromium via Playwright, covering async sequencing that jsdom cannot faithfully reproduce: BACK/FORWARD navigation via `router.history.subscribe`, echo suppression under real microtask timing, `navigate({ to })` call verification, and subscriber teardown on `disconnect()` and `dispose()`.
271
271
 
272
272
  ```bash
273
273
  # Run browser tests only
274
- npx vitest --config vitest.browser.config.ts --project play-tanstack-solid-router-browser
274
+ pnpm exec vitest --config vitest.browser.config.ts --project play-tanstack-solid-router-browser
275
275
  ```
276
276
 
277
277
  Coverage thresholds: lines 80%, functions 80%, branches 70%, statements 80%.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L101)
5
+ Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L101)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -57,7 +57,7 @@ map.getPathByStateId("missing"); // null
57
57
  new RouteMap(mappings, options?): RouteMap;
58
58
  ```
59
59
 
60
- Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L127)
60
+ Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L127)
61
61
 
62
62
  Build a route map from an array of state ID ↔ path mappings.
63
63
 
@@ -85,7 +85,7 @@ buckets for efficient candidate selection.
85
85
  getPathByStateId(stateId): string | null;
86
86
  ```
87
87
 
88
- Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L218)
88
+ Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L218)
89
89
 
90
90
  Look up the path pattern registered for a state ID.
91
91
 
@@ -121,7 +121,7 @@ map.getPathByStateId("missing"); // null
121
121
  getStateIdByPath(path): string | null;
122
122
  ```
123
123
 
124
- Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L178)
124
+ Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L178)
125
125
 
126
126
  Resolve a URL path to its mapped state ID.
127
127
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackSolidRouterBridge
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L42)
5
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L42)
6
6
 
7
7
  TanStack Solid Router adapter implementing RouterBridge protocol via TanStackRouterBridgeBase
8
8
 
@@ -30,7 +30,7 @@ new TanStackSolidRouterBridge(
30
30
  routeMap): TanStackSolidRouterBridge;
31
31
  ```
32
32
 
33
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
33
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
34
34
 
35
35
  Create a TanStack Router bridge
36
36
 
@@ -58,7 +58,7 @@ Create a TanStack Router bridge
58
58
  connect(): void;
59
59
  ```
60
60
 
61
- Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/router-bridge-base.ts#L151)
61
+ Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-bridge-base.ts#L151)
62
62
 
63
63
  Connect the router bridge to the Actor.
64
64
 
@@ -90,7 +90,7 @@ Adapters that need custom initial-sync behavior should override
90
90
  disconnect(): void;
91
91
  ```
92
92
 
93
- Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/router-bridge-base.ts#L256)
93
+ Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/router-bridge-base.ts#L256)
94
94
 
95
95
  Disconnect the router bridge from the Actor.
96
96
 
@@ -112,7 +112,7 @@ Stops signal watching and unregisters framework-specific router listener.
112
112
  dispose(): void;
113
113
  ```
114
114
 
115
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L46)
115
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L46)
116
116
 
117
117
  Dispose the bridge (alias for disconnect).
118
118
 
@@ -6,7 +6,7 @@
6
6
  function createPlayRouterProvider<TRouter>(BridgeCtor): <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L76)
9
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L76)
10
10
 
11
11
  Create a Solid `PlayRouterProvider` component bound to a specific bridge class.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/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.57/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L297)
5
+ Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
8
  adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L269)
52
+ Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -122,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
122
122
 
123
123
  | Property | Modifier | Type | Defined in |
124
124
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
125
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L230) |
126
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L228) |
127
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L229) |
128
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L227) |
129
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderBaseProps\<TRouter, TActor\>
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L45)
5
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L45)
6
6
 
7
7
  Props shared by every factory-created Solid `PlayRouterProvider`.
8
8
 
@@ -25,7 +25,7 @@ router type (e.g. `TanStackRouterInstance` in
25
25
 
26
26
  | Property | Type | Description | Defined in |
27
27
  | ----------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
29
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
30
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
31
- | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
28
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
29
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
30
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
31
+ | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L29)
5
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L29)
6
6
 
7
7
  Props for the TanStack Solid Router `PlayRouterProvider`.
8
8
 
@@ -22,7 +22,7 @@ Props for the TanStack Solid Router `PlayRouterProvider`.
22
22
 
23
23
  | Property | Type | Description | Inherited from | Defined in |
24
24
  | ----------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
26
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
27
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
28
- | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
25
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
26
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
27
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
28
+ | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
@@ -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.56/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.57/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.56/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.57/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L51)
5
+ Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L55) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L53) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L341)
5
+ Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L357)
57
+ Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L357)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L373)
86
+ Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,7 +6,7 @@
6
6
  type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L32)
9
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L32)
10
10
 
11
11
  Constructor shape a bridge class must satisfy to be used with
12
12
  `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L21)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L21)
10
10
 
11
11
  ## Deprecated
12
12
 
@@ -6,4 +6,4 @@
6
6
  type TanStackRouterInstance = ConstructorParameters<typeof TanStackSolidRouterBridge>[0];
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L22)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L22)