@xmachines/docs 1.0.0-beta.28 → 1.0.0-beta.29

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 (320) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +10 -4
  3. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  4. package/api/@xmachines/play-actor/README.md +6 -6
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +25 -3
  6. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  8. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  9. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  10. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  11. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  12. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  13. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  14. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  15. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  16. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  17. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  18. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  21. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  22. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  23. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  24. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  26. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  28. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  29. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  30. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  31. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  32. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  33. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  38. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  39. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  40. package/api/@xmachines/play-react/README.md +1 -1
  41. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +31 -5
  42. package/api/@xmachines/play-react/functions/defineRegistry.md +2 -0
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/useBoundProp.md +2 -0
  45. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  46. package/api/@xmachines/play-react/functions/useStateBinding.md +2 -0
  47. package/api/@xmachines/play-react/interfaces/ComponentContext.md +2 -0
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  49. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  50. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  51. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +2 -0
  52. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react-router/README.md +3 -3
  55. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  56. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  57. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  58. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  60. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  61. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  62. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  63. package/api/@xmachines/play-router/README.md +5 -5
  64. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  65. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  66. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  67. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  68. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  70. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  74. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  76. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  77. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  81. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  82. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  83. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  85. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  86. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  87. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  88. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  89. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  90. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  91. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  92. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  93. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  96. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  97. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  98. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  101. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  102. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  103. package/api/@xmachines/play-signals/README.md +2 -2
  104. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  105. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  107. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  108. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  109. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  110. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +6 -0
  111. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +8 -0
  112. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +2 -0
  113. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +10 -0
  114. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +2 -0
  115. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +2 -0
  116. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +2 -0
  117. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +2 -0
  118. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +2 -0
  119. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +2 -0
  120. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +2 -0
  121. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +2 -0
  122. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +2 -0
  123. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +2 -0
  124. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +2 -0
  125. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  126. package/api/@xmachines/play-solid/README.md +3 -3
  127. package/api/@xmachines/play-solid/functions/defineRegistry.md +2 -0
  128. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  129. package/api/@xmachines/play-solid/functions/useStateBinding.md +2 -0
  130. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +2 -0
  131. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  132. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +2 -0
  133. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  134. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-solid-router/README.md +1 -1
  136. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  137. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  138. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  140. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +23 -3
  141. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  142. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  143. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  144. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  145. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  146. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  147. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -0
  148. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +2 -0
  149. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +2 -0
  150. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  151. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +2 -0
  152. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +2 -0
  153. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +2 -0
  154. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  155. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  156. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  157. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  158. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  159. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  160. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  161. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  162. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  163. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  164. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  165. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  166. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  167. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  168. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  169. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  172. package/api/@xmachines/play-tanstack-react-router/README.md +4 -4
  173. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  174. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  175. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  176. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  177. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  178. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  179. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  180. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  182. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  183. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  184. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  185. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  186. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  187. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  188. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  189. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  190. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  191. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  192. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  193. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  195. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  196. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  197. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  198. package/api/@xmachines/play-vue/README.md +1 -1
  199. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  200. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  201. package/api/@xmachines/play-vue/functions/useStateBinding.md +2 -0
  202. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +2 -0
  203. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  204. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  205. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +2 -0
  206. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  207. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  208. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  209. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  210. package/api/@xmachines/play-vue-router/README.md +1 -1
  211. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  212. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  213. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  214. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  215. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  216. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  217. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  218. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  219. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-xstate/README.md +10 -10
  221. package/api/@xmachines/play-xstate/classes/PlayerActor.md +26 -12
  222. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  223. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  224. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  225. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  226. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  227. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  228. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  233. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  234. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  235. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  236. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  237. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  238. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  239. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  240. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  241. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  242. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  243. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  244. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  245. package/api/README.md +1 -41
  246. package/api/llms.txt +4 -8
  247. package/{api → examples}/@xmachines/play-actor-shared/README.md +1 -1
  248. package/{api → examples}/@xmachines/play-actor-shared/interfaces/AuthContext.md +5 -5
  249. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthActor.md +1 -1
  250. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +1 -1
  251. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +1 -1
  252. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthInput.md +1 -1
  253. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +1 -1
  254. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +11 -11
  255. package/{api → examples}/@xmachines/play-actor-shared/type-aliases/InferProps.md +1 -1
  256. package/{api → examples}/@xmachines/play-actor-shared/variables/authCatalog.md +1 -1
  257. package/{api → examples}/@xmachines/play-actor-shared/variables/authMachine.md +1 -1
  258. package/{api → examples}/@xmachines/play-actor-shared/variables/authSetup.md +1 -1
  259. package/{api → examples}/@xmachines/play-dom-demo/README.md +2 -2
  260. package/{api → examples}/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  261. package/{api → examples}/@xmachines/play-dom-demo/variables/About.md +1 -1
  262. package/{api → examples}/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  263. package/{api → examples}/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  264. package/{api → examples}/@xmachines/play-dom-demo/variables/Home.md +1 -1
  265. package/{api → examples}/@xmachines/play-dom-demo/variables/Login.md +1 -1
  266. package/{api → examples}/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  267. package/{api → examples}/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  268. package/{api → examples}/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  269. package/{api → examples}/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  270. package/{api → examples}/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  271. package/{api → examples}/@xmachines/play-dom-router-demo/README.md +3 -3
  272. package/{api → examples}/@xmachines/play-react-demo/README.md +2 -2
  273. package/{api → examples}/@xmachines/play-react-demo/functions/App.md +1 -1
  274. package/{api → examples}/@xmachines/play-react-demo/functions/DebugPanel.md +1 -1
  275. package/{api → examples}/@xmachines/play-react-demo/functions/HeaderNav.md +1 -1
  276. package/{api → examples}/@xmachines/play-react-demo/functions/Shell.md +1 -1
  277. package/{api → examples}/@xmachines/play-react-demo/variables/About.md +1 -1
  278. package/{api → examples}/@xmachines/play-react-demo/variables/Contact.md +1 -1
  279. package/{api → examples}/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  280. package/{api → examples}/@xmachines/play-react-demo/variables/Home.md +1 -1
  281. package/{api → examples}/@xmachines/play-react-demo/variables/Login.md +1 -1
  282. package/{api → examples}/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  283. package/{api → examples}/@xmachines/play-react-demo/variables/Overview.md +1 -1
  284. package/{api → examples}/@xmachines/play-react-demo/variables/Profile.md +1 -1
  285. package/{api → examples}/@xmachines/play-react-demo/variables/Settings.md +1 -1
  286. package/{api → examples}/@xmachines/play-react-demo/variables/Stats.md +1 -1
  287. package/{api → examples}/@xmachines/play-react-router-demo/README.md +2 -2
  288. package/examples/@xmachines/play-router-shared/README.md +111 -0
  289. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +3 -0
  290. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +11 -0
  291. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +19 -0
  292. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +19 -0
  293. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +8 -0
  294. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +63 -0
  295. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +32 -0
  296. package/{api → examples}/@xmachines/play-solid-demo/README.md +3 -3
  297. package/{api → examples}/@xmachines/play-solid-demo/functions/App.md +1 -1
  298. package/{api → examples}/@xmachines/play-solid-demo/functions/DebugPanel.md +1 -1
  299. package/{api → examples}/@xmachines/play-solid-demo/functions/HeaderNav.md +1 -1
  300. package/{api → examples}/@xmachines/play-solid-demo/functions/Shell.md +1 -1
  301. package/{api → examples}/@xmachines/play-solid-demo/variables/About.md +1 -1
  302. package/{api → examples}/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  303. package/{api → examples}/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  304. package/{api → examples}/@xmachines/play-solid-demo/variables/Home.md +1 -1
  305. package/{api → examples}/@xmachines/play-solid-demo/variables/Login.md +1 -1
  306. package/{api → examples}/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  307. package/{api → examples}/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  308. package/{api → examples}/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  309. package/{api → examples}/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  310. package/{api → examples}/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  311. package/{api → examples}/@xmachines/play-solid-router-demo/README.md +3 -3
  312. package/{api → examples}/@xmachines/play-svelte-demo/README.md +1 -1
  313. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +129 -0
  314. package/examples/@xmachines/play-sveltekit-router-demo/README.md +130 -0
  315. package/{api → examples}/@xmachines/play-tanstack-react-router-demo/README.md +3 -3
  316. package/{api → examples}/@xmachines/play-tanstack-solid-router-demo/README.md +4 -4
  317. package/{api → examples}/@xmachines/play-vue-demo/README.md +2 -2
  318. package/{api → examples}/@xmachines/play-vue-router-demo/README.md +2 -2
  319. package/examples/README.md +51 -27
  320. package/package.json +6 -4
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Class: State\<T\>
4
4
 
5
+ Defined in: `signal-polyfill`
6
+
5
7
  ## Type Parameters
6
8
 
7
9
  | Type Parameter |
@@ -16,6 +18,8 @@
16
18
  new State<T>(initialValue, options?): State<T>;
17
19
  ```
18
20
 
21
+ Defined in: `signal-polyfill`
22
+
19
23
  #### Parameters
20
24
 
21
25
  | Parameter | Type |
@@ -41,6 +45,8 @@ new State<T>(initialValue, options?): State<T>;
41
45
  get(): T;
42
46
  ```
43
47
 
48
+ Defined in: `signal-polyfill`
49
+
44
50
  #### Returns
45
51
 
46
52
  `T`
@@ -53,6 +59,8 @@ get(): T;
53
59
  set(newValue): void;
54
60
  ```
55
61
 
62
+ Defined in: `signal-polyfill`
63
+
56
64
  #### Parameters
57
65
 
58
66
  | Parameter | Type |
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Interface: Options\<T\>
4
4
 
5
+ Defined in: `signal-polyfill`
6
+
5
7
  ## Type Parameters
6
8
 
7
9
  | Type Parameter |
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Class: Watcher
4
4
 
5
+ Defined in: `signal-polyfill`
6
+
5
7
  ## Constructors
6
8
 
7
9
  ### Constructor
@@ -10,6 +12,8 @@
10
12
  new Watcher(notify): Watcher;
11
13
  ```
12
14
 
15
+ Defined in: `signal-polyfill`
16
+
13
17
  #### Parameters
14
18
 
15
19
  | Parameter | Type |
@@ -34,6 +38,8 @@ new Watcher(notify): Watcher;
34
38
  getPending(): Computed<any>[];
35
39
  ```
36
40
 
41
+ Defined in: `signal-polyfill`
42
+
37
43
  #### Returns
38
44
 
39
45
  [`Computed`](../../../classes/Computed.md)\<`any`\>[]
@@ -46,6 +52,8 @@ getPending(): Computed<any>[];
46
52
  unwatch(...signals): void;
47
53
  ```
48
54
 
55
+ Defined in: `signal-polyfill`
56
+
49
57
  #### Parameters
50
58
 
51
59
  | Parameter | Type |
@@ -64,6 +72,8 @@ unwatch(...signals): void;
64
72
  watch(...signals): void;
65
73
  ```
66
74
 
75
+ Defined in: `signal-polyfill`
76
+
67
77
  #### Parameters
68
78
 
69
79
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  function currentComputed(): Computed<any> | undefined;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Returns
10
12
 
11
13
  [`Computed`](../../../classes/Computed.md)\<`any`\> \| `undefined`
@@ -6,6 +6,8 @@
6
6
  function hasSinks(signal): boolean;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  function hasSources(signal): boolean;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  function introspectSinks(signal): AnySink[];
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  function introspectSources(sink): AnySignal<any>[];
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  function untrack<T>(cb): T;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Type Parameters
10
12
 
11
13
  | Type Parameter |
@@ -5,3 +5,5 @@
5
5
  ```ts
6
6
  const unwatched: unique symbol;
7
7
  ```
8
+
9
+ Defined in: `signal-polyfill`
@@ -5,3 +5,5 @@
5
5
  ```ts
6
6
  const watched: unique symbol;
7
7
  ```
8
+
9
+ Defined in: `signal-polyfill`
@@ -6,6 +6,8 @@
6
6
  isComputed: (s) => boolean;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  isState: (s) => boolean;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,6 +6,8 @@
6
6
  isWatcher: (s) => boolean;
7
7
  ```
8
8
 
9
+ Defined in: `signal-polyfill`
10
+
9
11
  ## Parameters
10
12
 
11
13
  | Parameter | Type |
@@ -6,7 +6,7 @@
6
6
  type WatcherNotify = () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-signals/src/types.ts#L139)
9
+ Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-signals/src/types.ts#L139)
10
10
 
11
11
  Notification callback for Signal.subtle.Watcher
12
12
 
@@ -2,9 +2,9 @@
2
2
 
3
3
  # @xmachines/play-solid
4
4
 
5
- **SolidJS renderer for XMachines Play Architecture**
5
+ **Solid renderer for XMachines Play Architecture**
6
6
 
7
- Bridges TC39 Signal-driven actors to SolidJS's fine-grained reactivity. Business logic stays in the actor; Solid is purely a rendering target.
7
+ Bridges TC39 Signal-driven actors to Solid's fine-grained reactivity. Business logic stays in the actor; Solid is purely a rendering target.
8
8
 
9
9
  ## Overview
10
10
 
@@ -15,7 +15,7 @@ Bridges TC39 Signal-driven actors to SolidJS's fine-grained reactivity. Business
15
15
  - Routes action names from spec elements to `actor.send()` via the `actions` prop
16
16
  - Manages per-view UI state in an `@xstate/store` atom (automatic or caller-supplied)
17
17
 
18
- Per [Play RFC](../../../rfc/play.md):
18
+ Per [Play RFC](../docs/rfc/play.md):
19
19
 
20
20
  - **Actor Authority (INV-01):** Guards in the machine decide all state transitions
21
21
  - **Passive Infrastructure (INV-04):** Solid observes signals and dispatches events — never decides
@@ -6,6 +6,8 @@
6
6
  function defineRegistry<C>(_catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
+ Defined in: `@json-render/solid`
10
+
9
11
  Create a registry from a catalog with components and/or actions.
10
12
 
11
13
  When the catalog declares actions, the `actions` field is required.
@@ -6,7 +6,7 @@
6
6
  function useActor(): PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/useActor.ts#L49)
9
+ Defined in: [packages/play-solid/src/useActor.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/useActor.ts#L49)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,6 +6,8 @@
6
6
  function useStateBinding<T>(path): [Accessor<T | undefined>, (value) => void];
7
7
  ```
8
8
 
9
+ Defined in: `@json-render/solid`
10
+
9
11
  ## Type Parameters
10
12
 
11
13
  | Type Parameter |
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Interface: ComponentContext\<C, K\>
4
4
 
5
+ Defined in: `@json-render/solid`
6
+
5
7
  Context passed to component render functions
6
8
 
7
9
  ## Example
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-solid/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L29)
5
+ Defined in: [packages/play-solid/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L29)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
@@ -16,9 +16,9 @@ Props for PlayRenderer component
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-actions"></a> `actions?` | `object` | Optional mapping of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified. | [packages/play-solid/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L65) |
20
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-solid/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L31) |
21
- | <a id="property-fallback"></a> `fallback?` | `any` | Optional element shown when currentView is null or a component throws | [packages/play-solid/src/types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L37) |
22
- | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when a catalog component throws during render. Receives the thrown error — use to forward to Sentry, Datadog, etc. | [packages/play-solid/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L49) |
23
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from @json-render/solid defineRegistry() | [packages/play-solid/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L34) |
24
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-solid/src/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/types.ts#L58) |
19
+ | <a id="property-actions"></a> `actions?` | `object` | Optional mapping of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified. | [packages/play-solid/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L65) |
20
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-solid/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L31) |
21
+ | <a id="property-fallback"></a> `fallback?` | `any` | Optional element shown when currentView is null or a component throws | [packages/play-solid/src/types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L37) |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`) => `void` | Optional callback invoked when a catalog component throws during render. Receives the thrown error — use to forward to Sentry, Datadog, etc. | [packages/play-solid/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L49) |
23
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from @json-render/solid defineRegistry() | [packages/play-solid/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L34) |
24
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-solid/src/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/types.ts#L58) |
@@ -6,6 +6,8 @@
6
6
  type ComponentFn<C, K> = (ctx) => JSX.Element;
7
7
  ```
8
8
 
9
+ Defined in: `@json-render/solid`
10
+
9
11
  Component render function type for Solid
10
12
 
11
13
  ## Type Parameters
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/useActor.ts#L26)
9
+ Defined in: [packages/play-solid/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/useActor.ts#L26)
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: Component<PlayRendererProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/PlayRenderer.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid/src/PlayRenderer.tsx#L55)
9
+ Defined in: [packages/play-solid/src/PlayRenderer.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/src/PlayRenderer.tsx#L55)
10
10
 
11
11
  Main renderer component that subscribes to actor signals and renders UI
12
12
 
@@ -10,7 +10,7 @@ SolidJS Router adapter using `RouterBridgeBase` for consistent actor↔router sy
10
10
 
11
11
  `@xmachines/play-solid-router` provides seamless integration between SolidJS Router and XMachines state machines. Built on Solid's reactive primitives, it enables zero-adaptation signals synchronization.
12
12
 
13
- Per [Play RFC](../../../rfc/play.md), this package implements:
13
+ Per [Play RFC](../docs/rfc/play.md), this package implements:
14
14
 
15
15
  - **Actor Authority (INV-01):** State machine controls navigation, router reflects decisions
16
16
  - **Passive Infrastructure (INV-04):** Router observes `actor.currentRoute` signal
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  new RouteMap(mappings, options?): BaseRouteMap;
51
51
  ```
52
52
 
53
- Defined in: [packages/play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [packages/play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L125)
54
54
 
55
55
  Build a route map from an array of state ID ↔ path mappings.
56
56
 
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
78
78
  getPathByStateId(stateId): string | null;
79
79
  ```
80
80
 
81
- Defined in: [packages/play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [packages/play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L209)
82
82
 
83
83
  Look up the path pattern registered for a state ID.
84
84
 
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
109
109
  getStateIdByPath(path): string | null;
110
110
  ```
111
111
 
112
- Defined in: [packages/play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [packages/play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L174)
113
113
 
114
114
  Resolve a URL path to its mapped state ID.
115
115
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L55)
5
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L55)
6
6
 
7
7
  SolidJS Router integration bridge extending RouterBridgeBase
8
8
 
@@ -31,7 +31,7 @@ new SolidRouterBridge(
31
31
  routeMap): SolidRouterBridge;
32
32
  ```
33
33
 
34
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L76)
34
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L76)
35
35
 
36
36
  Create a SolidJS Router bridge
37
37
 
@@ -59,15 +59,15 @@ Create a SolidJS Router bridge
59
59
 
60
60
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
61
61
  | --------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
62
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [packages/play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L99) |
63
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L87) |
64
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L86) |
65
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L89) |
66
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L88) |
67
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [packages/play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L100) |
68
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L102) |
69
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L101) |
70
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [packages/play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L90) |
62
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [packages/play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L99) |
63
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L87) |
64
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L86) |
65
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L89) |
66
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L88) |
67
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [packages/play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L100) |
68
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L102) |
69
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L101) |
70
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [packages/play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L90) |
71
71
 
72
72
  ## Methods
73
73
 
@@ -77,7 +77,7 @@ Create a SolidJS Router bridge
77
77
  connect(): void;
78
78
  ```
79
79
 
80
- Defined in: [packages/play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L126)
80
+ Defined in: [packages/play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L126)
81
81
 
82
82
  Connect the router bridge to the Actor.
83
83
 
@@ -109,7 +109,7 @@ Adapters that need custom initial-sync behavior should override
109
109
  disconnect(): void;
110
110
  ```
111
111
 
112
- Defined in: [packages/play-router/src/router-bridge-base.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L209)
112
+ Defined in: [packages/play-router/src/router-bridge-base.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L209)
113
113
 
114
114
  Disconnect the router bridge from the Actor.
115
115
 
@@ -131,7 +131,7 @@ Stops signal watching and unregisters framework-specific router listener.
131
131
  dispose(): void;
132
132
  ```
133
133
 
134
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L188)
134
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L188)
135
135
 
136
136
  Dispose the bridge (alias for disconnect).
137
137
 
@@ -153,7 +153,7 @@ onCleanup(() => bridge.dispose());
153
153
  protected extractParams(pathname, stateId): Record<string, string>;
154
154
  ```
155
155
 
156
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L105)
156
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L105)
157
157
 
158
158
  Extract path parameters using Solid's pre-parsed `useParams()` values.
159
159
 
@@ -190,7 +190,7 @@ Normalized path parameters with undefined/empty values filtered out
190
190
  protected extractQuery(search): Record<string, string>;
191
191
  ```
192
192
 
193
- Defined in: [packages/play-router/src/router-bridge-base.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L355)
193
+ Defined in: [packages/play-router/src/router-bridge-base.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L355)
194
194
 
195
195
  Extract query parameters from URL search string.
196
196
 
@@ -218,7 +218,7 @@ Extracted query parameters or empty object
218
218
  protected getInitialRouterPath(): string | null;
219
219
  ```
220
220
 
221
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L127)
221
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L127)
222
222
 
223
223
  Get the current router pathname for initial URL -> actor sync on connect.
224
224
 
@@ -238,7 +238,7 @@ Get the current router pathname for initial URL -> actor sync on connect.
238
238
  protected getInitialRouterSearch(): string | undefined;
239
239
  ```
240
240
 
241
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L138)
241
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L138)
242
242
 
243
243
  Return the initial URL search string for query-param forwarding on `connect()`.
244
244
 
@@ -262,7 +262,7 @@ params) returns `undefined` so `syncActorFromRouter` produces `query: {}`.
262
262
  protected navigateRouter(path): void;
263
263
  ```
264
264
 
265
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L120)
265
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L120)
266
266
 
267
267
  Navigate SolidJS Router to the given path.
268
268
 
@@ -288,7 +288,7 @@ Navigate SolidJS Router to the given path.
288
288
  protected resolveNavigationPath(route): string | null;
289
289
  ```
290
290
 
291
- Defined in: [packages/play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L340)
291
+ Defined in: [packages/play-router/src/router-bridge-base.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L340)
292
292
 
293
293
  Resolve an actor route value to a concrete URL path for navigation.
294
294
 
@@ -327,7 +327,7 @@ Concrete URL path, or `null` if navigation should be skipped
327
327
  protected syncActorFromRouter(pathname, search?): void;
328
328
  ```
329
329
 
330
- Defined in: [packages/play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L260)
330
+ Defined in: [packages/play-router/src/router-bridge-base.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L260)
331
331
 
332
332
  Sync actor state when router location changes.
333
333
 
@@ -357,7 +357,7 @@ Prevents circular updates via isProcessingNavigation flag.
357
357
  protected syncRouterFromActor(route): void;
358
358
  ```
359
359
 
360
- Defined in: [packages/play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/router-bridge-base.ts#L240)
360
+ Defined in: [packages/play-router/src/router-bridge-base.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/router-bridge-base.ts#L240)
361
361
 
362
362
  Sync router location when actor route signal changes.
363
363
 
@@ -390,7 +390,7 @@ suppressed as circular echoes.
390
390
  protected unwatchRouterChanges(): void;
391
391
  ```
392
392
 
393
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L175)
393
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L175)
394
394
 
395
395
  Stop watching SolidJS Router changes.
396
396
 
@@ -414,7 +414,7 @@ cleanup path — component unmount does NOT trigger this automatically.
414
414
  protected watchRouterChanges(): void;
415
415
  ```
416
416
 
417
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/solid-router-bridge.ts#L153)
417
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/solid-router-bridge.ts#L153)
418
418
 
419
419
  Subscribe to SolidJS Router location changes using createEffect.
420
420
 
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(props): any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-solid-router/src/play-router-provider.tsx#L41)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L41)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [packages/play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/create-route-map-from-machine.ts#L26)
10
10
 
11
11
  Create a `BaseRouteMap` from an XState state machine.
12
12