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

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 (442) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  3. package/api/@xmachines/play/classes/PlayError.md +7 -7
  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/README.md +2 -0
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  8. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
  9. package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
  10. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  11. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  12. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  14. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  15. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  16. package/api/@xmachines/play-dom/README.md +2 -0
  17. package/api/@xmachines/play-dom/classes/PlayRenderer.md +28 -4
  18. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  19. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  20. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  21. package/api/@xmachines/play-dom/functions/renderSpec.md +12 -30
  22. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -6
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -15
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -8
  29. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +28 -0
  30. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -5
  31. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  34. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +44 -0
  38. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  45. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  48. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  51. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  52. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  53. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +16 -6
  54. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +7 -3
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +16 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +6 -6
  60. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  61. package/api/@xmachines/play-react/README.md +6 -6
  62. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  63. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  65. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  66. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  70. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  71. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  72. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  73. package/api/@xmachines/play-react/functions/useSignalEffect.md +28 -26
  74. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  75. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  76. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  80. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  81. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  85. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  87. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  89. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  90. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  91. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  92. package/api/@xmachines/play-react-router/README.md +10 -1
  93. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +45 -32
  94. package/api/@xmachines/play-react-router/classes/RouteMap.md +17 -5
  95. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
  96. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  97. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
  98. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  99. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +16 -6
  100. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  102. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  103. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  104. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +6 -6
  105. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  106. package/api/@xmachines/play-react-router/{functions → variables}/PlayRouterProvider.md +6 -6
  107. package/api/@xmachines/play-router/README.md +6 -8
  108. package/api/@xmachines/play-router/classes/RouteMap.md +17 -5
  109. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +50 -37
  110. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  111. package/api/@xmachines/play-router/functions/buildRouteTree.md +11 -1
  112. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  113. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
  114. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +13 -6
  115. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  116. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractRouteParams.md +9 -1
  118. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  119. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  120. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  121. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  122. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +7 -2
  123. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  124. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  125. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  126. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  127. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  128. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  129. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  130. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  131. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  132. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  133. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  134. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +16 -6
  135. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  136. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  137. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  138. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  139. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  140. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  141. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  142. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  143. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  144. package/api/@xmachines/play-router/interfaces/RouterBridge.md +6 -6
  145. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  146. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  147. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  148. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  149. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -2
  150. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  151. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -2
  152. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  153. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  154. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  155. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  156. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  169. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  170. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  171. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  172. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  173. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  174. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  177. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  179. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  184. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  189. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  190. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  191. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  192. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  195. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  196. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  199. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  200. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  201. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  204. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  205. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  206. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  207. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  208. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  209. package/api/@xmachines/play-solid-router/README.md +7 -1
  210. package/api/@xmachines/play-solid-router/classes/RouteMap.md +17 -5
  211. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +40 -33
  212. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
  213. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  214. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  215. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  216. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +16 -6
  217. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
  218. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +17 -7
  219. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  220. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  221. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +6 -6
  222. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
  223. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  224. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  225. package/api/@xmachines/play-solid-router/{functions → variables}/PlayRouterProvider.md +6 -6
  226. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  227. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  228. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  229. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  230. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  231. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  232. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  233. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  234. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  235. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  236. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  237. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  239. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  240. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  241. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  242. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  243. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +17 -5
  244. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  245. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +16 -6
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +6 -6
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  252. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  253. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +17 -5
  254. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  255. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  256. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  257. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  258. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +16 -6
  259. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  261. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  263. package/api/@xmachines/play-tanstack-react-router/README.md +7 -1
  264. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +17 -5
  265. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +69 -52
  266. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
  267. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  268. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
  269. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  270. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +16 -6
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +6 -6
  278. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +12 -4
  281. package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md +8 -6
  282. package/api/@xmachines/play-tanstack-router/README.md +58 -0
  283. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +511 -0
  284. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
  285. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
  286. package/api/@xmachines/play-tanstack-solid-router/README.md +7 -1
  287. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +17 -5
  288. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +106 -79
  289. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
  290. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  291. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +16 -6
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +15 -7
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +6 -6
  298. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +30 -7
  302. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
  303. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  304. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  305. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  306. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  307. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  308. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  309. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  310. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  311. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  312. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  313. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  314. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  315. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  317. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  318. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  319. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  320. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  321. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  322. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  323. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  324. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  325. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  326. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  327. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  328. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  329. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  330. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  331. package/api/@xmachines/play-vue-router/classes/RouteMap.md +17 -5
  332. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +74 -63
  333. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  334. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  335. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +16 -6
  336. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  337. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  338. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +6 -6
  339. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  340. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +3 -3
  341. package/api/@xmachines/play-xstate/classes/PlayerActor.md +72 -169
  342. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  343. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  344. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  345. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  346. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  347. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  348. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  349. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  350. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  351. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  352. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  353. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  354. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  355. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  356. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  357. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  358. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  359. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  360. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  361. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  362. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  363. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  364. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  365. package/api/@xmachines/shared/vite-aliases/README.md +1 -0
  366. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +7 -3
  367. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  368. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  369. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +6 -5
  370. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
  371. package/api/@xmachines/shared/vitest/README.md +5 -0
  372. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
  373. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  374. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
  375. package/api/README.md +1 -0
  376. package/api/llms.txt +4 -3
  377. package/contributing/architecture.md +74 -74
  378. package/contributing/configuration.md +2 -17
  379. package/contributing/deployment.md +8 -8
  380. package/contributing/development.md +2 -2
  381. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  382. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  383. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  384. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  385. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  386. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  387. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  388. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  389. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  390. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  396. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  397. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  398. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  399. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  400. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  401. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  402. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  403. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  404. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  405. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  406. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  407. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  408. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  413. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  414. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  415. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  416. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  417. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  418. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  419. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  420. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  421. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  422. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  423. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  424. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  425. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  426. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  430. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  431. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  432. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  433. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  434. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  435. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  436. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  437. package/guides/README.md +6 -44
  438. package/guides/getting-started.md +37 -37
  439. package/package.json +6 -3
  440. package/api/@xmachines/play-router/functions/createRouteMatcher.md +0 -53
  441. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +0 -56
  442. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -33
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L101)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -17,10 +17,17 @@ own and inherit the full public API from here.
17
17
  - Results are cached after the first match in an LRU cache (default 500 entries,
18
18
  configurable via the `cacheSize` constructor option)
19
19
 
20
- **Pattern syntax** (`:param` / `:param?`):
20
+ **Pattern syntax** (`:param` / `:param?` / `*`):
21
21
 
22
22
  - `:param` — required segment, matches exactly one non-`/` segment
23
23
  - `:param?` — optional segment, matches zero or one non-`/` segment
24
+ - `*` — wildcard, matches any number of segments (URLPattern semantics)
25
+
26
+ **StateId forms:** stateIds may be registered and looked up in either
27
+ `"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
28
+ `getStateIdByPath` returns the stateId exactly as registered;
29
+ `getPathByStateId` accepts both forms. Registering the same stateId in both
30
+ forms refers to one entry (the later registration wins for reverse lookup).
24
31
 
25
32
  ## Example
26
33
 
@@ -50,7 +57,7 @@ map.getPathByStateId("missing"); // null
50
57
  new RouteMap(mappings, options?): RouteMap;
51
58
  ```
52
59
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L125)
60
+ Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L127)
54
61
 
55
62
  Build a route map from an array of state ID ↔ path mappings.
56
63
 
@@ -78,10 +85,14 @@ buckets for efficient candidate selection.
78
85
  getPathByStateId(stateId): string | null;
79
86
  ```
80
87
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L209)
88
+ Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L218)
82
89
 
83
90
  Look up the path pattern registered for a state ID.
84
91
 
92
+ Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
93
+ which form was used at registration — lookups are canonicalized internally,
94
+ so consumers never need to try both forms.
95
+
85
96
  #### Parameters
86
97
 
87
98
  | Parameter | Type | Description |
@@ -98,6 +109,7 @@ The registered path pattern, or `null` if the state ID is unknown
98
109
 
99
110
  ```typescript
100
111
  map.getPathByStateId("profile"); // "/profile/:userId"
112
+ map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
101
113
  map.getPathByStateId("missing"); // null
102
114
  ```
103
115
 
@@ -109,7 +121,7 @@ map.getPathByStateId("missing"); // null
109
121
  getStateIdByPath(path): string | null;
110
122
  ```
111
123
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L174)
124
+ Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L178)
113
125
 
114
126
  Resolve a URL path to its mapped state ID.
115
127
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L27)
9
+ Defined in: [play-sveltekit-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-sveltekit-router/src/connect-router.ts#L27)
10
10
 
11
11
  Connect SvelteKit router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-sveltekit-router/src/connect-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L4)
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-sveltekit-router/src/connect-router.ts#L4)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------ | ---------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | - | [play-sveltekit-router/src/connect-router.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L5) |
12
- | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L11) |
13
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/connect-router.ts#L6) |
11
+ | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | - | [play-sveltekit-router/src/connect-router.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-sveltekit-router/src/connect-router.ts#L5) |
12
+ | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | Location-like object for initial URL reads. Defaults to `globalThis.location`. Pass a mock in tests or a stub in SSR environments. | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-sveltekit-router/src/connect-router.ts#L11) |
13
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-sveltekit-router/src/connect-router.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-sveltekit-router/src/connect-router.ts#L6) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [play-router/src/types.ts:414](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L414)
5
+ Defined in: [play-router/src/types.ts:414](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L414)
6
6
 
7
7
  Minimal location interface required by adapters that read the current URL at
8
8
  `connect()` time. Injectable for SSR and testing — pass a mock instead of the
@@ -23,5 +23,5 @@ connectRouter({ actor, routeMap, location: mockLoc });
23
23
 
24
24
  | Property | Modifier | Type | Defined in |
25
25
  | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:415](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L415) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:416](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L416) |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:415](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L415) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:416](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L416) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -22,22 +22,32 @@ via `play.route` events, Actor decides via state machine transitions.
22
22
 
23
23
  ## Param
24
24
 
25
+ **type**
26
+
25
27
  Event discriminator (always "play.route")
26
28
 
27
29
  ## Param
28
30
 
31
+ **to**
32
+
29
33
  Target state ID with # prefix (e.g., '#home', '#profile')
30
34
 
31
35
  ## Param
32
36
 
37
+ **params**
38
+
33
39
  Path-only route parameters extracted from the URL path (e.g., `{ userId: '123' }` from `/profile/123`). Query parameters are kept separate in `query`.
34
40
 
35
41
  ## Param
36
42
 
43
+ **query**
44
+
37
45
  Query parameters only (isolated from path params)
38
46
 
39
47
  ## Param
40
48
 
49
+ **match**
50
+
41
51
  Full URLPattern match result for debugging/observability (optional)
42
52
 
43
53
  ## Examples
@@ -112,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
122
 
113
123
  | Property | Modifier | Type | Defined in |
114
124
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L230) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L228) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L229) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L227) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L226) |
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.54/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.54/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.54/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.54/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.54/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/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:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L341)
5
+ Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
9
- Defines the lifecycle connection between Infrastructure (e.g., TanStack Router) and
9
+ Defines the lifecycle connection between Infrastructure (e.g., a framework router) and
10
10
  the Actor. Infrastructure "bridges" to the Actor by observing its signals and
11
11
  managing its own lifecycle accordingly.
12
12
 
@@ -16,13 +16,13 @@ a unidirectional observation pattern. Infrastructure connects to observe Actor s
16
16
 
17
17
  ## Example
18
18
 
19
- TanStack Router bridge implementation
19
+ Framework router bridge implementation
20
20
 
21
21
  ```typescript
22
22
  import type { RouterBridge } from "@xmachines/play-router";
23
23
  import { Signal } from "@xmachines/play-signals";
24
24
 
25
- class TanStackRouterBridge implements RouterBridge {
25
+ class MyRouterBridge implements RouterBridge {
26
26
  private watcher: Signal.Watcher | null = null;
27
27
 
28
28
  async connect(): Promise<void> {
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L357)
57
+ Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L357)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L373)
86
+ Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-sveltekit-router/src/types.ts#L10)
9
+ Defined in: [play-sveltekit-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-sveltekit-router/src/types.ts#L10)
@@ -230,6 +230,7 @@ Synchronizes browser URL with actor state through passive infrastructure.
230
230
 
231
231
  - [PlayActor](interfaces/PlayActor.md)
232
232
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
233
+ - [PlayRouterProviderBaseProps](interfaces/PlayRouterProviderBaseProps.md)
233
234
  - [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
234
235
  - [RouteMapOptions](interfaces/RouteMapOptions.md)
235
236
  - [RouteMapping](interfaces/RouteMapping.md)
@@ -238,12 +239,17 @@ Synchronizes browser URL with actor state through passive infrastructure.
238
239
 
239
240
  ## Type Aliases
240
241
 
242
+ - [PlayRouterBridgeConstructor](type-aliases/PlayRouterBridgeConstructor.md)
241
243
  - [TanStackRouterInstance](type-aliases/TanStackRouterInstance.md)
242
244
  - [TanStackRouterLike](type-aliases/TanStackRouterLike.md)
243
245
 
246
+ ## Variables
247
+
248
+ - [PlayRouterProvider](variables/PlayRouterProvider.md)
249
+
244
250
  ## Functions
245
251
 
252
+ - [createPlayRouterProvider](functions/createPlayRouterProvider.md)
246
253
  - [createRouteMap](functions/createRouteMap.md)
247
254
  - [createRouteMapFromTree](functions/createRouteMapFromTree.md)
248
255
  - [extractMachineRoutes](functions/extractMachineRoutes.md)
249
- - [PlayRouterProvider](functions/PlayRouterProvider.md)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L101)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -17,10 +17,17 @@ own and inherit the full public API from here.
17
17
  - Results are cached after the first match in an LRU cache (default 500 entries,
18
18
  configurable via the `cacheSize` constructor option)
19
19
 
20
- **Pattern syntax** (`:param` / `:param?`):
20
+ **Pattern syntax** (`:param` / `:param?` / `*`):
21
21
 
22
22
  - `:param` — required segment, matches exactly one non-`/` segment
23
23
  - `:param?` — optional segment, matches zero or one non-`/` segment
24
+ - `*` — wildcard, matches any number of segments (URLPattern semantics)
25
+
26
+ **StateId forms:** stateIds may be registered and looked up in either
27
+ `"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
28
+ `getStateIdByPath` returns the stateId exactly as registered;
29
+ `getPathByStateId` accepts both forms. Registering the same stateId in both
30
+ forms refers to one entry (the later registration wins for reverse lookup).
24
31
 
25
32
  ## Example
26
33
 
@@ -50,7 +57,7 @@ map.getPathByStateId("missing"); // null
50
57
  new RouteMap(mappings, options?): RouteMap;
51
58
  ```
52
59
 
53
- Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L125)
60
+ Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L127)
54
61
 
55
62
  Build a route map from an array of state ID ↔ path mappings.
56
63
 
@@ -78,10 +85,14 @@ buckets for efficient candidate selection.
78
85
  getPathByStateId(stateId): string | null;
79
86
  ```
80
87
 
81
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L209)
88
+ Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L218)
82
89
 
83
90
  Look up the path pattern registered for a state ID.
84
91
 
92
+ Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
93
+ which form was used at registration — lookups are canonicalized internally,
94
+ so consumers never need to try both forms.
95
+
85
96
  #### Parameters
86
97
 
87
98
  | Parameter | Type | Description |
@@ -98,6 +109,7 @@ The registered path pattern, or `null` if the state ID is unknown
98
109
 
99
110
  ```typescript
100
111
  map.getPathByStateId("profile"); // "/profile/:userId"
112
+ map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
101
113
  map.getPathByStateId("missing"); // null
102
114
  ```
103
115
 
@@ -109,7 +121,7 @@ map.getPathByStateId("missing"); // null
109
121
  getStateIdByPath(path): string | null;
110
122
  ```
111
123
 
112
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L174)
124
+ Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L178)
113
125
 
114
126
  Resolve a URL path to its mapped state ID.
115
127