@xmachines/docs 1.0.0-beta.27 → 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 (288) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -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 +3 -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/README.md +50 -0
  12. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  13. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  14. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  15. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  16. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  17. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  20. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  23. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  24. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  27. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  29. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  30. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  31. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  32. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  33. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  34. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  35. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  38. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  39. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  40. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  41. package/api/@xmachines/play-react/README.md +1 -1
  42. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  43. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  44. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  45. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  46. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  47. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  48. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  49. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  50. package/api/@xmachines/play-react-router/README.md +3 -3
  51. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  52. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  53. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  54. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  55. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  56. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  57. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  58. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  59. package/api/@xmachines/play-router/README.md +6 -6
  60. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  61. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  62. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  63. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  64. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  65. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  66. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  68. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  69. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  70. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  71. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  72. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  73. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  74. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  75. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  76. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  77. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  78. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  79. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  80. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  81. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  82. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  83. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  84. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  85. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  86. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  87. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  88. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  89. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  91. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  92. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  93. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  94. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  96. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  97. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  98. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  99. package/api/@xmachines/play-signals/README.md +2 -2
  100. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  101. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  102. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  103. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  104. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  105. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  106. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  107. package/api/@xmachines/play-solid/README.md +3 -3
  108. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  109. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  110. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  111. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  112. package/api/@xmachines/play-solid-router/README.md +1 -1
  113. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  114. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  115. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  116. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  117. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  118. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  119. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  120. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  121. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  122. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  123. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  124. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +7 -7
  125. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  126. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  127. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  129. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  130. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  131. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  132. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  133. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  135. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  136. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  137. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  138. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  139. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  140. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  141. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  142. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-tanstack-react-router/README.md +4 -4
  144. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  146. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  147. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  148. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  149. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  150. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  151. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  152. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  153. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  154. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  155. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  156. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  157. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  158. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  160. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  161. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  163. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  164. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  165. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  166. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  168. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  169. package/api/@xmachines/play-vue/README.md +1 -1
  170. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  171. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  172. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  173. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  174. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  175. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  176. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  177. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  178. package/api/@xmachines/play-vue-router/README.md +1 -1
  179. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  180. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  181. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  182. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  183. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  184. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  185. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  186. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  187. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  188. package/api/@xmachines/play-xstate/README.md +10 -10
  189. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  190. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  191. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  192. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  193. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  195. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  196. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  199. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  200. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  201. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  202. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  203. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  204. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  205. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  206. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  207. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  208. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  209. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  210. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  211. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  212. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  213. package/api/README.md +1 -37
  214. package/api/llms.txt +4 -11
  215. package/examples/@xmachines/play-actor-shared/README.md +155 -0
  216. package/examples/@xmachines/play-actor-shared/interfaces/AuthContext.md +14 -0
  217. package/examples/@xmachines/play-actor-shared/type-aliases/AuthActor.md +27 -0
  218. package/examples/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +16 -0
  219. package/examples/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +17 -0
  220. package/examples/@xmachines/play-actor-shared/type-aliases/AuthInput.md +9 -0
  221. package/examples/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +11 -0
  222. package/examples/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +187 -0
  223. package/examples/@xmachines/play-actor-shared/type-aliases/InferProps.md +17 -0
  224. package/examples/@xmachines/play-actor-shared/variables/authCatalog.md +173 -0
  225. package/examples/@xmachines/play-actor-shared/variables/authMachine.md +189 -0
  226. package/examples/@xmachines/play-actor-shared/variables/authSetup.md +22 -0
  227. package/examples/@xmachines/play-dom-demo/README.md +145 -0
  228. package/examples/@xmachines/play-dom-demo/functions/initShell.md +20 -0
  229. package/examples/@xmachines/play-dom-demo/variables/About.md +9 -0
  230. package/examples/@xmachines/play-dom-demo/variables/Contact.md +9 -0
  231. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +9 -0
  232. package/examples/@xmachines/play-dom-demo/variables/Home.md +9 -0
  233. package/examples/@xmachines/play-dom-demo/variables/Login.md +9 -0
  234. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +9 -0
  235. package/examples/@xmachines/play-dom-demo/variables/Overview.md +9 -0
  236. package/examples/@xmachines/play-dom-demo/variables/Profile.md +9 -0
  237. package/examples/@xmachines/play-dom-demo/variables/Settings.md +9 -0
  238. package/examples/@xmachines/play-dom-demo/variables/Stats.md +9 -0
  239. package/{api → examples}/@xmachines/play-dom-router-demo/README.md +13 -13
  240. package/examples/@xmachines/play-react-demo/README.md +173 -0
  241. package/examples/@xmachines/play-react-demo/functions/App.md +13 -0
  242. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +20 -0
  243. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +20 -0
  244. package/examples/@xmachines/play-react-demo/functions/Shell.md +22 -0
  245. package/examples/@xmachines/play-react-demo/variables/About.md +9 -0
  246. package/examples/@xmachines/play-react-demo/variables/Contact.md +9 -0
  247. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +9 -0
  248. package/examples/@xmachines/play-react-demo/variables/Home.md +9 -0
  249. package/examples/@xmachines/play-react-demo/variables/Login.md +9 -0
  250. package/examples/@xmachines/play-react-demo/variables/Navigation.md +9 -0
  251. package/examples/@xmachines/play-react-demo/variables/Overview.md +9 -0
  252. package/examples/@xmachines/play-react-demo/variables/Profile.md +9 -0
  253. package/examples/@xmachines/play-react-demo/variables/Settings.md +9 -0
  254. package/examples/@xmachines/play-react-demo/variables/Stats.md +9 -0
  255. package/{api → examples}/@xmachines/play-react-router-demo/README.md +12 -12
  256. package/examples/@xmachines/play-router-shared/README.md +111 -0
  257. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +3 -0
  258. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +11 -0
  259. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +19 -0
  260. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +19 -0
  261. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +8 -0
  262. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +63 -0
  263. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +32 -0
  264. package/examples/@xmachines/play-solid-demo/README.md +159 -0
  265. package/examples/@xmachines/play-solid-demo/functions/App.md +13 -0
  266. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +20 -0
  267. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +20 -0
  268. package/examples/@xmachines/play-solid-demo/functions/Shell.md +22 -0
  269. package/examples/@xmachines/play-solid-demo/variables/About.md +9 -0
  270. package/examples/@xmachines/play-solid-demo/variables/Contact.md +9 -0
  271. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +9 -0
  272. package/examples/@xmachines/play-solid-demo/variables/Home.md +9 -0
  273. package/examples/@xmachines/play-solid-demo/variables/Login.md +9 -0
  274. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +9 -0
  275. package/examples/@xmachines/play-solid-demo/variables/Overview.md +9 -0
  276. package/examples/@xmachines/play-solid-demo/variables/Profile.md +9 -0
  277. package/examples/@xmachines/play-solid-demo/variables/Settings.md +9 -0
  278. package/examples/@xmachines/play-solid-demo/variables/Stats.md +9 -0
  279. package/{api → examples}/@xmachines/play-solid-router-demo/README.md +13 -13
  280. package/examples/@xmachines/play-svelte-demo/README.md +127 -0
  281. package/{api → examples}/@xmachines/play-svelte-spa-router-demo/README.md +12 -13
  282. package/{api → examples}/@xmachines/play-sveltekit-router-demo/README.md +12 -13
  283. package/{api → examples}/@xmachines/play-tanstack-react-router-demo/README.md +13 -13
  284. package/{api → examples}/@xmachines/play-tanstack-solid-router-demo/README.md +14 -14
  285. package/examples/@xmachines/play-vue-demo/README.md +145 -0
  286. package/{api → examples}/@xmachines/play-vue-router-demo/README.md +12 -12
  287. package/examples/README.md +51 -27
  288. package/package.json +6 -4
@@ -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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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.27/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
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Interface: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-actor/src/abstract-actor.ts#L141)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/src/abstract-actor.ts#L141)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -33,7 +33,7 @@ Infrastructure layer communication.
33
33
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
34
34
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
35
35
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
36
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-actor/src/abstract-actor.ts#L151) |
36
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/src/abstract-actor.ts#L151) |
37
37
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
38
38
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
39
39
 
@@ -204,7 +204,7 @@ Actor.select;
204
204
  abstract send(event): void;
205
205
  ```
206
206
 
207
- Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-actor/src/abstract-actor.ts#L158)
207
+ Defined in: [packages/play-actor/src/abstract-actor.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-actor/src/abstract-actor.ts#L158)
208
208
 
209
209
  Send event to Actor.
210
210
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L223)
5
+ Defined in: [packages/play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -94,7 +94,7 @@ actor.send(event);
94
94
 
95
95
  ## See
96
96
 
97
- [Play RFC](../../../../rfc/play.md)
97
+ [Play RFC](../../docs/rfc/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L224) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L33)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L33)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,7 +14,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https:/
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
- | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L34) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L38) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L35) |
20
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L36) |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L34) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L38) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L35) |
20
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L36) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [packages/play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/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"`) | [packages/play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/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?"`) | [packages/play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/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"`) | [packages/play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/base-route-map.ts#L59) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L271)
5
+ Defined in: [packages/play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
44
44
 
45
45
  ## See
46
46
 
47
- [Play RFC](../../../../rfc/play.md) - Invariant INV-04
47
+ [Play RFC](../../docs/rfc/play.md) - Invariant INV-04
48
48
 
49
49
  ## Methods
50
50
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [packages/play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L287)
57
+ Defined in: [packages/play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [packages/play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L303)
86
+ Defined in: [packages/play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,6 +6,6 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L9)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L9)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
@@ -6,7 +6,7 @@
6
6
  type SolidRouterHooks = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L27)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L27)
10
10
 
11
11
  The three Solid Router hook results that `PlayRouterProvider` and `SolidRouterBridge`
12
12
  require. Pass these directly from your component's hook calls:
@@ -31,7 +31,7 @@ const params = useParams(); // → SolidRouterHooks.params
31
31
  location: Location;
32
32
  ```
33
33
 
34
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L29)
34
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L29)
35
35
 
36
36
  ---
37
37
 
@@ -41,7 +41,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https:/
41
41
  navigate: Navigator;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L28)
44
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L28)
45
45
 
46
46
  ---
47
47
 
@@ -51,4 +51,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https:/
51
51
  params: Params;
52
52
  ```
53
53
 
54
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-solid-router/src/play-router-provider.tsx#L30)
54
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid-router/src/play-router-provider.tsx#L30)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L13)
5
+ Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L13)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,9 +14,9 @@ Defined in: [packages/play-svelte/src/types.ts:13](https://gitlab.com/xmachin-es
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actions"></a> `actions?` | `object` | - | [packages/play-svelte/src/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L17) |
18
- | <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) | - | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L14) |
19
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render. | [packages/play-svelte/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L22) |
20
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature. | [packages/play-svelte/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L28) |
21
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | - | [packages/play-svelte/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L15) |
22
- | <a id="property-store"></a> `store?` | `StateStore` | - | [packages/play-svelte/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte/src/types.ts#L16) |
17
+ | <a id="property-actions"></a> `actions?` | `object` | - | [packages/play-svelte/src/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L17) |
18
+ | <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) | - | [packages/play-svelte/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L14) |
19
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | Svelte snippet rendered when currentView is null (no active view). Also shown when a catalog component throws during render. | [packages/play-svelte/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L22) |
20
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | Called when a catalog component throws during render. Receives the thrown error and a `reset` function that clears the boundary and attempts to re-render. Matches Svelte 5's `<svelte:boundary onerror>` signature. | [packages/play-svelte/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L28) |
21
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | - | [packages/play-svelte/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L15) |
22
+ | <a id="property-store"></a> `store?` | `StateStore` | - | [packages/play-svelte/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte/src/types.ts#L16) |
@@ -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.27/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/base-route-map.ts#L125)
53
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/base-route-map.ts#L209)
81
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/base-route-map.ts#L174)
112
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.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
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte-spa-router/src/connect-router.ts#L30)
9
+ Defined in: [play-svelte-spa-router/src/connect-router.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte-spa-router/src/connect-router.ts#L30)
10
10
 
11
11
  Connect svelte-spa-router to actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [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
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte-spa-router/src/connect-router.ts#L7)
5
+ Defined in: [play-svelte-spa-router/src/connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte-spa-router/src/connect-router.ts#L7)
6
6
 
7
7
  @xmachines/play-svelte-spa-router
8
8
 
@@ -12,6 +12,6 @@ Svelte SPA router adapter for XMachines Play architecture.
12
12
 
13
13
  | Property | Modifier | Type | Description | Defined in |
14
14
  | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | - | [play-svelte-spa-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte-spa-router/src/connect-router.ts#L8) |
16
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-svelte-spa-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte-spa-router/src/connect-router.ts#L9) |
17
- | <a id="property-window"></a> `window?` | `readonly` | [`WindowLike`](WindowLike.md) | Window-like object for `hashchange` subscriptions. Defaults to the global `window`. Pass a mock in tests or a no-op in SSR environments. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
15
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | - | [play-svelte-spa-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte-spa-router/src/connect-router.ts#L8) |
16
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | [play-svelte-spa-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte-spa-router/src/connect-router.ts#L9) |
17
+ | <a id="property-window"></a> `window?` | `readonly` | [`WindowLike`](WindowLike.md) | Window-like object for `hashchange` subscriptions. Defaults to the global `window`. Pass a mock in tests or a no-op in SSR environments. | [play-svelte-spa-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-svelte-spa-router/src/connect-router.ts#L14) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -94,7 +94,7 @@ actor.send(event);
94
94
 
95
95
  ## See
96
96
 
97
- [Play RFC](../../../../rfc/play.md)
97
+ [Play RFC](../../docs/rfc/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.27/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/src/types.ts#L224) |