@xmachines/docs 1.0.0 → 1.1.0

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 (357) hide show
  1. package/README.md +1 -3
  2. package/api/@xmachines/play/README.md +1 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  4. package/api/@xmachines/play/classes/PlayError.md +4 -4
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +22 -10
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +19 -3
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +3 -2
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  22. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  24. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  25. package/api/@xmachines/play-dom-router/README.md +3 -2
  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 +6 -6
  34. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  35. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  38. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  39. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  40. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  41. package/api/@xmachines/play-react/README.md +3 -2
  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/usePlayView.md +1 -1
  45. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  46. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  47. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  49. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  50. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  51. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  52. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  55. package/api/@xmachines/play-react-router/README.md +1 -2
  56. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  57. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  58. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  59. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  60. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  61. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  62. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  63. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  64. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  65. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  66. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  67. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  68. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  69. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  70. package/api/@xmachines/play-router/README.md +3 -2
  71. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  72. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  73. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  74. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  75. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  76. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  77. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  80. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  81. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  82. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  83. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  84. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  86. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  87. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  88. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  89. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  90. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  91. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  92. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  93. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  96. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  98. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  101. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  102. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  104. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  105. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  106. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  107. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  108. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  110. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  111. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  112. package/api/@xmachines/play-signals/README.md +3 -2
  113. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  114. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  115. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  116. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  117. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  118. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  119. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  120. package/api/@xmachines/play-solid/README.md +3 -2
  121. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  122. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  123. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  124. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  125. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  126. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  127. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  128. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  129. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  130. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  131. package/api/@xmachines/play-solid-router/README.md +3 -2
  132. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  133. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  134. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  135. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  136. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +19 -3
  137. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  138. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  139. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  140. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  141. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  142. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  143. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  144. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  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-solid-router/variables/PlayRouterProvider.md +1 -1
  148. package/api/@xmachines/play-svelte/README.md +3 -2
  149. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  150. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  151. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  152. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  153. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  154. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  155. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  156. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  157. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  158. package/api/@xmachines/play-svelte-spa-router/README.md +1 -3
  159. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  160. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  161. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  163. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  164. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  165. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  166. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  167. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  168. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  169. package/api/@xmachines/play-sveltekit-router/README.md +3 -2
  170. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  171. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  172. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  173. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  174. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  175. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  176. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  177. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  178. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  179. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  180. package/api/@xmachines/play-tanstack-react-router/README.md +3 -2
  181. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  182. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  183. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  184. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  185. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  186. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  187. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  188. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  189. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  190. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  191. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  192. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  193. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  194. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  195. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  196. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  197. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  198. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  199. package/api/@xmachines/play-tanstack-router/README.md +3 -0
  200. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  201. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  202. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  203. package/api/@xmachines/play-tanstack-solid-router/README.md +3 -2
  204. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  205. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  206. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  207. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  208. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  209. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  210. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  211. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  212. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  213. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  214. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  215. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  216. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  217. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  218. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  219. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-vue/README.md +2 -4
  221. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  222. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  223. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  224. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  225. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  226. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  227. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  228. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  229. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  230. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  231. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  232. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  233. package/api/@xmachines/play-vue-router/README.md +3 -2
  234. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  235. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  236. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  237. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  238. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  239. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  240. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  241. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  242. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  243. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  244. package/api/@xmachines/play-xstate/README.md +41 -23
  245. package/api/@xmachines/play-xstate/classes/PlayerActor.md +77 -53
  246. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +5 -12
  247. package/api/@xmachines/play-xstate/functions/composeGuards.md +7 -2
  248. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +7 -2
  249. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +7 -2
  250. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  252. package/api/@xmachines/play-xstate/functions/eventMatches.md +7 -2
  253. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  254. package/api/@xmachines/play-xstate/functions/hasContext.md +7 -4
  255. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  256. package/api/@xmachines/play-xstate/functions/negateGuard.md +7 -2
  257. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  258. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +4 -4
  259. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +10 -11
  260. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  261. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  262. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +7 -2
  263. package/api/@xmachines/play-xstate/type-aliases/Guard.md +7 -5
  264. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +7 -5
  265. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +11 -15
  266. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  267. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  268. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  269. package/api/@xmachines/shared/README.md +2 -2
  270. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  271. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  272. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +12 -7
  273. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  274. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  275. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  276. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  277. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  278. package/contributing/architecture.md +18 -16
  279. package/contributing/configuration.md +10 -10
  280. package/contributing/deployment.md +49 -28
  281. package/contributing/development.md +56 -17
  282. package/contributing/testing.md +12 -4
  283. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  284. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  285. package/examples/@xmachines/play-dom-demo/functions/initShell.md +7 -6
  286. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  287. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  288. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  289. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  290. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  291. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  292. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  293. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  294. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  295. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  296. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  297. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  298. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  299. package/examples/@xmachines/play-dom-router-demo/README.md +2 -2
  300. package/examples/@xmachines/play-react-demo/README.md +2 -2
  301. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  302. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  303. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  304. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  305. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  306. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +3 -2
  307. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  308. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  309. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  310. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  311. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  312. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  313. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  314. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  315. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -1
  316. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  317. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  318. package/examples/@xmachines/play-react-router-demo/README.md +2 -2
  319. package/examples/@xmachines/play-solid-demo/README.md +2 -2
  320. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  321. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  322. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  323. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  324. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  325. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +4 -2
  326. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  327. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  328. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  329. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  330. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  331. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  332. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  333. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  334. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -1
  335. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  336. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  337. package/examples/@xmachines/play-solid-router-demo/README.md +2 -2
  338. package/examples/@xmachines/play-svelte-demo/README.md +2 -2
  339. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  340. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  341. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +2 -2
  342. package/examples/@xmachines/play-sveltekit-router-demo/README.md +2 -2
  343. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +2 -2
  344. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +2 -2
  345. package/examples/@xmachines/play-vue-demo/README.md +2 -2
  346. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  347. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  348. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  349. package/examples/@xmachines/play-vue-router-demo/README.md +2 -2
  350. package/examples/basic-state-machine.md +0 -2
  351. package/examples/form-validation.md +0 -2
  352. package/examples/multi-router-integration.md +0 -2
  353. package/examples/routing-patterns.md +0 -2
  354. package/examples/traffic-light.md +0 -2
  355. package/guides/README.md +0 -2
  356. package/guides/getting-started.md +19 -11
  357. package/package.json +9 -6
@@ -6,7 +6,7 @@
6
6
  const ActorContext: Context<AnyPlayActor | null>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/useActor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/useActor.ts#L35)
9
+ Defined in: [packages/play-solid/src/useActor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/useActor.ts#L35)
10
10
 
11
11
  SolidJS context for the actor — exported so consumers can use ActorContext.Provider
12
12
  directly as an escape hatch (per D-11). The smart ActorProvider component takes
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: Component<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/ActorProvider.tsx:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/ActorProvider.tsx#L159)
9
+ Defined in: [packages/play-solid/src/ActorProvider.tsx:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L159)
10
10
 
11
11
  Smart ActorProvider component — owns actor bridging, signal subscription,
12
12
  StateStore lifecycle, handler resolution, and error boundary.
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: Component;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/PlayRenderer.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/PlayRenderer.tsx#L27)
9
+ Defined in: [packages/play-solid/src/PlayRenderer.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/PlayRenderer.tsx#L27)
10
10
 
11
11
  Zero-prop leaf renderer. Must be placed inside an ActorProvider or PlayUIProvider tree.
12
12
 
@@ -6,7 +6,7 @@
6
6
  const PlayUIProvider: Component<PlayUIProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid/src/PlayUIProvider.tsx:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid/src/PlayUIProvider.tsx#L82)
9
+ Defined in: [packages/play-solid/src/PlayUIProvider.tsx:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/PlayUIProvider.tsx#L82)
10
10
 
11
11
  Batteries-included composite provider: ActorProvider + JSONUIProvider.
12
12
 
@@ -1,11 +1,12 @@
1
1
  [API](../../README.md) / @xmachines/play-solid-router
2
2
 
3
- <!-- generated-by: gsd-doc-writer -->
4
-
5
3
  # @xmachines/play-solid-router
6
4
 
7
5
  SolidJS Router adapter for the XMachines Universal Player Architecture. Provides bidirectional synchronisation between a `PlayerActor`'s state machine routes and the browser URL via `@solidjs/router`.
8
6
 
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+ [![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-solid-router)
9
+
9
10
  Part of the [xmachines-js monorepo](../../README.md).
10
11
 
11
12
  ## Installation
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L101)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L101)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -57,7 +57,7 @@ map.getPathByStateId("missing"); // null
57
57
  new RouteMap(mappings, options?): RouteMap;
58
58
  ```
59
59
 
60
- Defined in: [packages/play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L127)
60
+ Defined in: [packages/play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L127)
61
61
 
62
62
  Build a route map from an array of state ID ↔ path mappings.
63
63
 
@@ -85,7 +85,7 @@ buckets for efficient candidate selection.
85
85
  getPathByStateId(stateId): string | null;
86
86
  ```
87
87
 
88
- Defined in: [packages/play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L218)
88
+ Defined in: [packages/play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L218)
89
89
 
90
90
  Look up the path pattern registered for a state ID.
91
91
 
@@ -121,7 +121,7 @@ map.getPathByStateId("missing"); // null
121
121
  getStateIdByPath(path): string | null;
122
122
  ```
123
123
 
124
- Defined in: [packages/play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L178)
124
+ Defined in: [packages/play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L178)
125
125
 
126
126
  Resolve a URL path to its mapped state ID.
127
127
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L54)
5
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/solid-router-bridge.ts#L54)
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:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L75)
34
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/solid-router-bridge.ts#L75)
35
35
 
36
36
  Create a SolidJS Router bridge
37
37
 
@@ -63,7 +63,7 @@ Create a SolidJS Router bridge
63
63
  connect(): void;
64
64
  ```
65
65
 
66
- Defined in: [packages/play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/router-bridge-base.ts#L151)
66
+ Defined in: [packages/play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/router-bridge-base.ts#L151)
67
67
 
68
68
  Connect the router bridge to the Actor.
69
69
 
@@ -95,7 +95,7 @@ Adapters that need custom initial-sync behavior should override
95
95
  disconnect(): void;
96
96
  ```
97
97
 
98
- Defined in: [packages/play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/router-bridge-base.ts#L256)
98
+ Defined in: [packages/play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/router-bridge-base.ts#L256)
99
99
 
100
100
  Disconnect the router bridge from the Actor.
101
101
 
@@ -117,7 +117,7 @@ Stops signal watching and unregisters framework-specific router listener.
117
117
  dispose(): void;
118
118
  ```
119
119
 
120
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/solid-router-bridge.ts#L187)
120
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/solid-router-bridge.ts#L187)
121
121
 
122
122
  Dispose the bridge (alias for disconnect).
123
123
 
@@ -6,7 +6,7 @@
6
6
  function createPlayRouterProvider<TRouter>(BridgeCtor): <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L68)
9
+ Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L68)
10
10
 
11
11
  Create a Solid `PlayRouterProvider` component bound to a specific bridge class.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [packages/play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Interface: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L185)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L193)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -10,6 +10,14 @@ Provides signal-driven state observation that integrates with XState ecosystem
10
10
  tooling (devtools, inspection) while exposing reactive signals for
11
11
  Infrastructure layer communication.
12
12
 
13
+ **A subclass IS the actor.** Forward the logic _and_ its options to
14
+ `super(logic, options)`, then observe `this`. Holding a separately
15
+ constructed actor alongside leaves this instance running as an empty second
16
+ actor, and every inherited member — `system`, `sessionId`, `clock`, the
17
+ internal `_send` that receives `sendTo()` traffic, and anything a future
18
+ XState version adds — answers from that empty one until it is individually
19
+ forwarded.
20
+
13
21
  ## Extends
14
22
 
15
23
  - [`Actor`](https://www.jsdocs.io/package/xstate#Actor)\<`TLogic`\>
@@ -33,7 +41,7 @@ Infrastructure layer communication.
33
41
  | <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
42
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
35
43
  | <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:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L195) |
44
+ | <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:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L203) |
37
45
  | <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
46
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
39
47
 
@@ -204,12 +212,20 @@ Actor.select;
204
212
  abstract send(event): void;
205
213
  ```
206
214
 
207
- Defined in: [packages/play-actor/src/abstract-actor.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L202)
215
+ Defined in: [packages/play-actor/src/abstract-actor.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L218)
208
216
 
209
217
  Send event to Actor.
210
218
 
211
219
  Constrained to TEvent for type safety in concrete implementations.
212
220
 
221
+ Note for implementations that wrap `send` (validating the event, or
222
+ notifying hooks around it): this declaration is abstract purely to narrow
223
+ the event type, and TypeScript forbids `super` calls to an abstract
224
+ member. Reach XState's own implementation with
225
+ `Actor.prototype.send.call(this, event)` instead. Making this concrete
226
+ would allow `super.send()` but would force every existing subclass to add
227
+ an `override` modifier — a breaking change for adapters outside this repo.
228
+
213
229
  #### Parameters
214
230
 
215
231
  | Parameter | Type |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L297)
5
+ Defined in: [packages/play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
8
  adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [packages/play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [packages/play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [packages/play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [packages/play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [packages/play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [packages/play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [packages/play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L269)
52
+ Defined in: [packages/play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L225)
5
+ Defined in: [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -122,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
122
122
 
123
123
  | Property | Modifier | Type | Defined in |
124
124
  | -------------------------------------- | ---------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
125
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L230) |
126
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L228) |
127
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L229) |
128
- | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L227) |
129
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderBaseProps\<TRouter, TActor\>
4
4
 
5
- Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L37)
5
+ Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L37)
6
6
 
7
7
  Props shared by every factory-created Solid `PlayRouterProvider`.
8
8
 
@@ -24,7 +24,7 @@ router type (e.g. `SolidRouterHooks` in `@xmachines/play-solid-router`).
24
24
 
25
25
  | Property | Type | Description | Defined in |
26
26
  | ----------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
27
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
28
- | <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/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
29
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
30
- | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
27
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
28
+ | <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/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
29
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
30
+ | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
@@ -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:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L50)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L50)
6
6
 
7
7
  Props for the Solid Router `PlayRouterProvider`.
8
8
 
@@ -24,7 +24,7 @@ in the parent component (they must be called inside a router context).
24
24
 
25
25
  | Property | Type | Description | Inherited from | Defined in |
26
26
  | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
27
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
28
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [packages/play-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
29
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
30
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
27
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
28
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [packages/play-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
29
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
30
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [packages/play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [packages/play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [packages/play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [packages/play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L51)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [packages/play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L55) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [packages/play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/base-route-map.ts#L53) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [packages/play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [packages/play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L341)
5
+ Defined in: [packages/play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [packages/play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L357)
57
+ Defined in: [packages/play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L357)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [packages/play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-router/src/types.ts#L373)
86
+ Defined in: [packages/play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,7 +6,7 @@
6
6
  type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/create-play-router-provider.tsx#L25)
9
+ Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/create-play-router-provider.tsx#L25)
10
10
 
11
11
  Constructor shape a bridge class must satisfy to be used with
12
12
  `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L19)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L19)
10
10
 
11
11
  ## Deprecated
12
12
 
@@ -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:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L37)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L37)
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:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L39)
34
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L39)
35
35
 
36
36
  ---
37
37
 
@@ -41,7 +41,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https:/
41
41
  navigate: Navigator;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L38)
44
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L38)
45
45
 
46
46
  ---
47
47
 
@@ -51,4 +51,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https:/
51
51
  params: Params;
52
52
  ```
53
53
 
54
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L40)
54
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L40)
@@ -6,7 +6,7 @@
6
6
  const PlayRouterProvider: <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-solid-router/src/play-router-provider.tsx#L92)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid-router/src/play-router-provider.tsx#L92)
10
10
 
11
11
  Connects a `PlayerActor` to Solid Router, keeping actor state and browser URL
12
12
  in sync bidirectionally.
@@ -1,11 +1,12 @@
1
1
  [API](../../README.md) / @xmachines/play-svelte
2
2
 
3
- <!-- generated-by: gsd-doc-writer -->
4
-
5
3
  # @xmachines/play-svelte
6
4
 
7
5
  Svelte 5 renderer for the XMachines Play architecture — connects an actor to a `@xmachines/json-render-svelte` catalog-driven UI using Svelte 5 runes and TC39 Signals.
8
6
 
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+ [![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte)
9
+
9
10
  Part of the [xmachines-js monorepo](../../README.md).
10
11
 
11
12
  ## Installation
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/define-registry.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/define-registry.ts#L154)
9
+ Defined in: [packages/play-svelte/src/define-registry.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-svelte/src/define-registry.ts#L154)
10
10
 
11
11
  Create a component registry, restoring catalog-typed `params` on action handlers.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getActorContext(): AnyPlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L38)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-svelte/src/actor-context.svelte.ts#L38)
10
10
 
11
11
  Get the actor from the nearest ActorProvider ancestor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getPlayViewContext(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L59)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-svelte/src/actor-context.svelte.ts#L59)
10
10
 
11
11
  Get the current view context from the nearest ActorProvider ancestor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function setActorContext(actor): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L28)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-svelte/src/actor-context.svelte.ts#L28)
10
10
 
11
11
  ## Parameters
12
12