@xmachines/docs 2.1.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (336) hide show
  1. package/README.md +2 -2
  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 +3 -1
  36. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +149 -7
  37. package/api/@xmachines/play-dom-router/functions/connectRouter.md +6 -5
  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/BasePathOptions.md +32 -0
  42. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  43. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  44. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +12 -6
  45. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  46. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  47. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +76 -0
  53. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  54. package/api/@xmachines/play-react/README.md +1 -1
  55. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  56. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  57. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  58. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  59. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  60. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  61. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  62. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  63. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  64. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  65. package/api/@xmachines/play-react/type-aliases/PlayRendererProps.md +1 -1
  66. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  67. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  69. package/api/@xmachines/play-react-router/README.md +2 -2
  70. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +172 -15
  71. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  72. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +7 -18
  73. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  74. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  75. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  77. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +10 -8
  78. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  79. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  80. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  81. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +15 -9
  82. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +26 -0
  83. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +4 -4
  84. package/api/@xmachines/play-router/README.md +297 -11
  85. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  86. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +178 -19
  87. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  88. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  89. package/api/@xmachines/play-router/functions/cleanFrameworkParams.md +40 -0
  90. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  91. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  92. package/api/@xmachines/play-router/functions/createRouterConnection.md +21 -0
  93. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  94. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  95. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  96. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  97. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  98. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  99. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  100. package/api/@xmachines/play-router/functions/getPatternParamNames.md +24 -0
  101. package/api/@xmachines/play-router/functions/getRequiredPatternParamNames.md +36 -0
  102. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  103. package/api/@xmachines/play-router/functions/getRouteMappings.md +67 -0
  104. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  105. package/api/@xmachines/play-router/functions/isMountableBridge.md +26 -0
  106. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  107. package/api/@xmachines/play-router/functions/joinBasePath.md +37 -0
  108. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  109. package/api/@xmachines/play-router/functions/mountKey.md +28 -0
  110. package/api/@xmachines/play-router/functions/normalizeBasePath.md +43 -0
  111. package/api/@xmachines/play-router/functions/openProviderBridge.md +41 -0
  112. package/api/@xmachines/play-router/functions/pickOwnParams.md +41 -0
  113. package/api/@xmachines/play-router/functions/repointProviderBridge.md +27 -0
  114. package/api/@xmachines/play-router/functions/resolveBasePath.md +51 -0
  115. package/api/@xmachines/play-router/functions/resolveFrameworkParams.md +51 -0
  116. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  117. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  118. package/api/@xmachines/play-router/functions/stripBasePath.md +44 -0
  119. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  120. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  121. package/api/@xmachines/play-router/interfaces/BasePathOptions.md +32 -0
  122. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  123. package/api/@xmachines/play-router/interfaces/FrameworkParamsSource.md +47 -0
  124. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  125. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  126. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  127. package/api/@xmachines/play-router/interfaces/MountableRouterBridge.md +130 -0
  128. package/api/@xmachines/play-router/interfaces/OpenProviderBridgeArgs.md +28 -0
  129. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  130. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  131. package/api/@xmachines/play-router/interfaces/PlayRouterProviderBaseProps.md +33 -0
  132. package/api/@xmachines/play-router/interfaces/ResolvedBasePath.md +14 -0
  133. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  134. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  135. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  136. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  137. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  138. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  139. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  140. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  141. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  142. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  143. package/api/@xmachines/play-router/interfaces/RouterBridge.md +7 -3
  144. package/api/@xmachines/play-router/interfaces/RouterConnection.md +76 -0
  145. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  146. package/api/@xmachines/play-router/type-aliases/BaseRouteMapping.md +1 -1
  147. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  148. package/api/@xmachines/play-router/type-aliases/PlayRouterBridgeConstructor.md +36 -0
  149. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  150. package/api/@xmachines/play-router/variables/NO_BASE_PATH.md +18 -0
  151. package/api/@xmachines/play-signals/README.md +1 -1
  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/type-aliases/WatcherNotify.md +1 -1
  159. package/api/@xmachines/play-solid/README.md +1 -1
  160. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  161. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  162. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  163. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  164. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  165. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  166. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  167. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  168. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  169. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  170. package/api/@xmachines/play-solid-router/README.md +19 -3
  171. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  172. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +166 -18
  173. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +8 -18
  174. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  175. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  176. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  177. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  178. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +10 -8
  179. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  180. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  181. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  182. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +14 -12
  183. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +26 -0
  184. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  185. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  186. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +4 -4
  187. package/api/@xmachines/play-svelte/README.md +1 -1
  188. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  189. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  190. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  191. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  192. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  193. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  194. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  195. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  196. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  197. package/api/@xmachines/play-svelte-spa-router/README.md +3 -1
  198. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  199. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +148 -6
  200. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +3 -3
  201. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  202. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +32 -0
  203. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +12 -6
  204. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  205. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  206. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  207. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  208. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +76 -0
  209. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  210. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  211. package/api/@xmachines/play-sveltekit-router/README.md +3 -1
  212. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  213. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +148 -6
  214. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +3 -3
  215. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  216. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +32 -0
  217. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +28 -6
  218. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  219. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  220. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  221. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  222. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  223. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +76 -0
  224. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  225. package/api/@xmachines/play-tanstack-react-router/README.md +2 -2
  226. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  227. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +148 -6
  228. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +7 -18
  229. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  230. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  231. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  232. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  233. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  234. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +10 -8
  235. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  236. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  237. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  238. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  239. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +15 -9
  240. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +26 -0
  241. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  242. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  243. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +4 -4
  244. package/api/@xmachines/play-tanstack-router/README.md +1 -1
  245. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +153 -11
  246. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  247. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  248. package/api/@xmachines/play-tanstack-solid-router/README.md +2 -2
  249. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  250. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +149 -7
  251. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +7 -17
  252. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  253. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  254. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  255. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +10 -8
  256. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  257. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  258. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  259. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +15 -9
  260. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +26 -0
  261. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  262. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  263. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  264. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +4 -4
  265. package/api/@xmachines/play-vue/README.md +1 -1
  266. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  267. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  268. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  269. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  270. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  271. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  272. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  273. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  274. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  275. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  276. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  277. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  278. package/api/@xmachines/play-vue/variables/getPlayViewContext.md +1 -1
  279. package/api/@xmachines/play-vue-router/README.md +1 -1
  280. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  281. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +154 -12
  282. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  283. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  284. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  285. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  286. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  287. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  288. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  289. package/api/@xmachines/play-vue-router/type-aliases/VueRouteMap.md +1 -1
  290. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +25 -2
  291. package/api/@xmachines/play-vue-router/variables/VueRouteMap.md +1 -1
  292. package/api/@xmachines/play-xstate/README.md +1 -1
  293. package/api/@xmachines/play-xstate/classes/PlayerActor.md +16 -16
  294. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  295. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  296. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  297. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  298. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  299. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  300. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  301. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  302. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  303. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  304. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  305. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  306. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  307. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  308. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  309. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  310. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  311. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  312. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  313. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  314. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  315. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  316. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  317. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  318. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  319. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  320. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  321. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  322. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  323. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  324. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  325. package/contributing/configuration.md +1 -1
  326. package/contributing/development.md +16 -16
  327. package/contributing/testing.md +31 -4
  328. package/examples/README.md +1 -1
  329. package/examples/multi-router-integration.md +126 -1
  330. package/examples/routing-patterns.md +1 -1
  331. package/guides/inspector.md +1 -1
  332. package/package.json +1 -1
  333. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +0 -32
  334. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +0 -30
  335. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +0 -32
  336. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +0 -31
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  > Documentation, guides, RFCs, and generated API reference for XMachines.
4
4
 
5
- [![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/docs)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.2.0-blue)](https://www.npmjs.com/package/@xmachines/docs)
6
6
 
7
7
  ## Overview
8
8
 
@@ -103,7 +103,7 @@ Practical code examples that show the XMachines patterns:
103
103
  - **[Traffic Light](examples/traffic-light.md)** — Multi-state machine with `meta.route` and `formatPlayRouteTransitions`
104
104
  - **[Form Validation](examples/form-validation.md)** — Typed context mutations with `setup.assign`, guards, and `$bindState`
105
105
  - **[Routing Patterns](examples/routing-patterns.md)** — `meta.route`, `play.route` events, `always` auth guards
106
- - **[Multi-Router Integration](examples/multi-router-integration.md)** — All 8 router adapters
106
+ - **[Multi-Router Integration](examples/multi-router-integration.md)** — All 8 router adapters, and `basePath` for sharing a router with the host
107
107
 
108
108
  ### API Reference
109
109
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  > Core protocol layer for the Universal Player Architecture. It defines `PlayEvent`, `PlayError`, and the contracts that keep the business logic loosely coupled to the runtime adapters.
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.1-blue)](https://www.npmjs.com/package/@xmachines/play)
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.2.0-blue)](https://www.npmjs.com/package/@xmachines/play)
8
8
 
9
9
  ---
10
10
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: NonNullableError
4
4
 
5
- Defined in: [packages/play/src/errors.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L110)
5
+ Defined in: [packages/play/src/errors.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L110)
6
6
 
7
7
  [assertNonNullable](../functions/assertNonNullable.md) throws this error when a value is `null` or `undefined`.
8
8
 
@@ -35,7 +35,7 @@ try {
35
35
  new NonNullableError(message, options?): NonNullableError;
36
36
  ```
37
37
 
38
- Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L111)
38
+ Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L111)
39
39
 
40
40
  #### Parameters
41
41
 
@@ -57,10 +57,10 @@ Defined in: [packages/play/src/errors.ts:111](https://gitlab.com/xmachin-es/xmac
57
57
  | Property | Modifier | Type | Description | Inherited from | Defined in |
58
58
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
59
59
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](PlayError.md).[`cause`](PlayError.md#property-cause) | - |
60
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code) | [packages/play/src/errors.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L74) |
60
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](PlayError.md).[`code`](PlayError.md#property-code) | [packages/play/src/errors.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L74) |
61
61
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](PlayError.md).[`message`](PlayError.md#property-message) | - |
62
62
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](PlayError.md).[`name`](PlayError.md#property-name) | - |
63
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"RouterBridgeBase"`. | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope) | [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L64) |
63
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"RouterBridgeBase"`. | [`PlayError`](PlayError.md).[`scope`](PlayError.md#property-scope) | [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L64) |
64
64
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](PlayError.md).[`stack`](PlayError.md#property-stack) | - |
65
65
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](PlayError.md).[`stackTraceLimit`](PlayError.md#property-stacktracelimit) | - |
66
66
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayError
4
4
 
5
- Defined in: [packages/play/src/errors.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L62)
5
+ Defined in: [packages/play/src/errors.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L62)
6
6
 
7
7
  The base class of every typed runtime error of an `@xmachines/*` package.
8
8
 
@@ -85,7 +85,7 @@ new PlayError(
85
85
  options?): PlayError;
86
86
  ```
87
87
 
88
- Defined in: [packages/play/src/errors.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L82)
88
+ Defined in: [packages/play/src/errors.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L82)
89
89
 
90
90
  #### Parameters
91
91
 
@@ -111,10 +111,10 @@ Error.constructor;
111
111
  | Property | Modifier | Type | Description | Inherited from | Defined in |
112
112
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |
113
113
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | `Error.cause` | - |
114
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | - | [packages/play/src/errors.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L74) |
114
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | - | [packages/play/src/errors.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L74) |
115
115
  | <a id="property-message"></a> `message` | `public` | `string` | - | `Error.message` | - |
116
116
  | <a id="property-name"></a> `name` | `public` | `string` | - | `Error.name` | - |
117
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"RouterBridgeBase"`. | - | [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/errors.ts#L64) |
117
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"RouterBridgeBase"`. | - | [packages/play/src/errors.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/errors.ts#L64) |
118
118
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | - |
119
119
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | - |
120
120
 
@@ -6,7 +6,7 @@
6
6
  function assertNonNullable<V>(value, name?): NonNullable<V>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/utils.ts#L39)
9
+ Defined in: [packages/play/src/utils.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/utils.ts#L39)
10
10
 
11
11
  Asserts that `value` is not `null` and not `undefined`, then returns it with the
12
12
  type `NonNullable<V>`. One expression therefore holds the guard and the narrowed
@@ -6,7 +6,7 @@
6
6
  type PlayEvent<TPayload> = object & TPayload;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/types.ts#L71)
9
+ Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/types.ts#L71)
10
10
 
11
11
  The generic event type of the Play Architecture
12
12
 
@@ -35,7 +35,7 @@ and of the other state machine libraries.
35
35
 
36
36
  | Name | Type | Defined in |
37
37
  | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
38
- | `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play/src/types.ts#L72) |
38
+ | `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play/src/types.ts#L72) |
39
39
 
40
40
  ## Type Parameters
41
41
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Abstract Actor base class for XMachines Play Architecture.
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.1-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
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.2.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
8
8
 
9
9
  ## Installation
10
10
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L197)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L197)
6
6
 
7
7
  The abstract base class of an actor of the Play Architecture.
8
8
 
@@ -74,7 +74,7 @@ Actor<TLogic>.constructor
74
74
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
75
75
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
76
76
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
77
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | The reactive snapshot of the current actor state. The infrastructure observes this signal, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | - | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L207) |
77
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | The reactive snapshot of the current actor state. The infrastructure observes this signal, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | - | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L207) |
78
78
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
79
79
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
80
80
 
@@ -245,7 +245,7 @@ Actor.select;
245
245
  abstract send(event): void;
246
246
  ```
247
247
 
248
- Defined in: [packages/play-actor/src/abstract-actor.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L223)
248
+ Defined in: [packages/play-actor/src/abstract-actor.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L223)
249
249
 
250
250
  Sends an event to the Actor.
251
251
 
@@ -6,7 +6,7 @@
6
6
  function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/provider-guards.ts#L68)
9
+ Defined in: [packages/play-actor/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/provider-guards.ts#L68)
10
10
 
11
11
  Copies a component registry, and puts an `onRenderError` handler into the copy.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function composePlayState(authoredState, slice): Record<string, unknown> | undefined;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/context-projection.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/context-projection.ts#L228)
9
+ Defined in: [packages/play-actor/src/context-projection.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L228)
10
10
 
11
11
  Composes the effective state of a view: the authored `spec.state` and the
12
12
  `/context` slice.
@@ -6,7 +6,7 @@
6
6
  function createViewStoreLifecycle(createStore): ViewStoreLifecycle;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L94)
9
+ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L94)
10
10
 
11
11
  Creates a coordinator of the lifecycle.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function guardContextWrites(store): StateStore;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/context-projection.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/context-projection.ts#L151)
9
+ Defined in: [packages/play-actor/src/context-projection.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L151)
10
10
 
11
11
  Wraps a StateStore, and the wrapper refuses each write under `/context`.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function refreshContextSubtree(store, view): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/context-projection.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/context-projection.ts#L210)
9
+ Defined in: [packages/play-actor/src/context-projection.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L210)
10
10
 
11
11
  Refreshes the `/context` subtree of a live store from the composed state of a
12
12
  derived view. An emission with the same `viewKey` means that only the projection
@@ -6,7 +6,7 @@
6
6
  function reuseComposedState(prev, next): PlaySpec | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/context-projection.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/context-projection.ts#L92)
9
+ Defined in: [packages/play-actor/src/context-projection.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L92)
10
10
 
11
11
  Reuses the composed `state` of the previous emission, or the complete previous
12
12
  spec, when the value of the projection did not change.
@@ -6,7 +6,7 @@
6
6
  function shallowEqualExcept(a, b, except?): boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/context-projection.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/context-projection.ts#L58)
9
+ Defined in: [packages/play-actor/src/context-projection.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L58)
10
10
 
11
11
  The shallow equality of the own keys, with `Object.is`. It can ignore one key on
12
12
  both sides.
@@ -6,7 +6,7 @@
6
6
  function toAtomState(state): Record<string, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/provider-guards.ts#L39)
9
+ Defined in: [packages/play-actor/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/provider-guards.ts#L39)
10
10
 
11
11
  Converts the `state` field of a spec into a plain object for `createAtom`, in a safe way.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function typedSpec(spec): PlaySpec;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L91)
9
+ Defined in: [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L91)
10
10
 
11
11
  The identity helper gives a view spec literal the type `PlaySpec` at the
12
12
  definition site. The compiler therefore checks the spec, and the IDE completes it.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseActorProviderProps\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L159)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L159)
6
6
 
7
7
  The framework-agnostic base props. Every `ActorProvider` implementation shares
8
8
  them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -42,7 +42,7 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
42
42
 
43
43
  | Property | Type | Description | Defined in |
44
44
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
45
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability. | [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) |
46
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [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) |
47
- | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [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) |
48
- | <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. | [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) |
45
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability. | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L163) |
46
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L177) |
47
+ | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L165) |
48
+ | <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. | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L172) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseViewContextValue\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L123)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L123)
6
6
 
7
7
  The framework-agnostic base of the `ViewContextValue` type in each framework.
8
8
 
@@ -28,7 +28,7 @@ same generic parameter as in `BaseActorProviderProps`.
28
28
 
29
29
  | Property | Type | Description | Defined in |
30
30
  | ----------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
31
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [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) |
32
- | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.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) |
33
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [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) |
34
- | <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. | [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) |
31
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L127) |
32
+ | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L129) |
33
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L125) |
34
+ | <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. | [packages/play-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L133) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlaySpec
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L47)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L47)
6
6
 
7
7
  The XMachines extension of the `Spec` type of `@xmachines/json-render-core`.
8
8
 
@@ -23,4 +23,4 @@ spec reads only the paths that it needs.
23
23
  | <a id="property-elements"></a> `elements` | `public` | `Record`\<`string`, `UIElement`\> | Flat map of elements by key | `Spec.elements` | - |
24
24
  | <a id="property-root"></a> `root` | `public` | `string` | Root element key | `Spec.root` | - |
25
25
  | <a id="property-state"></a> `state?` | `public` | `Record`\<`string`, `unknown`\> | Optional initial state to seed the state model. Components using statePath will read from / write to this state. | `Spec.state` | - |
26
- | <a id="property-viewkey"></a> `viewKey?` | `readonly` | `string` | The identity of the view of this derived spec. `deriveCurrentView` sets it from the meta entry that the derivation selected. A provider uses it as the key of its store lifecycle: a new `viewKey` seeds the store again, and the same `viewKey` refreshes `/context` in place, which keeps the ephemeral view state. Never write this field in `meta.view`. | - | [packages/play-actor/src/abstract-actor.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L55) |
26
+ | <a id="property-viewkey"></a> `viewKey?` | `readonly` | `string` | The identity of the view of this derived spec. `deriveCurrentView` sets it from the meta entry that the derivation selected. A provider uses it as the key of its store lifecycle: a new `viewKey` seeds the store again, and the same `viewKey` refreshes `/context` in place, which keeps the ephemeral view state. Never write this field in `meta.view`. | - | [packages/play-actor/src/abstract-actor.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L55) |
@@ -2,10 +2,10 @@
2
2
 
3
3
  # Interface: ResolveViewStoreOptions
4
4
 
5
- Defined in: [packages/play-actor/src/view-store-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L57)
5
+ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L57)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Description | Defined in |
10
10
  | ------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
11
- | <a id="property-refreshexternalstore"></a> `refreshExternalStore?` | `boolean` | The controlled mode only: refresh the /context subtree of the external store during this resolve. The default is true. Give false where the call site permits no notification of the store subscribers, which is the render path of React, and refresh from an effect instead. | [packages/play-actor/src/view-store-lifecycle.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L64) |
11
+ | <a id="property-refreshexternalstore"></a> `refreshExternalStore?` | `boolean` | The controlled mode only: refresh the /context subtree of the external store during this resolve. The default is true. Give false where the call site permits no notification of the store subscribers, which is the render path of React, and refresh from an effect instead. | [packages/play-actor/src/view-store-lifecycle.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L64) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Routable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L33)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L33)
6
6
 
7
7
  An optional capability: the routing support
8
8
 
@@ -10,5 +10,5 @@ An optional capability: the routing support
10
10
 
11
11
  | Property | Modifier | Type | Defined in |
12
12
  | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L34) |
14
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [packages/play-actor/src/abstract-actor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L35) |
13
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | [packages/play-actor/src/abstract-actor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L34) |
14
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [packages/play-actor/src/abstract-actor.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L35) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewStoreLifecycle
4
4
 
5
- Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L67)
5
+ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L67)
6
6
 
7
7
  ## Methods
8
8
 
@@ -12,7 +12,7 @@ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:67](https://gitlab.
12
12
  reset(): void;
13
13
  ```
14
14
 
15
- Defined in: [packages/play-actor/src/view-store-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L84)
15
+ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L84)
16
16
 
17
17
  Drops everything, on an unmount or a disconnect. The next resolve makes a new seed.
18
18
 
@@ -32,7 +32,7 @@ resolve(
32
32
  options?): ViewStoreResolution;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-actor/src/view-store-lifecycle.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L77)
35
+ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L77)
36
36
 
37
37
  Brings the store in line with an emission, and returns it with its guard.
38
38
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewStoreResolution
4
4
 
5
- Defined in: [packages/play-actor/src/view-store-lifecycle.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L38)
5
+ Defined in: [packages/play-actor/src/view-store-lifecycle.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L38)
6
6
 
7
7
  The result of a resolve — see [ViewStoreLifecycle.resolve](ViewStoreLifecycle.md#resolve).
8
8
 
@@ -10,6 +10,6 @@ The result of a resolve — see [ViewStoreLifecycle.resolve](ViewStoreLifecycle.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-guardedstore"></a> `guardedStore` | `StateStore` | The store to give to the children ($bindState, setState, and a chained set): a write under /context throws. There is one wrapper for each store below it, and the code caches the identity. Therefore a consumer in the style of `useSyncExternalStore` stays stable. | [packages/play-actor/src/view-store-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L47) |
14
- | <a id="property-reseeded"></a> `reseeded` | `boolean` | It is true when this resolve made a new store: at the first resolve, on a change of the viewKey, in the fallback for each emission, and on a change of the actor. A provider that mounts a subtree again for each store, such as the storeKey of Vue, uses this field as its key. | [packages/play-actor/src/view-store-lifecycle.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L54) |
15
- | <a id="property-store"></a> `store` | `StateStore` | The store WITHOUT the guard — the reference of the machinery for its own refresh. | [packages/play-actor/src/view-store-lifecycle.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/view-store-lifecycle.ts#L40) |
13
+ | <a id="property-guardedstore"></a> `guardedStore` | `StateStore` | The store to give to the children ($bindState, setState, and a chained set): a write under /context throws. There is one wrapper for each store below it, and the code caches the identity. Therefore a consumer in the style of `useSyncExternalStore` stays stable. | [packages/play-actor/src/view-store-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L47) |
14
+ | <a id="property-reseeded"></a> `reseeded` | `boolean` | It is true when this resolve made a new store: at the first resolve, on a change of the viewKey, in the fallback for each emission, and on a change of the actor. A provider that mounts a subtree again for each store, such as the storeKey of Vue, uses this field as its key. | [packages/play-actor/src/view-store-lifecycle.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L54) |
15
+ | <a id="property-store"></a> `store` | `StateStore` | The store WITHOUT the guard — the reference of the machinery for its own refresh. | [packages/play-actor/src/view-store-lifecycle.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/view-store-lifecycle.ts#L40) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Viewable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L103)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L103)
6
6
 
7
7
  The actor capability that exposes a renderable view state.
8
8
 
@@ -15,4 +15,4 @@ therefore holds no view logic.
15
15
 
16
16
  | Property | Modifier | Type | Description | Defined in |
17
17
  | ----------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | The signal of the current view. It holds the json-render PlaySpec of the current machine state, or null when no view is active. The infrastructure renders the view. This is the Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L110) |
18
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](PlaySpec.md) \| `null`\> | The signal of the current view. It holds the json-render PlaySpec of the current machine state, or null when no view is active. The infrastructure renders the view. This is the Logic-Driven UI invariant. | [packages/play-actor/src/abstract-actor.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/abstract-actor.ts#L110) |
@@ -6,7 +6,7 @@
6
6
  const CONTEXT_STATE_KEY: "context" = "context";
7
7
  ```
8
8
 
9
- Defined in: [packages/play-actor/src/context-projection.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/context-projection.ts#L32)
9
+ Defined in: [packages/play-actor/src/context-projection.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-actor/src/context-projection.ts#L32)
10
10
 
11
11
  The reserved top-level state key of the projection.
12
12
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Vanilla DOM 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.1-blue)](https://www.npmjs.com/package/@xmachines/play-dom)
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.2.0-blue)](https://www.npmjs.com/package/@xmachines/play-dom)
8
8
 
9
9
  ## Installation
10
10
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayRenderer
4
4
 
5
- Defined in: [packages/play-dom/src/PlayRenderer.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom/src/PlayRenderer.ts#L72)
5
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom/src/PlayRenderer.ts#L72)
6
6
 
7
7
  PlayRenderer connects the `currentView` signal of an actor to the DOM renderer.
8
8
 
@@ -63,7 +63,7 @@ new PlayRenderer(
63
63
  options?): PlayRenderer;
64
64
  ```
65
65
 
66
- Defined in: [packages/play-dom/src/PlayRenderer.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom/src/PlayRenderer.ts#L130)
66
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom/src/PlayRenderer.ts#L130)
67
67
 
68
68
  #### Parameters
69
69
 
@@ -86,7 +86,7 @@ Defined in: [packages/play-dom/src/PlayRenderer.ts:130](https://gitlab.com/xmach
86
86
  connect(): void;
87
87
  ```
88
88
 
89
- Defined in: [packages/play-dom/src/PlayRenderer.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom/src/PlayRenderer.ts#L146)
89
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom/src/PlayRenderer.ts#L146)
90
90
 
91
91
  Starts the watch of actor.currentView, and renders into the container.
92
92
  It renders the first view synchronously, then it subscribes to the signal changes.
@@ -108,7 +108,7 @@ renderer first.
108
108
  disconnect(): void;
109
109
  ```
110
110
 
111
- Defined in: [packages/play-dom/src/PlayRenderer.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom/src/PlayRenderer.ts#L155)
111
+ Defined in: [packages/play-dom/src/PlayRenderer.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom/src/PlayRenderer.ts#L155)
112
112
 
113
113
  Stops the watch and clears the container.
114
114
 
@@ -6,7 +6,7 @@
6
6
  function createPlayUI(registryResult, options?): MountFn;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-play-ui.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom/src/create-play-ui.ts#L95)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom/src/create-play-ui.ts#L95)
10
10
 
11
11
  Creates the mount function of the complete DOM renderer.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRenderer<C>(catalog, componentMap): (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-renderer.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-dom/src/create-renderer.ts#L88)
9
+ Defined in: [packages/play-dom/src/create-renderer.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-dom/src/create-renderer.ts#L88)
10
10
 
11
11
  Creates a DOM renderer factory from a catalog and a component map. You can use
12
12
  the factory more than one time.