@xmachines/docs 1.0.0-beta.58 → 1.0.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 (319) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +11 -11
  2. package/api/@xmachines/play/classes/PlayError.md +11 -11
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +15 -15
  6. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  7. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +7 -7
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +7 -7
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +4 -4
  14. package/api/@xmachines/play-dom/README.md +2 -6
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  16. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  17. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  18. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +10 -10
  19. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  20. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +12 -12
  21. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  22. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  23. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  24. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  25. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  26. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  27. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  28. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +6 -6
  29. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
  30. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  31. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  32. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  33. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  34. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  35. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  36. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  37. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +8 -8
  38. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  39. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  40. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  41. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  42. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  43. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +5 -5
  44. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  45. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  46. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  47. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  48. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  49. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  50. package/api/@xmachines/play-react-router/README.md +1 -3
  51. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  52. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  53. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  54. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  55. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  56. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  57. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
  58. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  60. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  61. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  62. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  63. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  64. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  65. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  66. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  67. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  68. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  70. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  71. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  74. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  76. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  77. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  80. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  81. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  82. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  83. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  85. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  86. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +6 -6
  87. package/api/@xmachines/play-router/interfaces/LocationLike.md +5 -5
  88. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +5 -5
  89. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +7 -7
  90. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  91. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  92. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +5 -5
  93. package/api/@xmachines/play-router/interfaces/RoutableActor.md +6 -6
  94. package/api/@xmachines/play-router/interfaces/RouteInfo.md +10 -10
  95. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +4 -4
  96. package/api/@xmachines/play-router/interfaces/RouteMapping.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/RouteMatch.md +5 -5
  98. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  99. package/api/@xmachines/play-router/interfaces/RouteObject.md +4 -4
  100. package/api/@xmachines/play-router/interfaces/RouteTree.md +7 -7
  101. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  102. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  103. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  104. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  105. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  106. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  107. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -4
  108. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  109. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -4
  110. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  111. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  112. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  113. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  114. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  115. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  116. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  117. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  118. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  119. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  120. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  121. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  122. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  123. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  124. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  125. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  126. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  127. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +15 -15
  128. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  129. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
  130. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  131. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  132. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  133. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  134. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  135. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  136. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  137. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  138. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  139. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  140. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  141. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  142. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  143. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  144. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  145. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  146. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  147. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  148. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  149. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  150. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  151. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  152. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
  153. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  154. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  155. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  156. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  157. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  158. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  159. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  160. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  161. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +6 -6
  162. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  163. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
  164. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  165. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  166. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  167. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  168. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  169. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  170. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  171. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  172. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  173. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  174. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  175. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
  176. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  177. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  178. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  179. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  180. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +5 -5
  181. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  182. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  183. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  184. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  185. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  186. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  187. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  188. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  189. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  190. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  191. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  193. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  194. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
  195. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +7 -7
  196. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  197. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  198. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  199. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  201. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  202. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  203. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  204. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  205. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  206. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  207. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  208. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +7 -7
  209. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +10 -10
  210. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  211. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  212. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  213. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  214. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  215. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -4
  216. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  217. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  218. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  219. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  220. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  221. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
  222. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +4 -4
  223. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +5 -5
  224. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  225. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  226. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  227. package/api/@xmachines/play-xstate/classes/PlayerActor.md +28 -28
  228. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  229. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  230. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  231. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  232. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  233. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  234. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  235. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  236. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  237. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  238. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  239. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +5 -5
  240. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +4 -4
  241. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +8 -8
  242. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +7 -7
  243. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +4 -4
  244. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  245. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  246. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  247. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  248. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  249. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  250. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  251. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  252. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  253. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  254. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  255. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  256. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  257. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  258. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  259. package/contributing/deployment.md +10 -12
  260. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  261. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  262. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  263. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  264. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  265. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  266. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  267. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  268. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  269. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  270. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  271. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  272. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  273. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  274. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  275. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  276. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  277. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  278. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  279. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  280. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  281. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  282. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  283. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  284. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  285. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  286. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  287. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  288. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  289. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  290. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  291. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  292. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  293. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  294. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  295. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  296. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  297. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  298. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  299. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  300. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  301. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  302. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  303. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  304. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  305. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  306. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  307. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  308. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  309. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  310. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  311. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  312. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  313. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  314. package/examples/multi-router-integration.md +3 -9
  315. package/examples/routing-patterns.md +2 -6
  316. package/guides/getting-started.md +1 -3
  317. package/guides/state-machines.md +2 -6
  318. package/package.json +6 -6
  319. package/rfc/play.md +1 -3
@@ -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-beta.58/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.0.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
@@ -35,11 +35,11 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
35
35
 
36
36
  ## Properties
37
37
 
38
- | Property | Modifier | Type | Description | Inherited from | Defined in |
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-beta.58/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-beta.58/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-beta.58/packages/play-router/src/types.ts#L267) |
38
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
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) |
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-beta.58/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.0.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-beta.58/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.0.0/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -120,10 +120,10 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
120
120
 
121
121
  ## Properties
122
122
 
123
- | Property | Modifier | Type | Defined in |
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-beta.58/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-beta.58/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-beta.58/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-beta.58/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-beta.58/packages/play-router/src/types.ts#L226) |
123
+ | Property | Modifier | Type | Defined in |
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) |
@@ -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-beta.58/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.0.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
 
@@ -22,9 +22,9 @@ router type (e.g. `SolidRouterHooks` in `@xmachines/play-solid-router`).
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description | Defined in |
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-beta.58/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-beta.58/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-beta.58/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-beta.58/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
25
+ | Property | Type | Description | Defined in |
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) |
@@ -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-beta.58/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.0.0/packages/play-solid-router/src/play-router-provider.tsx#L50)
6
6
 
7
7
  Props for the Solid Router `PlayRouterProvider`.
8
8
 
@@ -22,9 +22,9 @@ in the parent component (they must be called inside a router context).
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description | Inherited from | Defined in |
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-beta.58/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-beta.58/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-beta.58/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-beta.58/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
25
+ | Property | Type | Description | Inherited from | Defined in |
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) |
@@ -2,12 +2,12 @@
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-beta.58/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.0.0/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Description | Defined in |
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-beta.58/packages/play-router/src/create-route-map.ts#L20) |
11
+ | Property | Type | Description | Defined in |
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) |
@@ -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-beta.58/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.0.0/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -21,7 +21,7 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Modifier | Type | Description | Defined in |
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-beta.58/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-beta.58/packages/play-router/src/base-route-map.ts#L53) |
24
+ | Property | Modifier | Type | Description | Defined in |
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) |
@@ -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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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-beta.58/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.0.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.
@@ -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-beta.58/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.0.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,11 +6,11 @@
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-beta.58/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.0.0/packages/play-svelte/src/actor-context.svelte.ts#L38)
10
10
 
11
11
  Get the actor from the nearest ActorProvider ancestor.
12
12
 
13
- Renamed from useActor() to match @xmachines/json-render-svelte's get\*Context() convention (D-07).
13
+ Renamed from useActor() to match @xmachines/json-render-svelte's get*Context() convention (D-07).
14
14
 
15
15
  ## Returns
16
16
 
@@ -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-beta.58/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.0.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-beta.58/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.0.0/packages/play-svelte/src/actor-context.svelte.ts#L28)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L68)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L68)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
@@ -33,12 +33,12 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
33
33
 
34
34
  ## Properties
35
35
 
36
- | Property | Type | Description | Inherited from | Defined in |
37
- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
38
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L159) |
39
- | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L71) |
40
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L69) |
41
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L70) |
42
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L172) |
43
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L161) |
44
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L167) |
36
+ | Property | Type | Description | Inherited from | Defined in |
37
+ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
38
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L159) |
39
+ | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L71) |
40
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L69) |
41
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L70) |
42
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L172) |
43
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L161) |
44
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L167) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [packages/play-svelte/src/define-registry.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/define-registry.ts#L93)
5
+ Defined in: [packages/play-svelte/src/define-registry.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/define-registry.ts#L93)
6
6
 
7
7
  Options for `defineRegistry`.
8
8
 
@@ -17,8 +17,8 @@ Mirrors the upstream shape but replaces the untyped
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description | Defined in |
21
- | ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Catalog-typed action handler map. Each handler receives `params` typed to the exact schema defined in the catalog action (or `undefined` if no params were provided), plus the upstream `setState` and `state` arguments. Guard against `undefined` before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/define-registry.ts#L117) |
23
- | <a id="property-components"></a> `components?` | `Components`\<`C`\> | Svelte component implementations — keyed by catalog component name. | [packages/play-svelte/src/define-registry.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/define-registry.ts#L97) |
24
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback invoked when a catalog component throws during render. The error is caught by `@xmachines/json-render-svelte`'s inner `<svelte:boundary>` that wraps each rendered element. When provided, this callback replaces the default `console.error(...)` fallback — the component is silently removed from the DOM and your callback receives the error and the element type name for custom error reporting or recovery logic. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** **error** The thrown value (not necessarily an `Error` instance). **Param** **elementType** The catalog component name that crashed (e.g. `"Dashboard"`). | [packages/play-svelte/src/define-registry.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/define-registry.ts#L142) |
20
+ | Property | Type | Description | Defined in |
21
+ | ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
22
+ | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Catalog-typed action handler map. Each handler receives `params` typed to the exact schema defined in the catalog action (or `undefined` if no params were provided), plus the upstream `setState` and `state` arguments. Guard against `undefined` before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/define-registry.ts#L117) |
23
+ | <a id="property-components"></a> `components?` | `Components`\<`C`\> | Svelte component implementations — keyed by catalog component name. | [packages/play-svelte/src/define-registry.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/define-registry.ts#L97) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback invoked when a catalog component throws during render. The error is caught by `@xmachines/json-render-svelte`'s inner `<svelte:boundary>` that wraps each rendered element. When provided, this callback replaces the default `console.error(...)` fallback — the component is silently removed from the DOM and your callback receives the error and the element type name for custom error reporting or recovery logic. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** **error** The thrown value (not necessarily an `Error` instance). **Param** **elementType** The catalog component name that crashed (e.g. `"Dashboard"`). | [packages/play-svelte/src/define-registry.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/define-registry.ts#L142) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L78)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L78)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
@@ -29,15 +29,15 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
29
29
 
30
30
  ## Properties
31
31
 
32
- | Property | Type | Description | Inherited from | Defined in |
33
- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L159) |
35
- | <a id="property-children"></a> `children` | `Snippet` | - | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L71) |
36
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L69) |
37
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `unknown`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L84) |
38
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L83) |
39
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L70) |
40
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L172) |
41
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L161) |
42
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L167) |
43
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L79) |
32
+ | Property | Type | Description | Inherited from | Defined in |
33
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L159) |
35
+ | <a id="property-children"></a> `children` | `Snippet` | - | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L71) |
36
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L69) |
37
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `unknown`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L84) |
38
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L83) |
39
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L70) |
40
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L172) |
41
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L161) |
42
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L167) |
43
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L79) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L47)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L47)
6
6
 
7
7
  Framework-agnostic base for every framework's `ViewContextValue`.
8
8
 
@@ -16,9 +16,9 @@ type) so it is typed via `TRegistry` — the same generic used in `BaseActorProv
16
16
 
17
17
  ## Properties
18
18
 
19
- | Property | Type | Description | Inherited from | Defined in |
20
- | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L127) |
22
- | <a id="property-registry"></a> `registry` | `TRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L129) |
23
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L125) |
24
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-actor/src/abstract-actor.ts#L131) |
19
+ | Property | Type | Description | Inherited from | Defined in |
20
+ | ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L127) |
22
+ | <a id="property-registry"></a> `registry` | `TRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L129) |
23
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L125) |
24
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-actor/src/abstract-actor.ts#L131) |
@@ -6,6 +6,6 @@
6
6
  type AnyPlayActor = AbstractActor<AnyActorLogic> & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.58/packages/play-svelte/src/actor-context.svelte.ts#L22)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0/packages/play-svelte/src/actor-context.svelte.ts#L22)
10
10
 
11
11
  Actor type accepted by the Svelte `ActorProvider` and `getActorContext` — requires `Viewable` for view rendering. For the full routing + view shape, use `PlayActor` from `@xmachines/play-router`.