@xmachines/docs 6.0.0 → 7.0.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 (604) hide show
  1. package/README.md +9 -8
  2. package/api/@xmachines/core/README.md +7 -2
  3. package/api/@xmachines/core/cache/functions/createLruCache.md +1 -1
  4. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
  5. package/api/@xmachines/core/errors/classes/BaseError.md +4 -4
  6. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +4 -4
  7. package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
  8. package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
  9. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  10. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  12. package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
  13. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  14. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  15. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  16. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  18. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  19. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  20. package/api/@xmachines/play/README.md +10 -5
  21. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  22. package/api/@xmachines/play/errors/classes/PlayError.md +6 -4
  23. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  24. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  25. package/api/@xmachines/play-actor/README.md +9 -1
  26. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  27. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  28. package/api/@xmachines/play-atom/README.md +17 -5
  29. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  30. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
  31. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  32. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
  33. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
  34. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  35. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  36. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  37. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  38. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  39. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  40. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  41. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  42. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  43. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  44. package/api/@xmachines/play-dom/README.md +138 -60
  45. package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -12
  46. package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
  47. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  48. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -2
  49. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  50. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +15 -14
  51. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +26 -20
  52. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  53. package/api/@xmachines/play-dom/interfaces/PassOptions.md +14 -0
  54. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +18 -17
  55. package/api/@xmachines/play-dom/interfaces/RenderErrorInfo.md +16 -0
  56. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +17 -15
  57. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +9 -8
  58. package/api/@xmachines/play-dom/interfaces/ValidationRegistry.md +14 -11
  59. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +9 -10
  60. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +4 -3
  61. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  62. package/api/@xmachines/play-dom/type-aliases/OnRenderError.md +27 -0
  63. package/api/@xmachines/play-dom/type-aliases/RenderErrorKind.md +21 -0
  64. package/api/@xmachines/play-dom-router/README.md +41 -5
  65. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  66. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  67. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  68. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  69. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  70. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  71. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  72. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  73. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +8 -8
  74. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  75. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  76. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  77. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  78. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  79. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +6 -6
  81. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  82. package/api/@xmachines/play-pattern/README.md +1 -1
  83. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  84. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  85. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  86. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  87. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  88. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +4 -4
  89. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  90. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
  91. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
  92. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
  93. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
  94. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +4 -4
  95. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  96. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  97. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  98. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  99. package/api/@xmachines/play-react/README.md +57 -18
  100. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  101. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  102. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  103. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  104. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  105. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +5 -5
  106. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +11 -11
  107. package/api/@xmachines/play-react/interfaces/DefineRegistryResult.md +15 -0
  108. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  109. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  110. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  111. package/api/@xmachines/play-react/interfaces/RenderErrorInfo.md +16 -0
  112. package/api/@xmachines/play-react/interfaces/RendererProps.md +7 -7
  113. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  114. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  115. package/api/@xmachines/play-react/type-aliases/OnRenderError.md +27 -0
  116. package/api/@xmachines/play-react/type-aliases/RenderErrorKind.md +21 -0
  117. package/api/@xmachines/play-react/variables/ActorProvider.md +14 -4
  118. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  119. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  120. package/api/@xmachines/play-react-router/README.md +26 -5
  121. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  122. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  123. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  124. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  125. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  126. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  127. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  128. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  129. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  130. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  131. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  132. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  133. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  134. package/api/@xmachines/play-router/README.md +79 -23
  135. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  136. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  137. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  138. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  139. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  140. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  141. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  142. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  143. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  144. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  146. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  148. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  152. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  153. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  154. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  155. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  156. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  157. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  158. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  159. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  160. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  161. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  162. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  163. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  164. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  165. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  166. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  167. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  168. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  169. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  170. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  171. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  172. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  173. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  174. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
  175. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
  176. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  177. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  178. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  179. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
  180. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
  181. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  182. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  183. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
  184. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  185. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  186. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  187. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  188. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  189. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
  190. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  191. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  192. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  193. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +12 -15
  194. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  195. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  196. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  197. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +6 -6
  198. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +6 -6
  199. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  200. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  201. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  202. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  203. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  204. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  205. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  206. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  207. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  208. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  209. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  210. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  211. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  212. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  213. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  214. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  215. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  216. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  217. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  218. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  219. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  220. package/api/@xmachines/play-solid/README.md +35 -14
  221. package/api/@xmachines/play-solid/functions/defineRegistry.md +5 -5
  222. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  223. package/api/@xmachines/play-solid/functions/useBoundProp.md +8 -5
  224. package/api/@xmachines/play-solid/functions/useFieldValidation.md +6 -4
  225. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  226. package/api/@xmachines/play-solid/functions/useStateBinding.md +5 -3
  227. package/api/@xmachines/play-solid/functions/useStateValue.md +5 -3
  228. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  229. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +9 -8
  230. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  231. package/api/@xmachines/play-solid/interfaces/RenderErrorInfo.md +16 -0
  232. package/api/@xmachines/play-solid/interfaces/RendererProps.md +7 -7
  233. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  234. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  235. package/api/@xmachines/play-solid/type-aliases/OnRenderError.md +27 -0
  236. package/api/@xmachines/play-solid/type-aliases/RenderErrorKind.md +21 -0
  237. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  238. package/api/@xmachines/play-solid/variables/ActorProvider.md +17 -3
  239. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  240. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  241. package/api/@xmachines/play-solid/variables/schema.md +35 -54
  242. package/api/@xmachines/play-solid-router/README.md +22 -6
  243. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  244. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +8 -8
  245. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  246. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  247. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  248. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  249. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  250. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  251. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  252. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  253. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  254. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  255. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  256. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  257. package/api/@xmachines/play-svelte/README.md +18 -10
  258. package/api/@xmachines/play-svelte/functions/defineRegistry.md +3 -4
  259. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  260. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  261. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  262. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +12 -12
  263. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +10 -8
  264. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +10 -8
  265. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +8 -8
  266. package/api/@xmachines/play-svelte/interfaces/DefineRegistryResult.md +15 -0
  267. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +14 -14
  268. package/api/@xmachines/play-svelte/interfaces/RenderErrorInfo.md +16 -0
  269. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  270. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  271. package/api/@xmachines/play-svelte/type-aliases/OnRenderError.md +27 -0
  272. package/api/@xmachines/play-svelte/type-aliases/RenderErrorKind.md +21 -0
  273. package/api/@xmachines/play-svelte-spa-router/README.md +9 -5
  274. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  275. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  276. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  277. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  278. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
  279. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  280. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  281. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  282. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  283. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  284. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +6 -6
  285. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  286. package/api/@xmachines/play-sveltekit-router/README.md +65 -13
  287. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  288. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +29 -19
  289. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  290. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  291. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +13 -16
  292. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  293. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  294. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  295. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  296. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  297. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  298. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +6 -6
  299. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +25 -0
  300. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +21 -0
  301. package/api/@xmachines/play-tanstack-react-router/README.md +34 -16
  302. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  303. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  304. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  305. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  306. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  307. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  308. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  309. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  310. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  311. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  312. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  313. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  314. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  315. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  316. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  317. package/api/@xmachines/play-tanstack-router/README.md +5 -3
  318. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  319. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  320. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  321. package/api/@xmachines/play-tanstack-solid-router/README.md +45 -11
  322. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  323. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  324. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  325. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  326. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  327. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  328. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  329. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  330. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  331. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  332. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  333. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  334. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  335. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  336. package/api/@xmachines/play-url/README.md +1 -1
  337. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  338. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  339. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  340. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  341. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  342. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  343. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  344. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  345. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  346. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  347. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  348. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  349. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  350. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  351. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  352. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  353. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  354. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  355. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  356. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  357. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  358. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +3 -3
  359. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
  360. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  361. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  362. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  363. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  364. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +2 -2
  365. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  366. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  367. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  368. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  369. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  370. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  371. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  372. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  373. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  374. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  375. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  376. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  377. package/api/@xmachines/play-view/README.md +92 -35
  378. package/api/@xmachines/play-view/errors/README.md +2 -0
  379. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +204 -0
  380. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  381. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +181 -0
  382. package/api/@xmachines/play-view/index/README.md +16 -4
  383. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +10 -9
  384. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +34 -0
  385. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  386. package/api/@xmachines/play-view/index/functions/composeViews.md +41 -0
  387. package/api/@xmachines/play-view/index/functions/createActorProxy.md +39 -0
  388. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +35 -0
  389. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  390. package/api/@xmachines/play-view/index/functions/createViewSession.md +29 -0
  391. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  392. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +45 -0
  393. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  394. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  395. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  396. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  397. package/api/@xmachines/play-view/index/functions/typedSpec.md +11 -11
  398. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +8 -8
  399. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  400. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +16 -0
  401. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +19 -0
  402. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +12 -8
  403. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  404. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  405. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  406. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +25 -0
  407. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +23 -0
  408. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +155 -0
  409. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +12 -0
  410. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +23 -0
  411. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +22 -3
  412. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +7 -6
  413. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +15 -0
  414. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +14 -0
  415. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  416. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +21 -0
  417. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  418. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  419. package/api/@xmachines/play-vue/README.md +21 -18
  420. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  421. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  422. package/api/@xmachines/play-vue/functions/useBoundProp.md +10 -4
  423. package/api/@xmachines/play-vue/functions/useFieldValidation.md +12 -5
  424. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  425. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  426. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  427. package/api/@xmachines/play-vue/interfaces/RenderErrorInfo.md +16 -0
  428. package/api/@xmachines/play-vue/interfaces/RendererProps.md +7 -7
  429. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  430. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  431. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  432. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  433. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  434. package/api/@xmachines/play-vue/type-aliases/OnRenderError.md +27 -0
  435. package/api/@xmachines/play-vue/type-aliases/RenderErrorKind.md +21 -0
  436. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  437. package/api/@xmachines/play-vue/variables/Renderer.md +3 -3
  438. package/api/@xmachines/play-vue-router/README.md +18 -11
  439. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  440. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  441. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  442. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  443. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  444. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  445. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +4 -4
  446. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  447. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  448. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  449. package/api/@xmachines/play-xstate/README.md +87 -28
  450. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  451. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  452. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  453. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  454. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  455. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
  456. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  457. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  458. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -10
  459. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  460. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  461. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  462. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  463. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  464. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  465. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  466. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  467. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  468. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  469. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  470. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  471. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  472. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  473. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +12 -15
  474. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  475. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  476. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  477. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  478. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  479. package/api/@xmachines/play-xstate/with-view/functions/withView.md +2 -4
  480. package/api/@xmachines/shared/README.md +1 -0
  481. package/api/@xmachines/shared/vite-aliases/README.md +7 -0
  482. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +11 -5
  483. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +37 -0
  484. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +28 -0
  485. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  486. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  487. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  488. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  489. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +26 -0
  490. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +15 -0
  491. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  492. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +5 -1
  493. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  494. package/api/llms.txt +8 -4
  495. package/contributing/architecture.md +96 -51
  496. package/contributing/configuration.md +55 -14
  497. package/contributing/deployment.md +3 -3
  498. package/contributing/development.md +31 -4
  499. package/contributing/migrating-to-play-atom.md +11 -5
  500. package/contributing/testing.md +93 -33
  501. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  502. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +9 -9
  503. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  504. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  505. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  506. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  507. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  508. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  509. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  510. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  511. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  512. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  513. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  514. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  515. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  516. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  517. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  518. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  519. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  520. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  521. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  522. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +15 -15
  523. package/examples/@xmachines/play-dom-router-demo/README.md +4 -3
  524. package/examples/@xmachines/play-react-demo/README.md +2 -2
  525. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +9 -9
  526. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  527. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  528. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  529. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  530. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  531. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  532. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  533. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  534. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  535. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  536. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  537. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  538. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  539. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  540. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  541. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  542. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  543. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  544. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  545. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +15 -15
  546. package/examples/@xmachines/play-react-router-demo/README.md +4 -3
  547. package/examples/@xmachines/play-solid-demo/README.md +3 -3
  548. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +9 -9
  549. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  550. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  551. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  552. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  553. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  554. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  555. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  556. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  557. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  558. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  559. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  560. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  561. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  562. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  563. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  564. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  565. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  566. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  567. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +190 -277
  568. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  569. package/examples/@xmachines/play-solid-router-demo/README.md +9 -3
  570. package/examples/@xmachines/play-svelte-demo/README.md +1 -1
  571. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +9 -9
  572. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  573. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +190 -277
  574. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +15 -15
  575. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +1 -1
  576. package/examples/@xmachines/play-sveltekit-router-demo/README.md +1 -1
  577. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +3 -2
  578. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +9 -8
  579. package/examples/@xmachines/play-vue-demo/README.md +2 -2
  580. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +9 -9
  581. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  582. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  583. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  584. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  585. package/examples/@xmachines/play-vue-router-demo/README.md +3 -3
  586. package/examples/README.md +1 -1
  587. package/examples/form-validation.md +17 -13
  588. package/examples/multi-router-integration.md +269 -148
  589. package/examples/routing-patterns.md +44 -9
  590. package/examples/traffic-light.md +7 -3
  591. package/guides/README.md +5 -4
  592. package/guides/actor-model.md +41 -23
  593. package/guides/atoms.md +52 -12
  594. package/guides/getting-started.md +65 -19
  595. package/guides/inspector.md +72 -12
  596. package/guides/routing.md +44 -45
  597. package/guides/state-machines.md +102 -15
  598. package/guides/views.md +367 -0
  599. package/package.json +6 -6
  600. package/rfc/play.md +55 -21
  601. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +0 -20
  602. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +0 -25
  603. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +0 -60
  604. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +0 -19
@@ -21,151 +21,193 @@ Used by framework adapters that have a React/Solid/Vue provider context. The `Pl
21
21
 
22
22
  ### React + TanStack Router (`@xmachines/play-tanstack-react-router`)
23
23
 
24
- ```typescript
24
+ ```tsx
25
25
  import { useEffect, useMemo } from "react";
26
26
  import { createRouter, createRootRoute } from "@tanstack/react-router";
27
27
  import { PlayRouterProvider, createRouteMapFromTree } from "@xmachines/play-tanstack-react-router";
28
28
  import { extractMachineRoutes } from "@xmachines/play-router/xstate";
29
29
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
30
30
  import { withRouting } from "@xmachines/play-xstate/routing";
31
- import { defineRegistry } from "@xmachines/play-react";
32
- import { authMachine, authCatalog } from "@xmachines/play-actor-shared";
31
+ import { withView } from "@xmachines/play-xstate/view";
32
+ import { PlayUIProvider, PlayRenderer, type DefineRegistryResult } from "@xmachines/play-react";
33
+ import type { AnyStateMachine } from "xstate";
33
34
 
34
- const createPlayer = definePlayer({ machine: authMachine, actor: compose(PlayerActor, withRouting) });
35
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
36
+ // Your catalog, components and actions: defineRegistry(catalog, { components, actions })
37
+ declare const registryResult: DefineRegistryResult;
35
38
 
36
- const { registry } = defineRegistry(authCatalog, {
37
- components: { /* ...your components */ },
38
- actions: { login: async () => {}, logout: async () => {}, /* ... */ },
39
+ // The router needs `withRouting`, and the renderer needs `withView`.
40
+ const createPlayer = definePlayer({
41
+ machine: appMachine,
42
+ actor: compose(PlayerActor, withRouting, withView),
39
43
  });
40
44
 
41
45
  function createAppRuntime() {
42
- const actor = createPlayer();
43
- actor.start();
46
+ const actor = createPlayer();
47
+ actor.start();
44
48
 
45
- const routeTree = extractMachineRoutes(authMachine);
46
- const routeMap = createRouteMapFromTree(routeTree);
47
- const router = createRouter({ routeTree: createRootRoute(), defaultPreload: "intent" });
49
+ const routeTree = extractMachineRoutes(appMachine);
50
+ const routeMap = createRouteMapFromTree(routeTree);
51
+ const router = createRouter({ routeTree: createRootRoute(), defaultPreload: "intent" });
48
52
 
49
- return { actor, routeMap, router };
53
+ return { actor, routeMap, router };
50
54
  }
51
55
 
52
56
  export function App() {
53
- const { actor, routeMap, router } = useMemo(createAppRuntime, []);
54
-
55
- useEffect(() => () => { actor.stop(); }, [actor]);
56
-
57
- return (
58
- <PlayRouterProvider
59
- actor={actor}
60
- router={router}
61
- routeMap={routeMap}
62
- renderer={(currentActor, currentRouter) => (
63
- <Shell actor={currentActor} router={currentRouter} registry={registry} />
64
- )}
65
- />
66
- );
57
+ const { actor, routeMap, router } = useMemo(createAppRuntime, []);
58
+
59
+ useEffect(
60
+ () => () => {
61
+ actor.stop();
62
+ },
63
+ [actor],
64
+ );
65
+
66
+ return (
67
+ <PlayRouterProvider
68
+ actor={actor}
69
+ router={router}
70
+ routeMap={routeMap}
71
+ renderer={(currentActor) => (
72
+ <PlayUIProvider actor={currentActor} registryResult={registryResult}>
73
+ <PlayRenderer />
74
+ </PlayUIProvider>
75
+ )}
76
+ />
77
+ );
67
78
  }
68
79
  ```
69
80
 
70
81
  ### React + React Router 7/8 (`@xmachines/play-react-router`)
71
82
 
72
- ```typescript
83
+ ```tsx
84
+ import { useEffect, useMemo } from "react";
73
85
  import { createBrowserRouter, RouterProvider } from "react-router";
74
86
  import { PlayRouterProvider, createRouteMapFromTree } from "@xmachines/play-react-router";
75
87
  import { extractMachineRoutes } from "@xmachines/play-router/xstate";
76
88
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
77
89
  import { withRouting } from "@xmachines/play-xstate/routing";
90
+ import { withView } from "@xmachines/play-xstate/view";
91
+ import { PlayUIProvider, PlayRenderer, type DefineRegistryResult } from "@xmachines/play-react";
92
+ import type { AnyStateMachine } from "xstate";
78
93
 
79
- const createPlayer = definePlayer({ machine: authMachine, actor: compose(PlayerActor, withRouting) });
80
-
81
- function createAppRuntime() {
82
- const actor = createPlayer();
83
- actor.start();
84
-
85
- const routeTree = extractMachineRoutes(authMachine);
86
- const routeMap = createRouteMapFromTree(routeTree);
94
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
95
+ // Your catalog, components and actions: defineRegistry(catalog, { components, actions })
96
+ declare const registryResult: DefineRegistryResult;
87
97
 
88
- // React Router requires route elements upfront — use a catch-all
89
- let router!: ReturnType<typeof createBrowserRouter>;
90
- function RoutedShell() {
91
- return <Shell actor={actor} router={router} registry={registry} />;
92
- }
93
- router = createBrowserRouter([{ path: "*", element: <RoutedShell /> }]);
98
+ const createPlayer = definePlayer({
99
+ machine: appMachine,
100
+ actor: compose(PlayerActor, withRouting, withView),
101
+ });
94
102
 
95
- return { actor, routeMap, router };
103
+ function createAppRuntime() {
104
+ const actor = createPlayer();
105
+ actor.start();
106
+
107
+ const routeTree = extractMachineRoutes(appMachine);
108
+ const routeMap = createRouteMapFromTree(routeTree);
109
+
110
+ // React Router requires route elements upfront — use a catch-all
111
+ function RoutedShell() {
112
+ return (
113
+ <PlayUIProvider actor={actor} registryResult={registryResult}>
114
+ <PlayRenderer />
115
+ </PlayUIProvider>
116
+ );
117
+ }
118
+ const router = createBrowserRouter([{ path: "*", element: <RoutedShell /> }]);
119
+
120
+ return { actor, routeMap, router };
96
121
  }
97
122
 
98
123
  export default function App() {
99
- const { actor, routeMap, router } = useMemo(createAppRuntime, []);
100
-
101
- useEffect(() => () => { actor.stop(); }, [actor]);
102
-
103
- return (
104
- <PlayRouterProvider
105
- actor={actor}
106
- router={router}
107
- routeMap={routeMap}
108
- renderer={(currentActor, currentRouter) => (
109
- <RouterProvider router={currentRouter} />
110
- )}
111
- />
112
- );
124
+ const { actor, routeMap, router } = useMemo(createAppRuntime, []);
125
+
126
+ useEffect(
127
+ () => () => {
128
+ actor.stop();
129
+ },
130
+ [actor],
131
+ );
132
+
133
+ return (
134
+ <PlayRouterProvider
135
+ actor={actor}
136
+ router={router}
137
+ routeMap={routeMap}
138
+ renderer={(_, currentRouter) => <RouterProvider router={currentRouter} />}
139
+ />
140
+ );
113
141
  }
114
142
  ```
115
143
 
116
144
  ### SolidJS + SolidJS Router (`@xmachines/play-solid-router`)
117
145
 
118
- ```typescript
119
- import { Router, Route } from "@solidjs/router";
146
+ ```tsx
147
+ import { Router, Route, useNavigate, useLocation, useParams } from "@solidjs/router";
120
148
  import { onCleanup } from "solid-js";
121
149
  import { PlayRouterProvider } from "@xmachines/play-solid-router";
122
150
  import { createRouteMap } from "@xmachines/play-router/xstate";
123
151
  import { extractMachineRoutes, getRoutableRoutes } from "@xmachines/play-router/xstate";
124
152
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
125
153
  import { withRouting } from "@xmachines/play-xstate/routing";
154
+ import { withView } from "@xmachines/play-xstate/view";
155
+ import { PlayUIProvider, PlayRenderer, type DefineRegistryResult } from "@xmachines/play-solid";
156
+ import type { AnyStateMachine } from "xstate";
157
+
158
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
159
+ // Your catalog, components and actions: defineRegistry(catalog, { components, actions })
160
+ declare const registryResult: DefineRegistryResult;
126
161
 
127
- const createPlayer = definePlayer({ machine: authMachine, actor: compose(PlayerActor, withRouting) });
162
+ const createPlayer = definePlayer({
163
+ machine: appMachine,
164
+ actor: compose(PlayerActor, withRouting, withView),
165
+ });
128
166
  const actor = createPlayer();
129
167
  actor.start();
130
168
 
131
- const routeTree = extractMachineRoutes(authMachine);
169
+ const routeTree = extractMachineRoutes(appMachine);
132
170
  const routes = getRoutableRoutes(routeTree);
133
- const routeMap = createRouteMap(authMachine);
171
+ const routeMap = createRouteMap(appMachine);
134
172
 
135
173
  // Layout rendered inside Router — has access to navigate/location/params hooks
136
174
  const Layout = () => {
137
- const navigate = useNavigate();
138
- const location = useLocation();
139
- const params = useParams();
140
-
141
- onCleanup(() => { actor.stop(); });
142
-
143
- return (
144
- <PlayRouterProvider
145
- actor={actor}
146
- routeMap={routeMap}
147
- router={{ navigate, location, params }}
148
- renderer={(currentActor, currentRouter) => (
149
- <Shell actor={currentActor} router={currentRouter} registry={registry} />
150
- )}
151
- />
152
- );
175
+ const navigate = useNavigate();
176
+ const location = useLocation();
177
+ const params = useParams();
178
+
179
+ onCleanup(() => {
180
+ actor.stop();
181
+ });
182
+
183
+ return (
184
+ <PlayRouterProvider
185
+ actor={actor}
186
+ routeMap={routeMap}
187
+ router={{ navigate, location, params }}
188
+ renderer={(currentActor) => (
189
+ <PlayUIProvider actor={currentActor} registryResult={registryResult}>
190
+ <PlayRenderer />
191
+ </PlayUIProvider>
192
+ )}
193
+ />
194
+ );
153
195
  };
154
196
 
155
197
  export default function App() {
156
- return (
157
- <Router root={Layout}>
158
- {routes.map((route) => (
159
- <Route path={route.fullPath} component={() => <div />} />
160
- ))}
161
- </Router>
162
- );
198
+ return (
199
+ <Router root={Layout}>
200
+ {routes.map((route) => (
201
+ <Route path={route.fullPath} component={() => null} />
202
+ ))}
203
+ </Router>
204
+ );
163
205
  }
164
206
  ```
165
207
 
166
208
  ### SolidJS + TanStack Solid Router (`@xmachines/play-tanstack-solid-router`)
167
209
 
168
- ```typescript
210
+ ```tsx
169
211
  import { createRouter, createRootRoute, createRoute, RouterProvider } from "@tanstack/solid-router";
170
212
  import { onCleanup } from "solid-js";
171
213
  import { PlayRouterProvider } from "@xmachines/play-tanstack-solid-router";
@@ -173,42 +215,60 @@ import { createRouteMap } from "@xmachines/play-router/xstate";
173
215
  import { extractMachineRoutes, getRoutableRoutes } from "@xmachines/play-router/xstate";
174
216
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
175
217
  import { withRouting } from "@xmachines/play-xstate/routing";
218
+ import { withView } from "@xmachines/play-xstate/view";
219
+ import { PlayUIProvider, PlayRenderer, type DefineRegistryResult } from "@xmachines/play-solid";
220
+ import type { AnyStateMachine } from "xstate";
221
+
222
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
223
+ // Your catalog, components and actions: defineRegistry(catalog, { components, actions })
224
+ declare const registryResult: DefineRegistryResult;
176
225
 
177
- const createPlayer = definePlayer({ machine: authMachine, actor: compose(PlayerActor, withRouting) });
226
+ const createPlayer = definePlayer({
227
+ machine: appMachine,
228
+ actor: compose(PlayerActor, withRouting, withView),
229
+ });
178
230
  const actor = createPlayer();
179
231
  actor.start();
180
232
 
181
- const routeTree = extractMachineRoutes(authMachine);
233
+ const routeTree = extractMachineRoutes(appMachine);
182
234
  const routes = getRoutableRoutes(routeTree);
183
- const routeMap = createRouteMap(authMachine);
235
+ const routeMap = createRouteMap(appMachine);
184
236
 
185
237
  const rootRoute = createRootRoute({ component: Layout });
186
238
 
187
239
  // Convert XMachines :param to TanStack $param format
188
240
  const tanstackRoutes = routes.map((route) => {
189
- const tanstackPath = route.fullPath.replace(/:(\w+)/g, "$$$1");
190
- return createRoute({ getParentRoute: () => rootRoute, path: tanstackPath, component: () => <div /> });
241
+ const tanstackPath = route.fullPath.replace(/:(\w+)/g, "$$$1");
242
+ return createRoute({
243
+ getParentRoute: () => rootRoute,
244
+ path: tanstackPath,
245
+ component: () => null,
246
+ });
191
247
  });
192
248
 
193
249
  const router = createRouter({ routeTree: rootRoute.addChildren(tanstackRoutes) });
194
250
 
195
251
  function Layout() {
196
- onCleanup(() => { actor.stop(); });
197
-
198
- return (
199
- <PlayRouterProvider
200
- actor={actor}
201
- router={router}
202
- routeMap={routeMap}
203
- renderer={(currentActor, currentRouter) => (
204
- <Shell actor={currentActor} router={currentRouter} registry={registry} />
205
- )}
206
- />
207
- );
252
+ onCleanup(() => {
253
+ actor.stop();
254
+ });
255
+
256
+ return (
257
+ <PlayRouterProvider
258
+ actor={actor}
259
+ router={router}
260
+ routeMap={routeMap}
261
+ renderer={(currentActor) => (
262
+ <PlayUIProvider actor={currentActor} registryResult={registryResult}>
263
+ <PlayRenderer />
264
+ </PlayUIProvider>
265
+ )}
266
+ />
267
+ );
208
268
  }
209
269
 
210
270
  export default function App() {
211
- return <RouterProvider router={router} />;
271
+ return <RouterProvider router={router} />;
212
272
  }
213
273
  ```
214
274
 
@@ -226,16 +286,28 @@ export default function App() {
226
286
  </template>
227
287
 
228
288
  <script setup lang="ts">
229
- import { h, inject } from "vue";
289
+ import { h } from "vue";
230
290
  import { createRouter, createWebHistory } from "vue-router";
231
291
  import { PlayRouterProvider } from "@xmachines/play-vue-router";
232
292
  import { createRouteMap } from "@xmachines/play-router/xstate";
233
- import { defineRegistry } from "@xmachines/play-vue";
234
- import { authMachine, authCatalog } from "@xmachines/play-actor-shared";
235
-
236
- const actor = inject("actor");
293
+ import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
294
+ import { withRouting } from "@xmachines/play-xstate/routing";
295
+ import { withView } from "@xmachines/play-xstate/view";
296
+ import { PlayUIProvider, PlayRenderer, type DefineRegistryResult } from "@xmachines/play-vue";
297
+ import type { AnyStateMachine } from "xstate";
298
+
299
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
300
+ // Your catalog, Vue SFC components and actions: defineRegistry(catalog, { components, actions })
301
+ declare const registryResult: DefineRegistryResult;
302
+
303
+ const createPlayer = definePlayer({
304
+ machine: appMachine,
305
+ actor: compose(PlayerActor, withRouting, withView),
306
+ });
307
+ const actor = createPlayer();
308
+ actor.start();
237
309
 
238
- const routeMap = createRouteMap(authMachine);
310
+ const routeMap = createRouteMap(appMachine);
239
311
 
240
312
  const router = createRouter({
241
313
  history: createWebHistory(),
@@ -248,13 +320,7 @@ export default function App() {
248
320
  ],
249
321
  });
250
322
 
251
- const { registry } = defineRegistry(authCatalog, {
252
- components: {/* ...your Vue SFC components */},
253
- actions: { login: async () => {}, logout: async () => {} /* ... */ },
254
- });
255
-
256
- const renderShell = (currentActor, currentRouter) =>
257
- h(Shell, { actor: currentActor, router: currentRouter, registry });
323
+ const renderShell = () => h(PlayUIProvider, { actor, registryResult }, () => h(PlayRenderer));
258
324
  </script>
259
325
  ```
260
326
 
@@ -271,20 +337,24 @@ import { extractMachineRoutes } from "@xmachines/play-router/xstate";
271
337
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
272
338
  import { withRouting } from "@xmachines/play-xstate/routing";
273
339
  import { withView } from "@xmachines/play-xstate/view";
274
- import { createPlayUI, defineRegistry } from "@xmachines/play-dom";
275
- import { authMachine, authCatalog } from "@xmachines/play-actor-shared";
340
+ import { createPlayUI, type DefineRegistryResult } from "@xmachines/play-dom";
341
+ import type { AnyStateMachine } from "xstate";
342
+
343
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
344
+ // Your catalog, components and actions: defineRegistry(catalog, { components, actions })
345
+ declare const registryResult: DefineRegistryResult;
276
346
 
277
347
  // The router needs `withRouting`, and the renderer below needs `withView`.
278
348
  const createPlayer = definePlayer({
279
- machine: authMachine,
349
+ machine: appMachine,
280
350
  actor: compose(PlayerActor, withRouting, withView),
281
351
  });
282
352
  const actor = createPlayer();
283
353
  actor.start();
284
354
 
285
355
  // Router setup
286
- const routeTree = extractMachineRoutes(authMachine);
287
- const routeMap = createRouteMap(authMachine);
356
+ const routeTree = extractMachineRoutes(appMachine);
357
+ const routeMap = createRouteMap(appMachine);
288
358
  const history = createBrowserHistory({ window });
289
359
  const router = createRouter({ routeTree, history });
290
360
 
@@ -294,9 +364,6 @@ const router = createRouter({ routeTree, history });
294
364
  const disconnect = connectRouter({ actor, router, routeMap });
295
365
 
296
366
  // Renderer setup
297
- const registryResult = defineRegistry(authCatalog, {
298
- components: {/* ...your DOM components */},
299
- });
300
367
  const mount = createPlayUI(registryResult);
301
368
  const disconnectRenderer = mount(actor, document.getElementById("app")!);
302
369
 
@@ -316,38 +383,40 @@ function teardown(): void {
316
383
 
317
384
  ```typescript
318
385
  // lib/router.ts
319
- import { defineRegistry } from "@xmachines/play-svelte";
320
- import { authCatalog, authMachine } from "@xmachines/play-actor-shared";
386
+ import type { DefineRegistryResult } from "@xmachines/play-svelte";
321
387
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
322
388
  import { withRouting } from "@xmachines/play-xstate/routing";
323
389
  import { withView } from "@xmachines/play-xstate/view";
324
390
  import { connectRouter } from "@xmachines/play-sveltekit-router";
325
391
  import { createRouteMap } from "@xmachines/play-router/xstate";
326
- const createDemoPlayer = definePlayer({
327
- machine: authMachine,
328
- actor: compose(PlayerActor, withRouting, withView),
329
- });
392
+ import type { AnyStateMachine } from "xstate";
330
393
 
331
- const { registry } = defineRegistry(authCatalog, {
332
- components: {/* ...your Svelte components */},
333
- actions: { login: async () => {}, logout: async () => {} /* ... */ },
394
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
395
+ // Your catalog, Svelte components and actions: defineRegistry(catalog, { components, actions })
396
+ export declare const registryResult: DefineRegistryResult;
397
+
398
+ const createPlayer = definePlayer({
399
+ machine: appMachine,
400
+ actor: compose(PlayerActor, withRouting, withView),
334
401
  });
335
402
 
336
- export const actor = createDemoPlayer();
403
+ export const actor = createPlayer();
337
404
  actor.start();
338
405
 
339
- export const routeMap = createRouteMap(authMachine);
406
+ export const routeMap = createRouteMap(appMachine);
340
407
  export const disconnectRouter = connectRouter({ actor, routeMap });
341
408
  ```
342
409
 
343
410
  ```html
344
411
  <!-- App.svelte -->
345
412
  <script lang="ts">
346
- import Shell from "./Shell.svelte";
347
- import { actor, registry } from "./lib/router.js";
413
+ import { PlayUIProvider, PlayRenderer } from "@xmachines/play-svelte";
414
+ import { actor, registryResult } from "./lib/router.js";
348
415
  </script>
349
416
 
350
- <Shell {actor} {registry} />
417
+ <PlayUIProvider {actor} {registryResult}>
418
+ <PlayRenderer />
419
+ </PlayUIProvider>
351
420
  ```
352
421
 
353
422
  ### Svelte SPA Router (`@xmachines/play-svelte-spa-router`)
@@ -359,17 +428,19 @@ import { createRouteMap } from "@xmachines/play-router/xstate";
359
428
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
360
429
  import { withRouting } from "@xmachines/play-xstate/routing";
361
430
  import { withView } from "@xmachines/play-xstate/view";
362
- import { authMachine } from "@xmachines/play-actor-shared";
431
+ import type { AnyStateMachine } from "xstate";
432
+
433
+ declare const appMachine: AnyStateMachine; // your machine, with routes and views
363
434
 
364
- const createDemoPlayer = definePlayer({
365
- machine: authMachine,
435
+ const createPlayer = definePlayer({
436
+ machine: appMachine,
366
437
  actor: compose(PlayerActor, withRouting, withView),
367
438
  });
368
439
 
369
- export const actor = createDemoPlayer();
440
+ export const actor = createPlayer();
370
441
  actor.start();
371
442
 
372
- export const routeMap = createRouteMap(authMachine);
443
+ export const routeMap = createRouteMap(appMachine);
373
444
  export const disconnectRouter = connectRouter({ actor, routeMap });
374
445
  ```
375
446
 
@@ -384,6 +455,26 @@ The shape that motivates this is a URL such as `/:machineId/play/dashboard`. The
384
455
  `basePath` and `basePathParams` are **reactive props**. They need no stable reference, unlike `actor`, `router`, and `routeMap`, and a change moves the live bridge instead of rebuilding it:
385
456
 
386
457
  ```tsx
458
+ import { useLoaderData } from "@tanstack/react-router";
459
+ import {
460
+ PlayRouterProvider,
461
+ type RoutableActor,
462
+ type RouteMap,
463
+ type TanStackRouterInstance,
464
+ } from "@xmachines/play-tanstack-react-router";
465
+ import {
466
+ PlayUIProvider,
467
+ PlayRenderer,
468
+ type PlayUIProviderProps,
469
+ type DefineRegistryResult,
470
+ } from "@xmachines/play-react";
471
+
472
+ // The actor, the router, the route map, and the registry of the TanStack example above
473
+ declare const actor: RoutableActor & PlayUIProviderProps["actor"];
474
+ declare const router: TanStackRouterInstance;
475
+ declare const routeMap: RouteMap;
476
+ declare const registryResult: DefineRegistryResult;
477
+
387
478
  function PlayRoute() {
388
479
  const { machineId } = useLoaderData({ from: "/$machineId/play/$" });
389
480
 
@@ -394,7 +485,11 @@ function PlayRoute() {
394
485
  routeMap={routeMap} // unchanged — the route map stays machine-relative
395
486
  basePath="/:machineId/play"
396
487
  basePathParams={{ machineId }} // the loader resolved this already
397
- renderer={(currentActor) => <Shell actor={currentActor} registry={registry} />}
488
+ renderer={(currentActor) => (
489
+ <PlayUIProvider actor={currentActor} registryResult={registryResult}>
490
+ <PlayRenderer />
491
+ </PlayUIProvider>
492
+ )}
398
493
  />
399
494
  );
400
495
  }
@@ -409,6 +504,19 @@ function PlayRoute() {
409
504
  vanilla DOM adapter needs `router`, as it does in the example above:
410
505
 
411
506
  ```typescript
507
+ import {
508
+ connectRouter,
509
+ type RoutableActor,
510
+ type RouteMap,
511
+ type VanillaRouter,
512
+ } from "@xmachines/play-dom-router";
513
+
514
+ // The actor, the router, and the route map of the vanilla DOM example above
515
+ declare const actor: RoutableActor;
516
+ declare const router: VanillaRouter;
517
+ declare const routeMap: RouteMap;
518
+ declare const machineId: string; // the host resolved this, for example in a loader
519
+
412
520
  const disconnect = connectRouter({
413
521
  actor,
414
522
  router, // required: @xmachines/play-dom-router reads its history
@@ -439,6 +547,10 @@ The prefix resolves in advance, because the bridge writes a real browser URL. It
439
547
  **The machine stays authoritative over its own params (INV-01).** `event.params` carries what the pattern of the machine declares and nothing else. The params of the prefix belong to the host, so they travel in no `play.route` event, and a host param that shares a name with one of the machine can shadow it never. Read the resolved mount from the bridge instead, where it cannot go stale:
440
548
 
441
549
  ```typescript
550
+ import type { RouterBridgeBase } from "@xmachines/play-router";
551
+
552
+ declare const bridge: RouterBridgeBase; // the bridge of any adapter
553
+
442
554
  bridge.basePath; // "/abc123/play"
443
555
  bridge.basePathParams; // { machineId: "abc123" }
444
556
  ```
@@ -458,6 +570,11 @@ Several machines can be alive together, each mounted at its own prefix, all shar
458
570
  `setBasePath()` moves **where** an actor is mounted, and never **which** actor is mounted. The actor, the route map, and its LRU cache all stay:
459
571
 
460
572
  ```typescript
573
+ import type { RouterBridgeBase } from "@xmachines/play-router";
574
+
575
+ declare const bridge: RouterBridgeBase; // the bridge of any adapter
576
+ declare const machineId: string;
577
+
461
578
  // The host moved this actor from one region of its URL space to another.
462
579
  bridge.setBasePath("/:region/:machineId/play", { region: "us", machineId });
463
580
  ```
@@ -470,13 +587,17 @@ For a host router that declares real route objects, ask for the list — and dro
470
587
 
471
588
  ```typescript
472
589
  import { extractMachineRoutes, getRouteMappings } from "@xmachines/play-router/xstate";
590
+ import type { AnyStateMachine } from "xstate";
591
+
592
+ declare const appMachine: AnyStateMachine; // your machine, with routes
593
+ declare const machineId: string; // "abc123", which the loader resolved
473
594
 
474
- const tree = extractMachineRoutes(authMachine);
595
+ const tree = extractMachineRoutes(appMachine);
475
596
 
476
597
  // Concrete, for a route that the host adds after a loader resolved the mount
477
598
  getRouteMappings(tree, { basePath: "/:machineId/play", basePathParams: { machineId } });
478
599
  // [{ stateId: "home", path: "/abc123/play" },
479
- // { stateId: "profile", path: "/abc123/play/profile/:userId" }, ...]
600
+ // { stateId: "profile", path: "/abc123/play/profile/:username" }, ...]
480
601
 
481
602
  // The pattern, for a static route declaration of the host
482
603
  getRouteMappings(tree, { basePath: "/:machineId/play" });
@@ -492,7 +613,7 @@ getRouteMappings(tree, { basePath: "/:machineId/play" });
492
613
  > extraction reads that value.
493
614
  >
494
615
  > These branches decide the CALLS of a navigation, and never the availability of the API.
495
- > [`@xmachines/play-router`](../api/@xmachines/play-router/README.md) carries `urlpattern-polyfill` as an ordinary dependency and it
616
+ > [`@xmachines/play-url`](../api/@xmachines/play-url/README.md) carries `urlpattern-polyfill` as an ordinary dependency and it
496
617
  > uses the native `URLPattern` when the runtime has one, so you install no polyfill and
497
618
  > you load none. A BAD pattern is a question of the route map: `RouteMap` compiles each
498
619
  > parameterized route in its constructor and throws an `InvalidRoutePatternError` there.