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

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 (461) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/play/README.md +3 -3
  3. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  4. package/api/@xmachines/play/classes/PlayError.md +7 -7
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +5 -5
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  12. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  14. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  15. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  16. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  17. package/api/@xmachines/play-dom/README.md +4 -4
  18. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  19. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  20. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  21. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  22. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  23. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +1 -1
  24. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  25. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +1 -1
  26. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +1 -1
  27. package/api/@xmachines/play-dom/interfaces/EventHandle.md +1 -1
  28. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  29. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  30. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +1 -1
  31. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  35. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  45. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  46. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  47. package/api/@xmachines/play-dom-router/README.md +4 -4
  48. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  56. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  63. package/api/@xmachines/play-react/README.md +5 -5
  64. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  65. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  68. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  70. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  71. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  72. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  73. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  74. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  75. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  78. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  79. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  80. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  81. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  82. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  83. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  87. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  89. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  90. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  91. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  93. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  94. package/api/@xmachines/play-react-router/README.md +5 -5
  95. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  96. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  97. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  98. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  99. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  100. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  102. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  103. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  104. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  105. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  106. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  108. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-router/README.md +5 -5
  110. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  111. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  112. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  113. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  114. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  115. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  116. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  118. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  119. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  120. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  121. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  122. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  123. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  124. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  125. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  126. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  127. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  128. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  129. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  130. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  131. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  132. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  133. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  134. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  135. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  136. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  140. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  141. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  143. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  144. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  145. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  146. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  147. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  148. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  149. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  150. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  151. package/api/@xmachines/play-signals/README.md +5 -5
  152. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  153. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  154. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  155. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  156. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  157. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  158. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  159. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  160. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  169. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  170. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  171. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  172. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  173. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  174. package/api/@xmachines/play-solid/README.md +6 -6
  175. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  177. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  178. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  179. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  180. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  181. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  184. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  189. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  190. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  192. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  193. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  196. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  199. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  200. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  201. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  202. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  203. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  204. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  205. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  206. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  207. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  208. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  209. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  210. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  212. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  214. package/api/@xmachines/play-solid-router/README.md +5 -5
  215. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  216. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  217. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  218. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  226. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  230. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-svelte/README.md +5 -5
  232. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  236. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  237. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  239. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  240. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  241. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  243. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  244. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  246. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  247. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  248. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  249. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  250. package/api/@xmachines/play-svelte-spa-router/README.md +4 -4
  251. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  253. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  256. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  257. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  258. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  259. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  260. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  261. package/api/@xmachines/play-sveltekit-router/README.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  263. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  264. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  265. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  266. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  267. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  268. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  269. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  270. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  271. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/README.md +6 -6
  273. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  275. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  276. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  277. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  278. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  279. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  280. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  281. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  282. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  284. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  285. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  286. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  287. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  288. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  289. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  291. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  292. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  293. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  294. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
  295. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  296. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  297. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  298. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  300. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  301. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  304. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  305. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  306. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  307. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  308. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  309. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  310. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  311. package/api/@xmachines/play-vue/README.md +5 -5
  312. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  313. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  314. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  315. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  317. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  318. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  319. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  320. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  321. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  322. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  323. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  324. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  325. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  326. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  327. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  328. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  329. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  330. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  331. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  332. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  333. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  334. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  335. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  336. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  337. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  338. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  339. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  340. package/api/@xmachines/play-vue-router/README.md +4 -4
  341. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  342. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  343. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  344. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  345. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  346. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  347. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  348. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  349. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  350. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  351. package/api/@xmachines/play-xstate/README.md +3 -3
  352. package/api/@xmachines/play-xstate/classes/PlayerActor.md +19 -19
  353. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  354. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  355. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  356. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  357. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  358. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  359. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  360. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  361. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  362. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  363. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  364. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  365. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  366. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  367. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  368. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  369. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  370. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  371. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  372. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  373. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  374. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  375. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  376. package/api/@xmachines/shared/README.md +2 -2
  377. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  378. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  379. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  380. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  381. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  382. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  383. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  384. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  385. package/contributing/configuration.md +12 -12
  386. package/contributing/deployment.md +9 -9
  387. package/contributing/development.md +43 -43
  388. package/contributing/testing.md +15 -15
  389. package/examples/@xmachines/play-dom-demo/README.md +12 -12
  390. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  396. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  397. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  398. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  399. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  400. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  401. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  402. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  403. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  404. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  405. package/examples/@xmachines/play-dom-router-demo/README.md +12 -12
  406. package/examples/@xmachines/play-react-demo/README.md +12 -12
  407. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  408. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  413. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  414. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  415. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  416. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  417. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  418. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  419. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  420. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  421. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  422. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  423. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  424. package/examples/@xmachines/play-react-router-demo/README.md +12 -12
  425. package/examples/@xmachines/play-solid-demo/README.md +12 -12
  426. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  430. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  431. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  432. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  433. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  434. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  435. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  436. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  437. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  438. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  439. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  440. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  441. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  442. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  443. package/examples/@xmachines/play-solid-router-demo/README.md +12 -12
  444. package/examples/@xmachines/play-svelte-demo/README.md +12 -12
  445. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  446. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  447. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  448. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  449. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +12 -12
  450. package/examples/@xmachines/play-sveltekit-router-demo/README.md +12 -12
  451. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +12 -12
  452. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +12 -12
  453. package/examples/@xmachines/play-vue-demo/README.md +12 -12
  454. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  455. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  456. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  457. package/examples/@xmachines/play-vue-router-demo/README.md +12 -12
  458. package/examples/README.md +3 -3
  459. package/guides/getting-started.md +31 -38
  460. package/guides/signals.md +2 -2
  461. package/package.json +2 -2
@@ -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.56/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.57/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.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) |
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.57/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.57/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.57/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.57/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.57/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.57/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.57/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.57/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.57/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.57/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.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) |
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.57/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.57/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.57/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.56/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.57/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.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) |
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.57/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.57/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.57/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.57/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.57/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.56/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.57/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.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) |
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.57/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.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) |
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.57/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.56/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.57/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.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) |
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.57/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.57/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.56/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.57/packages/play-dom-router/src/create-router.ts#L18)
23
23
 
24
24
  Cleanup
25
25
 
@@ -11,13 +11,13 @@ Part of the [xmachines-js monorepo](../../README.md).
11
11
  ## Installation
12
12
 
13
13
  ```bash
14
- npm install @xmachines/play-react
14
+ pnpm add @xmachines/play-react
15
15
  ```
16
16
 
17
17
  **Peer dependencies** (must be installed separately):
18
18
 
19
19
  ```bash
20
- npm install react react-dom xstate @xstate/store @xmachines/json-render-react @xmachines/json-render-core @xmachines/json-render-xstate
20
+ pnpm add 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:
@@ -173,19 +173,19 @@ React state is **never** used for business logic — only for triggering React's
173
173
  Run unit tests (jsdom environment):
174
174
 
175
175
  ```bash
176
- npm test -w @xmachines/play-react
176
+ pnpm --filter @xmachines/play-react test
177
177
  ```
178
178
 
179
179
  Run tests with coverage:
180
180
 
181
181
  ```bash
182
- npm run test:coverage -w @xmachines/play-react
182
+ pnpm --filter @xmachines/play-react run test:coverage
183
183
  ```
184
184
 
185
185
  Run browser integration tests (requires Chromium):
186
186
 
187
187
  ```bash
188
- npm run test:browser -w @xmachines/play-react
188
+ pnpm --filter @xmachines/play-react run test:browser
189
189
  ```
190
190
 
191
191
  Coverage thresholds: 80% lines, functions, branches, and statements.
@@ -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.56/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.57/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.56/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.57/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.56/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.57/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.
@@ -105,7 +105,7 @@ React.Component.componentDidCatch;
105
105
  optional componentDidMount(): void;
106
106
  ```
107
107
 
108
- Defined in: `.pnpm`
108
+ Defined in: `@types/react`
109
109
 
110
110
  Called immediately after a component is mounted. Setting state here will trigger re-rendering.
111
111
 
@@ -130,7 +130,7 @@ optional componentDidUpdate(
130
130
  snapshot?): void;
131
131
  ```
132
132
 
133
- Defined in: `.pnpm`
133
+ Defined in: `@types/react`
134
134
 
135
135
  Called immediately after updating occurs. Not called for the initial render.
136
136
 
@@ -162,7 +162,7 @@ React.Component.componentDidUpdate;
162
162
  optional componentWillMount(): void;
163
163
  ```
164
164
 
165
- Defined in: `.pnpm`
165
+ Defined in: `@types/react`
166
166
 
167
167
  Called immediately before mounting occurs, and before [Component.render](https://www.jsdocs.io/package/@types/react#Component.render).
168
168
  Avoid introducing any side-effects or subscriptions in this method.
@@ -198,7 +198,7 @@ React.Component.componentWillMount;
198
198
  optional componentWillReceiveProps(nextProps, nextContext): void;
199
199
  ```
200
200
 
201
- Defined in: `.pnpm`
201
+ Defined in: `@types/react`
202
202
 
203
203
  Called when the component may be receiving new props.
204
204
  React may call this even if props have not changed, so be sure to compare new and existing
@@ -244,7 +244,7 @@ React.Component.componentWillReceiveProps;
244
244
  optional componentWillUnmount(): void;
245
245
  ```
246
246
 
247
- Defined in: `.pnpm`
247
+ Defined in: `@types/react`
248
248
 
249
249
  Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
250
250
  cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`.
@@ -270,7 +270,7 @@ optional componentWillUpdate(
270
270
  nextContext): void;
271
271
  ```
272
272
 
273
- Defined in: `.pnpm`
273
+ Defined in: `@types/react`
274
274
 
275
275
  Called immediately before rendering when new props or state is received. Not called for the initial render.
276
276
 
@@ -315,7 +315,7 @@ React.Component.componentWillUpdate;
315
315
  forceUpdate(callback?): void;
316
316
  ```
317
317
 
318
- Defined in: `.pnpm`
318
+ Defined in: `@types/react`
319
319
 
320
320
  #### Parameters
321
321
 
@@ -341,7 +341,7 @@ React.Component.forceUpdate;
341
341
  optional getSnapshotBeforeUpdate(prevProps, prevState): any;
342
342
  ```
343
343
 
344
- Defined in: `.pnpm`
344
+ Defined in: `@types/react`
345
345
 
346
346
  Runs before React applies the result of [render](https://www.jsdocs.io/package/@types/react#Component.render) to the document, and
347
347
  returns an object to be given to [componentDidUpdate](#componentdidupdate). Useful for saving
@@ -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.56/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.57/packages/play-react/src/PlayErrorBoundary.tsx#L70)
379
379
 
380
380
  #### Returns
381
381
 
@@ -395,7 +395,7 @@ React.Component.render;
395
395
  setState<K>(state, callback?): void;
396
396
  ```
397
397
 
398
- Defined in: `.pnpm`
398
+ Defined in: `@types/react`
399
399
 
400
400
  #### Type Parameters
401
401
 
@@ -431,7 +431,7 @@ optional shouldComponentUpdate(
431
431
  nextContext): boolean;
432
432
  ```
433
433
 
434
- Defined in: `.pnpm`
434
+ Defined in: `@types/react`
435
435
 
436
436
  Called to determine whether the change in props and state should trigger a re-render.
437
437
 
@@ -468,7 +468,7 @@ React.Component.shouldComponentUpdate;
468
468
  optional UNSAFE_componentWillMount(): void;
469
469
  ```
470
470
 
471
- Defined in: `.pnpm`
471
+ Defined in: `@types/react`
472
472
 
473
473
  Called immediately before mounting occurs, and before [Component.render](https://www.jsdocs.io/package/@types/react#Component.render).
474
474
  Avoid introducing any side-effects or subscriptions in this method.
@@ -506,7 +506,7 @@ React.Component.UNSAFE_componentWillMount;
506
506
  optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void;
507
507
  ```
508
508
 
509
- Defined in: `.pnpm`
509
+ Defined in: `@types/react`
510
510
 
511
511
  Called when the component may be receiving new props.
512
512
  React may call this even if props have not changed, so be sure to compare new and existing
@@ -557,7 +557,7 @@ optional UNSAFE_componentWillUpdate(
557
557
  nextContext): void;
558
558
  ```
559
559
 
560
- Defined in: `.pnpm`
560
+ Defined in: `@types/react`
561
561
 
562
562
  Called immediately before rendering when new props or state is received. Not called for the initial render.
563
563
 
@@ -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.56/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.57/packages/play-react/src/PlayErrorBoundary.tsx#L62)
608
608
 
609
609
  #### Parameters
610
610
 
@@ -6,7 +6,7 @@
6
6
  function ActionProvider(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Provider for action execution
12
12
 
@@ -6,7 +6,7 @@
6
6
  function JSONUIProvider(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Combined provider for all JSONUI contexts
12
12
 
@@ -6,7 +6,7 @@
6
6
  function Renderer(__namedParameters): Element | null;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Main renderer component
12
12
 
@@ -6,7 +6,7 @@
6
6
  function StateProvider(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Provider for state model context.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function ValidationProvider(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Provider for validation
12
12
 
@@ -6,7 +6,7 @@
6
6
  function VisibilityProvider(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Provider for visibility evaluation
12
12
 
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(_catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Create a registry from a catalog with components and/or actions.
12
12
 
@@ -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.56/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.57/packages/play-react/src/useActor.ts#L32)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,7 +6,7 @@
6
6
  function useBoundProp<T>(propValue, bindingPath): [T | undefined, (value) => void];
7
7
  ```
8
8
 
9
- Defined in: `.pnpm`
9
+ Defined in: `@xmachines/json-render-react`
10
10
 
11
11
  Hook for two-way bound props. Returns `[value, setValue]` where:
12
12
 
@@ -6,7 +6,7 @@
6
6
  function usePlayView(): ViewContextValue;
7
7
  ```
8
8
 
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)
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/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.56/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.57/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: ActionProviderProps
4
4
 
5
- Defined in: `.pnpm`
5
+ Defined in: `@xmachines/json-render-react`
6
6
 
7
7
  Props for ActionProvider
8
8