@xmachines/docs 1.0.0-beta.55 → 1.0.0-beta.56

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 (360) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/README.md +2 -2
  6. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  7. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  8. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  9. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  10. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
  11. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +8 -8
  12. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  13. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  14. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  15. package/api/@xmachines/play-dom/README.md +10 -16
  16. package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -11
  17. package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
  18. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  19. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  20. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  21. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  22. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +12 -11
  23. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +19 -18
  25. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -6
  26. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  27. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -13
  28. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +14 -13
  29. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +12 -11
  30. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +3 -3
  31. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +9 -9
  33. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +3 -3
  37. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +5 -5
  38. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/SetState.md +3 -3
  43. package/api/@xmachines/play-dom/variables/schema.md +26 -20
  44. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  48. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  49. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  50. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  51. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  52. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  53. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  57. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  59. package/api/@xmachines/play-react/README.md +5 -11
  60. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  61. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  62. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  63. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  64. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  65. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  66. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +12 -11
  67. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  68. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  69. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  70. package/api/@xmachines/play-react/interfaces/RendererProps.md +7 -7
  71. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  72. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  73. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  74. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  75. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  76. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  77. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  78. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  79. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  80. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  81. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  82. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  83. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  84. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  85. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  86. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  87. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  88. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  89. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  90. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  91. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  92. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  93. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  94. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  95. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  96. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  99. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  100. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  101. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  102. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  103. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  104. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  105. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  106. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  107. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  108. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  109. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  110. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  111. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  112. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  113. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  114. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  115. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  116. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  117. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  118. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  119. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  120. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  121. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  123. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  124. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  127. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  128. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  129. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  130. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  131. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  132. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  133. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  134. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  135. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  136. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  137. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  138. package/api/@xmachines/play-solid/README.md +8 -14
  139. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  140. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  141. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  142. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  143. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +12 -11
  144. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  145. package/api/@xmachines/play-solid/interfaces/RendererProps.md +7 -7
  146. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  147. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  148. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -7
  149. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  150. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  151. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  152. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  153. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  154. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  155. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  156. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  157. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  158. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  159. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  160. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  161. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  162. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  163. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  164. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  166. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  167. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  168. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  169. package/api/@xmachines/play-svelte/README.md +21 -26
  170. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  171. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  172. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  173. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  174. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  175. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  176. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  177. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  178. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  179. package/api/@xmachines/play-svelte/type-aliases/JSONUIProviderProps.md +7 -0
  180. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +17 -1
  181. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  182. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  183. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  184. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  185. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  186. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  187. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  188. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  189. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  190. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  191. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  192. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  193. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  194. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  195. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  196. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  197. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  198. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  199. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  200. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  201. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  202. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  203. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  204. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  205. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  206. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  207. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  208. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  209. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  210. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  211. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  212. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  213. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  214. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  215. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  216. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  217. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  218. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  219. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  220. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  221. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  222. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  223. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  224. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  225. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  226. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  227. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  228. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  229. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  230. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  231. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  232. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  233. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  234. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  235. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  236. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  237. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  238. package/api/@xmachines/play-vue/README.md +8 -14
  239. package/api/@xmachines/play-vue/functions/defineRegistry.md +3 -3
  240. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  241. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  242. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  243. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  244. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +11 -10
  245. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  246. package/api/@xmachines/play-vue/interfaces/RendererProps.md +7 -7
  247. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  248. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  249. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  250. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  251. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  252. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  253. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +9 -0
  254. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  255. package/api/@xmachines/play-vue/variables/Renderer.md +9 -0
  256. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  257. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  258. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  259. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  260. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  261. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  262. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  263. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  264. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  265. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  266. package/api/@xmachines/play-xstate/classes/PlayerActor.md +28 -28
  267. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  268. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  269. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  270. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  271. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  272. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  273. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  274. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  275. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  276. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  277. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  278. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  279. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  280. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  281. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  282. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  283. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  284. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  285. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  286. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  287. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  288. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  289. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  290. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  291. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  292. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +3 -3
  293. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  294. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  295. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  296. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  297. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  298. package/api/llms.txt +2 -2
  299. package/contributing/architecture.md +9 -9
  300. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  301. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  302. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  303. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  304. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  305. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  306. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  307. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  308. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  309. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  310. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  311. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  312. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  313. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  314. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  315. package/examples/@xmachines/play-react-demo/README.md +1 -1
  316. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  317. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  318. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  319. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  320. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  321. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  322. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  323. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  324. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  325. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  326. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  327. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  328. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  329. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  330. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  331. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  332. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  333. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  334. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  335. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  336. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  337. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  338. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  339. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  340. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  341. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  342. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  343. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  344. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  345. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  346. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  347. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  348. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  349. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  350. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  351. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  352. package/examples/@xmachines/play-vue-demo/README.md +2 -2
  353. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  354. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  355. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  356. package/examples/form-validation.md +2 -2
  357. package/guides/getting-started.md +4 -4
  358. package/guides/state-machines.md +1 -1
  359. package/package.json +2 -2
  360. package/rfc/play.md +16 -16
@@ -2,17 +2,17 @@
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L1)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L9) |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L26)
25
+ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L38)
39
+ Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L47)
61
+ Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L47)
62
62
 
63
63
  Cleanup.
64
64
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
78
78
  forward(): void;
79
79
  ```
80
80
 
81
- Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L27)
81
+ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L27)
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
92
92
  go(delta): void;
93
93
  ```
94
94
 
95
- Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L25)
95
+ Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L25)
96
96
 
97
97
  Go back/forward
98
98
 
@@ -114,7 +114,7 @@ Go back/forward
114
114
  push(path, state?): void;
115
115
  ```
116
116
 
117
- Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L15)
117
+ Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L15)
118
118
 
119
119
  Push new URL to history
120
120
 
@@ -137,7 +137,7 @@ Push new URL to history
137
137
  replace(path, state?): void;
138
138
  ```
139
139
 
140
- Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L20)
140
+ Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L20)
141
141
 
142
142
  Replace current URL in history
143
143
 
@@ -160,7 +160,7 @@ Replace current URL in history
160
160
  subscribe(listener): () => void;
161
161
  ```
162
162
 
163
- Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L33)
163
+ Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BrowserWindow
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L59)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L59)
6
6
 
7
7
  Minimal window interface for createBrowserHistory
8
8
 
@@ -14,17 +14,17 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
14
14
 
15
15
  | Property | Modifier | Type | Defined in |
16
16
  | ----------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-history"></a> `history` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L60) |
18
- | `history.state` | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L61) |
19
- | `history.back` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L65) |
20
- | `history.forward` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L66) |
21
- | `history.go` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L64) |
22
- | `history.pushState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L62) |
23
- | `history.replaceState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L63) |
24
- | <a id="property-location"></a> `location` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L68) |
25
- | `location.hash` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L71) |
26
- | `location.pathname` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L69) |
27
- | `location.search` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L70) |
17
+ | <a id="property-history"></a> `history` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L60) |
18
+ | `history.state` | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L61) |
19
+ | `history.back` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L65) |
20
+ | `history.forward` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L66) |
21
+ | `history.go` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L64) |
22
+ | `history.pushState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L62) |
23
+ | `history.replaceState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L63) |
24
+ | <a id="property-location"></a> `location` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L68) |
25
+ | `location.hash` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L71) |
26
+ | `location.pathname` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L69) |
27
+ | `location.search` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L70) |
28
28
 
29
29
  ## Methods
30
30
 
@@ -34,7 +34,7 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
34
34
  addEventListener(type, listener): void;
35
35
  ```
36
36
 
37
- Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L73)
37
+ Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L73)
38
38
 
39
39
  #### Parameters
40
40
 
@@ -55,7 +55,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.co
55
55
  removeEventListener(type, listener): void;
56
56
  ```
57
57
 
58
- Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-browser-history.ts#L74)
58
+ Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-browser-history.ts#L74)
59
59
 
60
60
  #### Parameters
61
61
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-dom-router/src/connect-router.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L23)
5
+ Defined in: [play-dom-router/src/connect-router.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L23)
6
6
 
7
7
  Options for [connectRouter](../functions/connectRouter.md).
8
8
 
@@ -10,6 +10,6 @@ Options for [connectRouter](../functions/connectRouter.md).
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | ----------------------------------------- | ---------- | ----------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](RoutableActor.md) | The actor to synchronize with the browser URL. Must implement `Routable`. | [play-dom-router/src/connect-router.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L25) |
14
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteLookupContract`](RouteLookupContract.md) | Route lookup used to match URL pathnames to machine state IDs. | [play-dom-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L29) |
15
- | <a id="property-router"></a> `router` | `readonly` | [`VanillaRouter`](VanillaRouter.md) | The vanilla router created by [createRouter](../functions/createRouter.md). | [play-dom-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L27) |
13
+ | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](RoutableActor.md) | The actor to synchronize with the browser URL. Must implement `Routable`. | [play-dom-router/src/connect-router.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L25) |
14
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteLookupContract`](RouteLookupContract.md) | Route lookup used to match URL pathnames to machine state IDs. | [play-dom-router/src/connect-router.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L29) |
15
+ | <a id="property-router"></a> `router` | `readonly` | [`VanillaRouter`](VanillaRouter.md) | The vanilla router created by [createRouter](../functions/createRouter.md). | [play-dom-router/src/connect-router.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L27) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/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` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L230) |
126
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L228) |
127
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L229) |
128
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L227) |
129
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RoutableActor
4
4
 
5
- Defined in: [play-router/src/types.ts:259](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L259)
5
+ Defined in: [play-router/src/types.ts:259](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L259)
6
6
 
7
7
  Minimal actor interface required by `RouterBridgeBase` and all framework router
8
8
  adapters.
@@ -42,8 +42,8 @@ class MyBridge extends RouterBridgeBase {
42
42
 
43
43
  | Property | Modifier | Type | Description | Defined in |
44
44
  | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
45
- | <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). | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L261) |
46
- | <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). | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L267) |
45
+ | <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). | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L261) |
46
+ | <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). | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L267) |
47
47
 
48
48
  ## Methods
49
49
 
@@ -53,7 +53,7 @@ class MyBridge extends RouterBridgeBase {
53
53
  send(event): void;
54
54
  ```
55
55
 
56
- Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L269)
56
+ Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L269)
57
57
 
58
58
  Send a route navigation event to the actor.
59
59
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteLookupContract
4
4
 
5
- Defined in: [play-dom-router/src/connect-router.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L15)
5
+ Defined in: [play-dom-router/src/connect-router.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L15)
6
6
 
7
7
  Structural route lookup interface accepted by [connectRouter](../functions/connectRouter.md).
8
8
 
@@ -21,7 +21,7 @@ implementations keyed on a single form still resolve.
21
21
  getPathByStateId(id): string | null | undefined;
22
22
  ```
23
23
 
24
- Defined in: [play-dom-router/src/connect-router.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L17)
24
+ Defined in: [play-dom-router/src/connect-router.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L17)
25
25
 
26
26
  #### Parameters
27
27
 
@@ -41,7 +41,7 @@ Defined in: [play-dom-router/src/connect-router.ts:17](https://gitlab.com/xmachi
41
41
  getStateIdByPath(path): string | null | undefined;
42
42
  ```
43
43
 
44
- Defined in: [play-dom-router/src/connect-router.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/connect-router.ts#L16)
44
+ Defined in: [play-dom-router/src/connect-router.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/connect-router.ts#L16)
45
45
 
46
46
  #### Parameters
47
47
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L101)
5
+ Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/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
  getPathByStateId(stateId): string | null;
58
58
  ```
59
59
 
60
- Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L218)
60
+ Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L218)
61
61
 
62
62
  Look up the path pattern registered for a state ID.
63
63
 
@@ -93,7 +93,7 @@ map.getPathByStateId("missing"); // null
93
93
  getStateIdByPath(path): string | null;
94
94
  ```
95
95
 
96
- Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L178)
96
+ Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L178)
97
97
 
98
98
  Resolve a URL path to its mapped state ID.
99
99
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L51)
5
+ Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L55) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/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?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L341)
5
+ Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/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: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L357)
57
+ Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L357)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L373)
86
+ Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -2,14 +2,14 @@
2
2
 
3
3
  # Interface: VanillaRouter
4
4
 
5
- Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-router.ts#L4)
5
+ Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-router.ts#L4)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------- | ---------- | -------------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-router.ts#L8) |
12
- | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | Route tree (for structure reference) | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-router.ts#L13) |
11
+ | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-router.ts#L8) |
12
+ | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | Route tree (for structure reference) | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-router.ts#L13) |
13
13
 
14
14
  ## Methods
15
15
 
@@ -19,7 +19,7 @@ Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-
19
19
  destroy(): void;
20
20
  ```
21
21
 
22
- Defined in: [play-dom-router/src/create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-dom-router/src/create-router.ts#L18)
22
+ Defined in: [play-dom-router/src/create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-dom-router/src/create-router.ts#L18)
23
23
 
24
24
  Cleanup
25
25
 
@@ -17,7 +17,7 @@ npm install @xmachines/play-react
17
17
  **Peer dependencies** (must be installed separately):
18
18
 
19
19
  ```bash
20
- npm install react react-dom xstate @xstate/store @json-render/react @json-render/core @json-render/xstate
20
+ npm install react react-dom xstate @xstate/store @xmachines/json-render-react @xmachines/json-render-core @xmachines/json-render-xstate
21
21
  ```
22
22
 
23
23
  Supported versions:
@@ -25,7 +25,7 @@ Supported versions:
25
25
  - `react` / `react-dom`: `^18.0.0 || ^19.0.0`
26
26
  - `xstate`: `^5.31.0`
27
27
  - `@xstate/store`: `^3.17.0`
28
- - `@json-render/*`: `^0.18.0`
28
+ - `@xmachines/json-render-*`: `^0.18.0`
29
29
 
30
30
  ## Usage
31
31
 
@@ -147,9 +147,9 @@ function MyComponent({ actor }) {
147
147
  | `ViewContextValue` | Value shape returned by `usePlayView()` |
148
148
  | `RenderErrorHandler` | Error handler callback type for render errors |
149
149
 
150
- ### Re-exports from `@json-render/react`
150
+ ### Re-exports from `@xmachines/json-render-react`
151
151
 
152
- `@xmachines/play-react` re-exports the full `@json-render/react` surface so consumers only need one import:
152
+ `@xmachines/play-react` re-exports the full `@xmachines/json-render-react` surface so consumers only need one import:
153
153
 
154
154
  ```ts
155
155
  import {
@@ -197,7 +197,7 @@ MIT — see [LICENSE](./LICENSE).
197
197
  @xmachines/play-react - React renderer for XMachines Play architecture
198
198
 
199
199
  Provides a provider-based React rendering layer that passively observes actor signals
200
- and renders UI components via @json-render/react. This package enables
200
+ and renders UI components via @xmachines/json-render-react. This package enables
201
201
  framework-swappable architecture where React is just a rendering target
202
202
  that subscribes to signal changes.
203
203
 
@@ -272,9 +272,3 @@ triggering React's render cycle. Signals are the source of truth.
272
272
  ### PlayRendererProps
273
273
 
274
274
  Renames and re-exports [ActorProviderProps](interfaces/ActorProviderProps.md)
275
-
276
- ---
277
-
278
- ### RenderErrorHandler
279
-
280
- Re-exports [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayErrorBoundary
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/PlayErrorBoundary.tsx#L53)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/PlayErrorBoundary.tsx#L53)
6
6
 
7
7
  React class component error boundary for catching catalog component render errors.
8
8
 
@@ -36,7 +36,7 @@ Per CONS-14: Class component pattern works with all React versions (18 and 19).
36
36
  new PlayErrorBoundary(props): PlayErrorBoundary;
37
37
  ```
38
38
 
39
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/PlayErrorBoundary.tsx#L57)
39
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/PlayErrorBoundary.tsx#L57)
40
40
 
41
41
  #### Parameters
42
42
 
@@ -75,7 +75,7 @@ React.Component<
75
75
  componentDidCatch(error, info): void;
76
76
  ```
77
77
 
78
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/PlayErrorBoundary.tsx#L66)
78
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/PlayErrorBoundary.tsx#L66)
79
79
 
80
80
  Catches exceptions generated in descendant components. Unhandled exceptions will cause
81
81
  the entire component tree to unmount.
@@ -375,7 +375,7 @@ React.Component.getSnapshotBeforeUpdate;
375
375
  render(): ReactNode;
376
376
  ```
377
377
 
378
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/PlayErrorBoundary.tsx#L70)
378
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/PlayErrorBoundary.tsx#L70)
379
379
 
380
380
  #### Returns
381
381
 
@@ -604,7 +604,7 @@ React.Component.UNSAFE_componentWillUpdate;
604
604
  static getDerivedStateFromError(error): PlayErrorBoundaryState;
605
605
  ```
606
606
 
607
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/PlayErrorBoundary.tsx#L62)
607
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/PlayErrorBoundary.tsx#L62)
608
608
 
609
609
  #### Parameters
610
610
 
@@ -6,7 +6,7 @@
6
6
  function useActor(): AnyPlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useActor.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/useActor.ts#L32)
9
+ Defined in: [packages/play-react/src/useActor.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/useActor.ts#L32)
10
10
 
11
11
  ## Returns
12
12
 
@@ -36,7 +36,7 @@ a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
36
36
  ## Example
37
37
 
38
38
  ```tsx
39
- import { useBoundProp } from "@json-render/react";
39
+ import { useBoundProp } from "@xmachines/json-render-react";
40
40
 
41
41
  const Input: ComponentRenderer = ({ props, bindings }) => {
42
42
  const [value, setValue] = useBoundProp<string>(props.value, bindings?.value);
@@ -6,7 +6,7 @@
6
6
  function usePlayView(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/ActorProvider.tsx:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/ActorProvider.tsx#L78)
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/ActorProvider.tsx#L82)
10
10
 
11
11
  Hook to access the current view spec, handlers, and registry.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function useSignalEffect(callback, deps?): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useSignalEffect.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/useSignalEffect.ts#L80)
9
+ Defined in: [packages/play-react/src/useSignalEffect.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/useSignalEffect.ts#L80)
10
10
 
11
11
  React hook that subscribes to signal changes and runs effect callback
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-react/src/ActorProvider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/ActorProvider.tsx#L37)
5
+ Defined in: [packages/play-react/src/ActorProvider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/ActorProvider.tsx#L41)
6
6
 
7
7
  Props for the ActorProvider component.
8
8
 
@@ -18,10 +18,10 @@ Props for the ActorProvider component.
18
18
 
19
19
  | Property | Type | Description | Inherited from | Defined in |
20
20
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <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:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L154) |
22
- | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | - | [packages/play-react/src/ActorProvider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/ActorProvider.tsx#L43) |
23
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | - | [packages/play-react/src/ActorProvider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/ActorProvider.tsx#L39) |
24
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | - | [packages/play-react/src/ActorProvider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-react/src/ActorProvider.tsx#L41) |
25
- | <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:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L167) |
26
- | <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:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L156) |
27
- | <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:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-actor/src/abstract-actor.ts#L162) |
21
+ | <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.56/packages/play-actor/src/abstract-actor.ts#L159) |
22
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render inside the provider tree | - | [packages/play-react/src/ActorProvider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/ActorProvider.tsx#L47) |
23
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null or a catalog component throws | - | [packages/play-react/src/ActorProvider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/ActorProvider.tsx#L43) |
24
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback invoked when a catalog component throws during render | - | [packages/play-react/src/ActorProvider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/src/ActorProvider.tsx#L45) |
25
+ | <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.56/packages/play-actor/src/abstract-actor.ts#L172) |
26
+ | <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.56/packages/play-actor/src/abstract-actor.ts#L161) |
27
+ | <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.56/packages/play-actor/src/abstract-actor.ts#L167) |