@xmachines/docs 2.1.0 → 2.1.1

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 (295) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/README.md +1 -1
  3. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  4. package/api/@xmachines/play/classes/PlayError.md +4 -4
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +1 -1
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/composePlayState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/createViewStoreLifecycle.md +1 -1
  12. package/api/@xmachines/play-actor/functions/guardContextWrites.md +1 -1
  13. package/api/@xmachines/play-actor/functions/refreshContextSubtree.md +1 -1
  14. package/api/@xmachines/play-actor/functions/reuseComposedState.md +1 -1
  15. package/api/@xmachines/play-actor/functions/shallowEqualExcept.md +1 -1
  16. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  17. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  18. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  19. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  20. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  21. package/api/@xmachines/play-actor/interfaces/ResolveViewStoreOptions.md +2 -2
  22. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  23. package/api/@xmachines/play-actor/interfaces/ViewStoreLifecycle.md +3 -3
  24. package/api/@xmachines/play-actor/interfaces/ViewStoreResolution.md +4 -4
  25. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  26. package/api/@xmachines/play-actor/variables/CONTEXT_STATE_KEY.md +1 -1
  27. package/api/@xmachines/play-dom/README.md +1 -1
  28. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  29. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  30. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  31. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  32. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  33. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  34. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  35. package/api/@xmachines/play-dom-router/README.md +1 -1
  36. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +4 -4
  37. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  38. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  39. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  40. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  41. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  42. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  43. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  44. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  45. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  46. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  47. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  49. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  52. package/api/@xmachines/play-react/README.md +1 -1
  53. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  54. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  55. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  56. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  57. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  58. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  59. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  60. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  62. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  63. package/api/@xmachines/play-react/type-aliases/PlayRendererProps.md +1 -1
  64. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  65. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  66. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  67. package/api/@xmachines/play-react-router/README.md +1 -1
  68. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  69. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  70. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  71. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  72. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  73. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  74. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  75. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  77. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  78. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  79. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  81. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  82. package/api/@xmachines/play-router/README.md +1 -1
  83. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  84. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  85. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  86. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  87. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  88. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  89. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  90. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  91. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  92. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  93. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  94. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  95. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  96. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  99. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  100. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  101. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  102. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  103. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  104. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  105. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  107. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  108. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  109. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  110. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  111. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  112. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  113. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  114. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  117. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  118. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  119. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  120. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  121. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  122. package/api/@xmachines/play-router/type-aliases/BaseRouteMapping.md +1 -1
  123. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  124. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  125. package/api/@xmachines/play-signals/README.md +1 -1
  126. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  127. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  128. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  129. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  130. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  131. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  132. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  133. package/api/@xmachines/play-solid/README.md +1 -1
  134. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  135. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  136. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  137. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  138. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  139. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  140. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  141. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  142. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  143. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  144. package/api/@xmachines/play-solid-router/README.md +1 -1
  145. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  146. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  147. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  148. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  149. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  150. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  151. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  152. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  153. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  154. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  155. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  156. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  157. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  158. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  159. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  160. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  161. package/api/@xmachines/play-svelte/README.md +1 -1
  162. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  163. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  164. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  165. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  166. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  167. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  168. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  169. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  170. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  171. package/api/@xmachines/play-svelte-spa-router/README.md +1 -1
  172. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  173. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +4 -4
  174. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  175. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  176. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  177. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  178. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  179. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  180. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  181. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  182. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  183. package/api/@xmachines/play-sveltekit-router/README.md +1 -1
  184. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  185. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +4 -4
  186. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  187. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  188. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  189. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  190. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  191. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  192. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  193. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  194. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  195. package/api/@xmachines/play-tanstack-react-router/README.md +2 -1
  196. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  197. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  198. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  199. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  200. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  201. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  202. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  203. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  204. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  205. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  206. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  207. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  208. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  209. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  210. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  211. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  212. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +59 -11
  213. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  214. package/api/@xmachines/play-tanstack-router/README.md +19 -1
  215. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  216. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  217. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +59 -11
  218. package/api/@xmachines/play-tanstack-solid-router/README.md +2 -1
  219. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  220. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  221. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  222. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  223. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  224. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  225. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  226. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  227. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  228. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  229. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  230. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  231. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  232. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  233. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +59 -11
  234. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  235. package/api/@xmachines/play-vue/README.md +1 -1
  236. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  237. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  238. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  239. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  240. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  241. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  243. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  244. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  245. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  246. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  247. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  248. package/api/@xmachines/play-vue/variables/getPlayViewContext.md +1 -1
  249. package/api/@xmachines/play-vue-router/README.md +1 -1
  250. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  251. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  252. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  253. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  254. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  255. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  256. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  257. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  258. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  259. package/api/@xmachines/play-vue-router/type-aliases/VueRouteMap.md +1 -1
  260. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  261. package/api/@xmachines/play-vue-router/variables/VueRouteMap.md +1 -1
  262. package/api/@xmachines/play-xstate/README.md +1 -1
  263. package/api/@xmachines/play-xstate/classes/PlayerActor.md +16 -16
  264. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  265. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  266. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  267. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  268. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  269. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  270. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  271. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  272. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  273. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  274. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  275. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  276. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  277. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  278. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  279. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  280. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  281. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  282. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  283. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  284. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  285. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  286. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  287. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  288. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  289. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  290. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  291. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  292. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  293. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  294. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  295. package/package.json +1 -1
package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L358)
5
+ Defined in: [play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L358)
6
6
 
7
7
  The RouterBridge interface of a runtime infrastructure adapter
8
8
 
@@ -56,7 +56,7 @@ class MyRouterBridge implements RouterBridge {
56
56
  connect(): void | Promise<void>;
57
57
  ```
58
58
 
59
- Defined in: [play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L375)
59
+ Defined in: [play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L375)
60
60
 
61
61
  Connects the router bridge to the Actor
62
62
 
@@ -86,7 +86,7 @@ await bridge.connect();
86
86
  disconnect(): void | Promise<void>;
87
87
  ```
88
88
 
89
- Defined in: [play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L391)
89
+ Defined in: [play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L391)
90
90
 
91
91
  Disconnects the router bridge from the Actor
92
92
 
package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md CHANGED
@@ -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/v2.1.0/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/v2.1.1/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) | The history instance | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-dom-router/src/create-router.ts#L8) |
12
- | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-dom-router/src/create-router.ts#L13) |
11
+ | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | The history instance | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom-router/src/create-router.ts#L8) |
12
+ | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | The route tree, as a reference to the structure | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/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/v2.1.0/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/v2.1.1/packages/play-dom-router/src/create-router.ts#L18)
23
23
 
24
24
  Cleans up
25
25
 
package/api/@xmachines/play-react/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  React renderer for XMachines Play architecture with signal-driven rendering.
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-react)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.1-blue)](https://www.npmjs.com/package/@xmachines/play-react)
8
8
 
9
9
  ## Installation
10
10
 
package/api/@xmachines/play-react/classes/PlayErrorBoundary.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayErrorBoundary
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L54)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L54)
6
6
 
7
7
  The React class component that catches a render error of a catalog component.
8
8
 
@@ -37,7 +37,7 @@ CONS-14: the class component pattern works with every React version, 18 and 19.
37
37
  new PlayErrorBoundary(props): PlayErrorBoundary;
38
38
  ```
39
39
 
40
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L58)
40
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L58)
41
41
 
42
42
  #### Parameters
43
43
 
@@ -76,7 +76,7 @@ React.Component<
76
76
  componentDidCatch(error, info): void;
77
77
  ```
78
78
 
79
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L67)
79
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L67)
80
80
 
81
81
  Catches exceptions generated in descendant components. Unhandled exceptions will cause
82
82
  the entire component tree to unmount.
@@ -376,7 +376,7 @@ React.Component.getSnapshotBeforeUpdate;
376
376
  render(): ReactNode;
377
377
  ```
378
378
 
379
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L71)
379
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L71)
380
380
 
381
381
  #### Returns
382
382
 
@@ -605,7 +605,7 @@ React.Component.UNSAFE_componentWillUpdate;
605
605
  static getDerivedStateFromError(error): PlayErrorBoundaryState;
606
606
  ```
607
607
 
608
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L63)
608
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L63)
609
609
 
610
610
  #### Parameters
611
611
 
package/api/@xmachines/play-react/functions/useActor.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function useActor(): AnyPlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/useActor.ts#L34)
9
+ Defined in: [packages/play-react/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/useActor.ts#L34)
10
10
 
11
11
  ## Returns
12
12
 
package/api/@xmachines/play-react/functions/usePlayView.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function usePlayView(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L94)
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L94)
10
10
 
11
11
  The hook that gives the current view spec, the handlers, and the registry.
12
12
 
package/api/@xmachines/play-react/functions/useSignalEffect.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function useSignalEffect(callback, deps?): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useSignalEffect.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/useSignalEffect.ts#L81)
9
+ Defined in: [packages/play-react/src/useSignalEffect.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/useSignalEffect.ts#L81)
10
10
 
11
11
  The React hook that subscribes to the signal changes and runs an effect callback
12
12
 
package/api/@xmachines/play-react/interfaces/ActorProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-react/src/ActorProvider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L53)
5
+ Defined in: [packages/play-react/src/ActorProvider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L53)
6
6
 
7
7
  The props of the ActorProvider component.
8
8
 
@@ -18,10 +18,10 @@ The props of 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) | The actor instance with the currentView signal. It requires the Viewable capability. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163) |
22
- | <a id="property-children"></a> `children` | `ReactNode` | The child components to render inside the provider tree | - | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L59) |
23
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | The component to show when currentView is null, or when a catalog component throws. This prop is optional | - | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L55) |
24
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | The optional error handler. The provider calls it when a catalog component throws during a render | - | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L57) |
25
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L177) |
26
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L165) |
27
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
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) | The actor instance with the currentView signal. It requires the Viewable capability. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L163) |
22
+ | <a id="property-children"></a> `children` | `ReactNode` | The child components to render inside the provider tree | - | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L59) |
23
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | The component to show when currentView is null, or when a catalog component throws. This prop is optional | - | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L55) |
24
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | The optional error handler. The provider calls it when a catalog component throws during a render | - | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L57) |
25
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L177) |
26
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L165) |
27
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L172) |
package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L14)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L14)
6
6
 
7
7
  The props of PlayErrorBoundary
8
8
 
@@ -10,6 +10,6 @@ The props of PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------ | --------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `ReactNode` | The child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | The fallback UI to render when a child component throws. The default is null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | The optional error handler. It sends each error to an observability tool, such as Sentry | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | The child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | The fallback UI to render when a child component throws. The default is null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | The optional error handler. It sends each error to an observability tool, such as Sentry | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryState
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L28)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L28)
6
6
 
7
7
  The internal state shape of PlayErrorBoundary
8
8
 
@@ -10,5 +10,5 @@ The internal state shape of PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Defined in |
12
12
  | ----------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
- | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
13
+ | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
+ | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayUIProvider.tsx#L35)
5
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayUIProvider.tsx#L35)
6
6
 
7
7
  The props of PlayUIProvider — every ActorProvider prop, and also the props of JSONUIProvider.
8
8
 
@@ -14,13 +14,13 @@ The props of PlayUIProvider — every ActorProvider prop, and also the props of
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <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) | The actor instance with the currentView signal. It requires the Viewable capability. | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163) |
18
- | <a id="property-children"></a> `children` | `ReactNode` | The child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L59) |
19
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | The component to show when currentView is null, or when a catalog component throws. This prop is optional | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L55) |
17
+ | <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) | The actor instance with the currentView signal. It requires the Viewable capability. | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L163) |
18
+ | <a id="property-children"></a> `children` | `ReactNode` | The child components to render inside the provider tree | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L59) |
19
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | The component to show when currentView is null, or when a catalog component throws. This prop is optional | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L55) |
20
20
  | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named functions for `$computed` expressions in props | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions) | - |
21
21
  | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate) | - |
22
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | The optional error handler. The provider calls it when a catalog component throws during a render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L57) |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L177) |
24
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L165) |
25
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
22
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | The optional error handler. The provider calls it when a catalog component throws during a render | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L57) |
23
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L177) |
24
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L165) |
25
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L172) |
26
26
  | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | - |
package/api/@xmachines/play-react/interfaces/ViewContextValue.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-react/src/ActorProvider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L67)
5
+ Defined in: [packages/play-react/src/ActorProvider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L67)
6
6
 
7
7
  The value that ViewContext provides. usePlayView() reads it.
8
8
 
@@ -14,7 +14,7 @@ The value that ViewContext provides. usePlayView() reads it.
14
14
 
15
15
  | Property | Type | Description | Inherited from | Defined in |
16
16
  | ----------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L127) |
18
- | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L129) |
19
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L125) |
20
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L133) |
17
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L127) |
18
+ | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L129) |
19
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L125) |
20
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L133) |
package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md CHANGED
@@ -6,6 +6,6 @@
6
6
  type AnyPlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useActor.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/useActor.ts#L30)
9
+ Defined in: [packages/play-react/src/useActor.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/useActor.ts#L30)
10
10
 
11
11
  The bare actor type that the React context providers accept. For the complete routing and view shape, use `PlayActor` from `@xmachines/play-router`.
package/api/@xmachines/play-react/type-aliases/PlayRendererProps.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type PlayRendererProps = ActorProviderProps;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/index.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/index.ts#L71)
9
+ Defined in: [packages/play-react/src/index.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/index.ts#L71)
10
10
 
11
11
  ## Deprecated
12
12
 
package/api/@xmachines/play-react/variables/ActorProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const ActorProvider: React.FC<ActorProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/ActorProvider.tsx:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L202)
9
+ Defined in: [packages/play-react/src/ActorProvider.tsx:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/ActorProvider.tsx#L202)
10
10
 
11
11
  ActorProvider — the low-level provider that composes the actor lifecycle with your own providers.
12
12
 
package/api/@xmachines/play-react/variables/PlayRenderer.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: React.FC<Record<string, never>>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayRenderer.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayRenderer.tsx#L40)
9
+ Defined in: [packages/play-react/src/PlayRenderer.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayRenderer.tsx#L40)
10
10
 
11
11
  The leaf component without props that renders the current actor view.
12
12
 
package/api/@xmachines/play-react/variables/PlayUIProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayUIProvider: React.FC<PlayUIProviderProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayUIProvider.tsx:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayUIProvider.tsx#L106)
9
+ Defined in: [packages/play-react/src/PlayUIProvider.tsx:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react/src/PlayUIProvider.tsx#L106)
10
10
 
11
11
  PlayUIProvider — the standard entry point for an actor-driven UI.
12
12
 
package/api/@xmachines/play-react-router/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > React Router v7 adapter for the XMachines Play Universal Player Architecture. It keeps the actor state and the browser URL in step, in both directions, through the `createBrowserRouter` data API.
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-react-router)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.1-blue)](https://www.npmjs.com/package/@xmachines/play-react-router)
8
8
 
9
9
  ---
10
10
 
package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReactRouterBridge
4
4
 
5
- Defined in: [play-react-router/src/react-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react-router/src/react-router-bridge.ts#L29)
5
+ Defined in: [play-react-router/src/react-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react-router/src/react-router-bridge.ts#L29)
6
6
 
7
7
  The abstract base class of every router adapter bridge of `@xmachines`.
8
8
 
@@ -25,7 +25,7 @@ new ReactRouterBridge(
25
25
  routeMap): ReactRouterBridge;
26
26
  ```
27
27
 
28
- Defined in: [play-react-router/src/react-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react-router/src/react-router-bridge.ts#L32)
28
+ Defined in: [play-react-router/src/react-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react-router/src/react-router-bridge.ts#L32)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -51,7 +51,7 @@ Defined in: [play-react-router/src/react-router-bridge.ts:32](https://gitlab.com
51
51
  connect(): void;
52
52
  ```
53
53
 
54
- Defined in: [play-router/src/router-bridge-base.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/router-bridge-base.ts#L158)
54
+ Defined in: [play-router/src/router-bridge-base.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/router-bridge-base.ts#L158)
55
55
 
56
56
  Connects the router bridge to the Actor.
57
57
 
@@ -85,7 +85,7 @@ An adapter that needs a different behavior of the first synchronization override
85
85
  disconnect(): void;
86
86
  ```
87
87
 
88
- Defined in: [play-router/src/router-bridge-base.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/router-bridge-base.ts#L270)
88
+ Defined in: [play-router/src/router-bridge-base.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/router-bridge-base.ts#L270)
89
89
 
90
90
  Disconnects the router bridge from the Actor.
91
91
 
package/api/@xmachines/play-react-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L105)
5
+ Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L105)
6
6
 
7
7
  The shared base class of the route map for both directions.
8
8
 
@@ -58,7 +58,7 @@ map.getPathByStateId("missing"); // null
58
58
  new RouteMap(mappings, options?): RouteMap;
59
59
  ```
60
60
 
61
- Defined in: [play-router/src/base-route-map.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L133)
61
+ Defined in: [play-router/src/base-route-map.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L133)
62
62
 
63
63
  Builds a route map from an array of the mappings between a state ID and a path.
64
64
 
@@ -87,7 +87,7 @@ candidates is therefore efficient.
87
87
  getPathByStateId(stateId): string | null;
88
88
  ```
89
89
 
90
- Defined in: [play-router/src/base-route-map.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L225)
90
+ Defined in: [play-router/src/base-route-map.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L225)
91
91
 
92
92
  Returns the path pattern of a state ID.
93
93
 
@@ -123,7 +123,7 @@ map.getPathByStateId("missing"); // null
123
123
  getStateIdByPath(path): string | null;
124
124
  ```
125
125
 
126
- Defined in: [play-router/src/base-route-map.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L185)
126
+ Defined in: [play-router/src/base-route-map.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L185)
127
127
 
128
128
  Resolves a URL path to its state ID.
129
129
 
package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createPlayRouterProvider<TRouter>(BridgeCtor): <TActor>(__namedParameters) => Element;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/create-play-router-provider.tsx:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react-router/src/create-play-router-provider.tsx#L83)
9
+ Defined in: [play-react-router/src/create-play-router-provider.tsx:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-react-router/src/create-play-router-provider.tsx#L83)
10
10
 
11
11
  Creates a React `PlayRouterProvider` component of one bridge class.
12
12
 
package/api/@xmachines/play-react-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/create-route-map.ts#L47)
9
+ Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map.ts#L47)
10
10
 
11
11
  Creates a `RouteMap` from an XState state machine.
12
12
 
package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMapFromTree(routeTree, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/create-route-map-from-tree.ts#L33)
9
+ Defined in: [play-router/src/create-route-map-from-tree.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map-from-tree.ts#L33)
10
10
 
11
11
  Creates a `RouteMap` from the node structure of a `RouteTree`.
12
12
 
package/api/@xmachines/play-react-router/interfaces/PlayActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [play-router/src/types.ts:312](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L312)
5
+ Defined in: [play-router/src/types.ts:312](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L312)
6
6
 
7
7
  The complete actor shape of the `PlayRouterProvider` component of each framework
8
8
  adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
@@ -39,9 +39,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
39
39
 
40
40
  | Property | Modifier | Type | Description | Inherited from | Defined in |
41
41
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
42
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:274](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L274) |
43
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active. | - | [play-router/src/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L314) |
44
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L280) |
42
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:274](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L274) |
43
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active. | - | [play-router/src/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L314) |
44
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L280) |
45
45
 
46
46
  ## Methods
47
47
 
@@ -51,7 +51,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
51
51
  send(event): void;
52
52
  ```
53
53
 
54
- Defined in: [play-router/src/types.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L282)
54
+ Defined in: [play-router/src/types.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L282)
55
55
 
56
56
  Sends a route navigation event to the actor.
57
57
 
package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L237)
5
+ Defined in: [play-router/src/types.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L237)
6
6
 
7
7
  The routing event, with its parameters and its query
8
8
 
@@ -128,8 +128,8 @@ analysis of the pattern.
128
128
 
129
129
  | Property | Modifier | Type | Defined in |
130
130
  | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
131
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L242) |
132
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L240) |
133
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L241) |
134
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L239) |
135
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L238) |
131
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L242) |
132
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L240) |
133
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L241) |
134
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L239) |
135
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L238) |