@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/api/@xmachines/play-solid-router/interfaces/RouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L54)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L54)
6
6
 
7
7
  One entry of the map between a state ID and a path.
8
8
 
@@ -24,5 +24,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
24
24
 
25
25
  | Property | Modifier | Type | Description | Defined in |
26
26
  | --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
- | <a id="property-path"></a> `path` | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L58) |
28
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"` | [packages/play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L56) |
27
+ | <a id="property-path"></a> `path` | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [packages/play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L58) |
28
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"` | [packages/play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L56) |
package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L358)
5
+ Defined in: [packages/play-router/src/types.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L359)
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: [packages/play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L375)
59
+ Defined in: [packages/play-router/src/types.ts:376](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L376)
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: [packages/play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L391)
89
+ Defined in: [packages/play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/types.ts#L392)
90
90
 
91
91
  Disconnects the router bridge from the Actor
92
92
 
package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md CHANGED
@@ -3,17 +3,18 @@
3
3
  # Type Alias: PlayRouterBridgeConstructor\<TRouter\>
4
4
 
5
5
  ```ts
6
- type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
6
+ type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap, options?) => RouterBridge;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/create-play-router-provider.tsx#L24)
9
+ Defined in: [packages/play-router/src/provider-lifecycle.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/provider-lifecycle.ts#L101)
10
10
 
11
- The constructor shape that a bridge class must satisfy for
12
- `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
11
+ The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
13
12
 
14
- A bridge with another constructor shape, for example `SolidRouterBridge`, which
15
- takes each hook result as a separate argument, receives a thin subclass. That
16
- subclass packs the `router` prop again.
13
+ The return type is `RouterBridge`, the published contract of a bridge, so a
14
+ consumer bridge of its own keeps compiling. Every bridge on `RouterBridgeBase` also
15
+ satisfies `MountableRouterBridge`, and the provider finds that mount API at run
16
+ time: a bridge without it ignores `basePath`, exactly as it did before the option
17
+ existed.
17
18
 
18
19
  ## Type Parameters
19
20
 
@@ -23,11 +24,12 @@ subclass packs the `router` prop again.
23
24
 
24
25
  ## Parameters
25
26
 
26
- | Parameter | Type |
27
- | ---------- | ----------------------------------------- |
28
- | `router` | `TRouter` |
29
- | `actor` | [`PlayActor`](../interfaces/PlayActor.md) |
30
- | `routeMap` | [`RouteMap`](../classes/RouteMap.md) |
27
+ | Parameter | Type |
28
+ | ---------- | ------------------------------------------------------------------------ |
29
+ | `router` | `TRouter` |
30
+ | `actor` | [`PlayActor`](../interfaces/PlayActor.md) |
31
+ | `routeMap` | [`RouteMap`](../classes/RouteMap.md) |
32
+ | `options?` | [`BasePathOptions`](../../play-dom-router/interfaces/BasePathOptions.md) |
31
33
 
32
34
  ## Returns
33
35
 
package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md ADDED
@@ -0,0 +1,26 @@
1
+ [API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouterProviderBaseProps
2
+
3
+ # Type Alias: PlayRouterProviderBaseProps\<TRouter, TActor\>
4
+
5
+ ```ts
6
+ type PlayRouterProviderBaseProps<TRouter, TActor> = PlayRouterProviderBaseProps<
7
+ TRouter,
8
+ TActor,
9
+ JSX.Element
10
+ >;
11
+ ```
12
+
13
+ Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/create-play-router-provider.tsx#L34)
14
+
15
+ The props of a Solid `PlayRouterProvider`.
16
+
17
+ `TRouter` is the type of the router instance of the adapter, and the node type is
18
+ bound to `JSX.Element`. See `PlayRouterProviderBaseProps` of
19
+ `@xmachines/play-router` for what each prop means.
20
+
21
+ ## Type Parameters
22
+
23
+ | Type Parameter | Default type |
24
+ | ------------------------------------------------------------ | ----------------------------------------- |
25
+ | `TRouter` | - |
26
+ | `TActor` _extends_ [`PlayActor`](../interfaces/PlayActor.md) | [`PlayActor`](../interfaces/PlayActor.md) |
package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/play-router-provider.tsx#L19)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/play-router-provider.tsx#L19)
10
10
 
11
11
  ## Deprecated
12
12
 
package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type SolidRouterHooks = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/play-router-provider.tsx#L37)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/play-router-provider.tsx#L37)
10
10
 
11
11
  The three results of the Solid Router hooks that `PlayRouterProvider` and
12
12
  `SolidRouterBridge` need. Give them directly from the hook calls of your component:
@@ -31,7 +31,7 @@ const params = useParams(); // → SolidRouterHooks.params
31
31
  location: Location;
32
32
  ```
33
33
 
34
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/play-router-provider.tsx#L39)
34
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/play-router-provider.tsx#L39)
35
35
 
36
36
  ---
37
37
 
@@ -41,7 +41,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https:/
41
41
  navigate: Navigator;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/play-router-provider.tsx#L38)
44
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/play-router-provider.tsx#L38)
45
45
 
46
46
  ---
47
47
 
@@ -51,4 +51,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https:/
51
51
  params: Params;
52
52
  ```
53
53
 
54
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/play-router-provider.tsx#L40)
54
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/play-router-provider.tsx#L40)
package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayRouterProvider: <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-solid-router/src/play-router-provider.tsx#L94)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-solid-router/src/play-router-provider.tsx#L99)
10
10
 
11
11
  Connects a `PlayerActor` to Solid Router. It keeps the actor state and the browser
12
12
  URL in step, in both directions.
@@ -44,9 +44,9 @@ function AppShell() {
44
44
 
45
45
  ## Parameters
46
46
 
47
- | Parameter | Type |
48
- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
49
- | `props` | [`PlayRouterProviderBaseProps`](../interfaces/PlayRouterProviderBaseProps.md)\<[`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md), `TActor`\> |
47
+ | Parameter | Type |
48
+ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
49
+ | `props` | [`PlayRouterProviderBaseProps`](../type-aliases/PlayRouterProviderBaseProps.md)\<[`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md), `TActor`\> |
50
50
 
51
51
  ## Returns
52
52
 
package/api/@xmachines/play-svelte/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Svelte 5 renderer for the XMachines Play architecture. It connects an actor to a catalog-driven `@xmachines/json-render-svelte` UI, with Svelte 5 runes and TC39 Signals.
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-svelte)
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-svelte)
8
8
 
9
9
  ## Installation
10
10
 
package/api/@xmachines/play-svelte/functions/defineRegistry.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/define-registry.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/define-registry.ts#L156)
9
+ Defined in: [packages/play-svelte/src/define-registry.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/define-registry.ts#L156)
10
10
 
11
11
  Creates a component registry, and gives each action handler its catalog-typed `params`.
12
12
 
package/api/@xmachines/play-svelte/functions/getActorContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getActorContext(): AnyPlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L42)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L42)
10
10
 
11
11
  Returns the actor of the nearest ActorProvider ancestor.
12
12
 
package/api/@xmachines/play-svelte/functions/getPlayViewContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getPlayViewContext(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L63)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L63)
10
10
 
11
11
  Returns the current view context of the nearest ActorProvider ancestor.
12
12
 
package/api/@xmachines/play-svelte/functions/setActorContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function setActorContext(actor): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L31)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L31)
10
10
 
11
11
  ## Parameters
12
12
 
package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L72)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L72)
6
6
 
7
7
  The framework-agnostic base props. Every `ActorProvider` implementation shares
8
8
  them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -37,10 +37,10 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
37
37
 
38
38
  | Property | Type | Description | Inherited from | Defined in |
39
39
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
40
- | <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) |
41
- | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L75) |
42
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L73) |
43
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L74) |
44
- | <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) |
45
- | <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) |
46
- | <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) |
40
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L163) |
41
+ | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L75) |
42
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L73) |
43
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L74) |
44
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L177) |
45
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L165) |
46
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L172) |
package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [packages/play-svelte/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/define-registry.ts#L94)
5
+ Defined in: [packages/play-svelte/src/define-registry.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/define-registry.ts#L94)
6
6
 
7
7
  The options of `defineRegistry`.
8
8
 
@@ -19,6 +19,6 @@ The shape is the same as the shape above it, but the untyped
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
21
  | ---------------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
22
- | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | The catalog-typed map of the action handlers. Each handler receives `params` with the exact schema of the catalog action, or `undefined` when the caller gives no params. It also receives the `setState` argument and the `state` argument of the package above. Test for `undefined` before you read a param: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/define-registry.ts#L118) |
23
- | <a id="property-components"></a> `components?` | `Components`\<`C`\> | The Svelte component implementations, with the catalog component name as the key. | [packages/play-svelte/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/define-registry.ts#L98) |
24
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The callback that the renderer calls when a catalog component throws during a render. The inner `<svelte:boundary>` of `@xmachines/json-render-svelte` catches the error, and that boundary wraps each element. With this callback, the default `console.error(...)` fallback does not run: the renderer removes the component from the DOM, and your callback receives the error and the name of the element type. You can then report the error, or you can recover from it. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** **error** The value that the component threw. It is not always an `Error` instance. **Param** **elementType** The name of the catalog component that failed, for example `"Dashboard"`. | [packages/play-svelte/src/define-registry.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/define-registry.ts#L143) |
22
+ | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | The catalog-typed map of the action handlers. Each handler receives `params` with the exact schema of the catalog action, or `undefined` when the caller gives no params. It also receives the `setState` argument and the `state` argument of the package above. Test for `undefined` before you read a param: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: "auth.login", username: params.username }); }, logout: async () => actor.send({ type: "auth.logout" }), }` | [packages/play-svelte/src/define-registry.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/define-registry.ts#L118) |
23
+ | <a id="property-components"></a> `components?` | `Components`\<`C`\> | The Svelte component implementations, with the catalog component name as the key. | [packages/play-svelte/src/define-registry.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/define-registry.ts#L98) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The callback that the renderer calls when a catalog component throws during a render. The inner `<svelte:boundary>` of `@xmachines/json-render-svelte` catches the error, and that boundary wraps each element. With this callback, the default `console.error(...)` fallback does not run: the renderer removes the component from the DOM, and your callback receives the error and the name of the element type. You can then report the error, or you can recover from it. **Example** `const { registry, handlers } = defineRegistry(authCatalog, { components: { Login, Dashboard }, actions: { ... }, onRenderError(error, elementType) { console.warn(`Component <${elementType}> crashed:`, error); reportToSentry(error, { componentType: elementType }); }, });` **Param** **error** The value that the component threw. It is not always an `Error` instance. **Param** **elementType** The name of the catalog component that failed, for example `"Dashboard"`. | [packages/play-svelte/src/define-registry.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/define-registry.ts#L143) |
package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L82)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L82)
6
6
 
7
7
  The framework-agnostic base props. Every `ActorProvider` implementation shares
8
8
  them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -33,13 +33,13 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
33
33
 
34
34
  | Property | Type | Description | Inherited from | Defined in |
35
35
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36
- | <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) |
37
- | <a id="property-children"></a> `children` | `Snippet` | - | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-svelte/src/actor-context.svelte.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L75) |
38
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-svelte/src/actor-context.svelte.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L73) |
39
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `unknown`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L88) |
40
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L87) |
41
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-svelte/src/actor-context.svelte.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L74) |
42
- | <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) |
43
- | <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) |
44
- | <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) |
45
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L83) |
36
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L163) |
37
+ | <a id="property-children"></a> `children` | `Snippet` | - | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children) | [packages/play-svelte/src/actor-context.svelte.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L75) |
38
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback) | [packages/play-svelte/src/actor-context.svelte.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L73) |
39
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `unknown`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L88) |
40
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L87) |
41
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror) | [packages/play-svelte/src/actor-context.svelte.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L74) |
42
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L177) |
43
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L165) |
44
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L172) |
45
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L83) |
package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L51)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L51)
6
6
 
7
7
  The framework-agnostic base of the `ViewContextValue` type in each framework.
8
8
 
@@ -19,7 +19,7 @@ same generic parameter as in `BaseActorProviderProps`.
19
19
 
20
20
  | Property | Type | Description | Inherited from | Defined in |
21
21
  | ----------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <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) |
23
- | <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) |
24
- | <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) |
25
- | <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) |
22
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L127) |
23
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L129) |
24
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L125) |
25
+ | <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.2.0/packages/play-actor/src/abstract-actor.ts#L133) |
package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md CHANGED
@@ -6,6 +6,6 @@
6
6
  type AnyPlayActor = AbstractActor<AnyActorLogic> & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-svelte/src/actor-context.svelte.ts#L25)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-svelte/src/actor-context.svelte.ts#L25)
10
10
 
11
11
  The actor type that the Svelte `ActorProvider` and `getActorContext` accept. It requires `Viewable` for the view rendering. For the complete routing and view shape, use `PlayActor` from `@xmachines/play-router`.
package/api/@xmachines/play-svelte-spa-router/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > Svelte SPA Router adapter for the XMachines Play architecture. It connects hash-based routing to a `Routable` actor, so the state machine owns the navigation.
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-svelte-spa-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.2.0-blue)](https://www.npmjs.com/package/@xmachines/play-svelte-spa-router)
8
8
 
9
9
  ---
10
10
 
@@ -179,11 +179,13 @@ MIT © XMachines Contributors. See [LICENSE](./LICENSE).
179
179
 
180
180
  ## Interfaces
181
181
 
182
+ - [BasePathOptions](interfaces/BasePathOptions.md)
182
183
  - [ConnectRouterOptions](interfaces/ConnectRouterOptions.md)
183
184
  - [PlayRouteEvent](interfaces/PlayRouteEvent.md)
184
185
  - [RouteMapOptions](interfaces/RouteMapOptions.md)
185
186
  - [RouteMapping](interfaces/RouteMapping.md)
186
187
  - [RouterBridge](interfaces/RouterBridge.md)
188
+ - [RouterConnection](interfaces/RouterConnection.md)
187
189
  - [WindowLike](interfaces/WindowLike.md)
188
190
 
189
191
  ## Type Aliases
package/api/@xmachines/play-svelte-spa-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.1/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.2.0/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.1/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.2.0/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.1/packages/play-router/src/base-route-map.ts#L225)
90
+ Defined in: [play-router/src/base-route-map.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L229)
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.1/packages/play-router/src/base-route-map.ts#L185)
126
+ Defined in: [play-router/src/base-route-map.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.2.0/packages/play-router/src/base-route-map.ts#L189)
127
127
 
128
128
  Resolves a URL path to its state ID.
129
129