@xmachines/docs 6.1.0 → 7.1.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 (810) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/core/README.md +7 -2
  3. package/api/@xmachines/core/cache/functions/createLruCache.md +7 -7
  4. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +6 -6
  5. package/api/@xmachines/core/errors/classes/BaseError.md +15 -23
  6. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +11 -11
  7. package/api/@xmachines/core/utils/functions/asDisposable.md +9 -9
  8. package/api/@xmachines/core/utils/functions/createNullRecord.md +4 -4
  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 +4 -4
  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 +11 -11
  22. package/api/@xmachines/play/errors/classes/PlayError.md +12 -11
  23. package/api/@xmachines/play/index/functions/assertNonNullable.md +4 -4
  24. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +9 -9
  25. package/api/@xmachines/play-actor/README.md +12 -2
  26. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +4 -4
  27. package/api/@xmachines/play-actor/interfaces/PlayActor.md +9 -9
  28. package/api/@xmachines/play-atom/README.md +16 -4
  29. package/api/@xmachines/play-atom/functions/watchAtom.md +4 -4
  30. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  31. package/api/@xmachines/play-atom/interfaces/Atom.md +9 -9
  32. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +9 -9
  33. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +7 -7
  34. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  35. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +7 -7
  36. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +9 -9
  37. package/api/@xmachines/play-atom/interfaces/Readable.md +7 -7
  38. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +7 -7
  39. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  40. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +5 -5
  41. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +4 -4
  42. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  43. package/api/@xmachines/play-atom/variables/createWritableAtom.md +4 -4
  44. package/api/@xmachines/play-dom/README.md +131 -48
  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 +4 -4
  48. package/api/@xmachines/play-dom/functions/defineRegistry.md +3 -3
  49. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -2
  50. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +13 -13
  51. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +17 -15
  52. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +26 -20
  53. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  54. package/api/@xmachines/play-dom/interfaces/PassOptions.md +14 -0
  55. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +18 -17
  56. package/api/@xmachines/play-dom/interfaces/RenderErrorInfo.md +16 -0
  57. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +17 -15
  58. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +9 -8
  59. package/api/@xmachines/play-dom/interfaces/ValidationRegistry.md +14 -11
  60. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +4 -4
  61. package/api/@xmachines/play-dom/type-aliases/Actions.md +3 -3
  62. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +4 -4
  63. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +3 -3
  64. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +4 -4
  65. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +3 -3
  66. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +9 -10
  67. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +10 -9
  68. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  69. package/api/@xmachines/play-dom/type-aliases/OnRenderError.md +27 -0
  70. package/api/@xmachines/play-dom/type-aliases/RenderErrorKind.md +21 -0
  71. package/api/@xmachines/play-dom-router/README.md +41 -5
  72. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  73. package/api/@xmachines/play-dom-router/classes/RouteMap.md +5 -5
  74. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  75. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  76. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  77. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +5 -5
  78. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  79. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  80. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  81. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +9 -9
  82. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  83. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  84. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  85. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  86. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  87. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +8 -8
  88. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  89. package/api/@xmachines/play-pattern/README.md +1 -1
  90. package/api/@xmachines/play-pattern/functions/buildPath.md +2 -2
  91. package/api/@xmachines/play-pattern/functions/createLruCache.md +7 -7
  92. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  93. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  94. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  95. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  96. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +6 -6
  97. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  98. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  99. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  100. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  101. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  102. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  103. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  104. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  105. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  106. package/api/@xmachines/play-react/README.md +57 -18
  107. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +36 -75
  108. package/api/@xmachines/play-react/functions/defineRegistry.md +4 -4
  109. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  110. package/api/@xmachines/play-react/functions/useAtomEffect.md +2 -2
  111. package/api/@xmachines/play-react/functions/useBoundProp.md +3 -3
  112. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  113. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +5 -5
  114. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +11 -11
  115. package/api/@xmachines/play-react/interfaces/ComponentContext.md +4 -4
  116. package/api/@xmachines/play-react/interfaces/DefineRegistryResult.md +15 -0
  117. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +8 -8
  118. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +6 -6
  119. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +15 -14
  120. package/api/@xmachines/play-react/interfaces/RenderErrorInfo.md +16 -0
  121. package/api/@xmachines/play-react/interfaces/RendererProps.md +7 -7
  122. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  123. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  124. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +4 -4
  125. package/api/@xmachines/play-react/type-aliases/OnRenderError.md +27 -0
  126. package/api/@xmachines/play-react/type-aliases/RenderErrorKind.md +21 -0
  127. package/api/@xmachines/play-react/variables/ActorProvider.md +14 -4
  128. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  129. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  130. package/api/@xmachines/play-react-router/README.md +27 -6
  131. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  132. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
  133. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +5 -5
  134. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  135. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +9 -9
  136. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +14 -14
  137. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +6 -6
  138. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  139. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  140. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  141. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  142. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  143. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +4 -4
  144. package/api/@xmachines/play-router/README.md +73 -16
  145. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +11 -11
  146. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +12 -12
  147. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +12 -12
  148. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +12 -12
  149. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +12 -12
  150. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +12 -12
  151. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +13 -13
  152. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +11 -11
  153. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +13 -13
  154. package/api/@xmachines/play-router/index/classes/RouteMap.md +5 -5
  155. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +14 -14
  156. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  157. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +4 -4
  158. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  159. package/api/@xmachines/play-router/index/functions/createLruCache.md +7 -7
  160. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  161. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  162. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  163. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  164. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  165. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  166. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  167. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  168. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  169. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  170. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  171. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +9 -9
  172. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  173. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +6 -6
  174. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  175. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  176. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  177. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  178. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  179. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  180. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  181. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  182. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +5 -5
  183. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +6 -6
  184. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  185. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  186. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +6 -6
  187. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +5 -5
  188. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +8 -8
  189. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +14 -14
  190. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  191. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +14 -14
  192. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +9 -9
  193. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +16 -16
  194. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +5 -5
  195. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +5 -5
  196. package/api/@xmachines/play-router/index/interfaces/Routable.md +5 -5
  197. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +6 -6
  198. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +10 -10
  199. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  200. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +5 -5
  201. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +5 -5
  202. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +12 -12
  203. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +7 -7
  204. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +10 -10
  205. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  206. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  207. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +10 -9
  208. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +8 -8
  209. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +7 -7
  210. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  211. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  212. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  213. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  214. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  215. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  216. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  217. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  218. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  220. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  221. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  222. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  223. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  224. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  225. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  226. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  227. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +5 -5
  228. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +7 -7
  229. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  230. package/api/@xmachines/play-solid/README.md +35 -11
  231. package/api/@xmachines/play-solid/functions/defineRegistry.md +3 -3
  232. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  233. package/api/@xmachines/play-solid/functions/useBoundProp.md +11 -8
  234. package/api/@xmachines/play-solid/functions/useFieldValidation.md +6 -4
  235. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  236. package/api/@xmachines/play-solid/functions/useStateBinding.md +8 -6
  237. package/api/@xmachines/play-solid/functions/useStateValue.md +8 -6
  238. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  239. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +4 -4
  240. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +15 -14
  241. package/api/@xmachines/play-solid/interfaces/RenderErrorInfo.md +16 -0
  242. package/api/@xmachines/play-solid/interfaces/RendererProps.md +7 -7
  243. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  244. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +4 -4
  246. package/api/@xmachines/play-solid/type-aliases/OnRenderError.md +27 -0
  247. package/api/@xmachines/play-solid/type-aliases/RenderErrorKind.md +21 -0
  248. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  249. package/api/@xmachines/play-solid/variables/ActorProvider.md +17 -3
  250. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  251. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  252. package/api/@xmachines/play-solid-router/README.md +22 -6
  253. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
  254. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  255. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +5 -5
  256. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +9 -9
  257. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +9 -9
  258. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +14 -14
  259. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +6 -6
  260. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  261. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  262. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  263. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  264. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  265. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  266. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +4 -4
  267. package/api/@xmachines/play-svelte/README.md +18 -10
  268. package/api/@xmachines/play-svelte/functions/defineRegistry.md +6 -7
  269. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  270. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  271. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  272. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +12 -12
  273. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +13 -13
  274. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +14 -14
  275. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +11 -11
  276. package/api/@xmachines/play-svelte/interfaces/DefineRegistryResult.md +15 -0
  277. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +14 -14
  278. package/api/@xmachines/play-svelte/interfaces/RenderErrorInfo.md +16 -0
  279. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  280. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +4 -4
  281. package/api/@xmachines/play-svelte/type-aliases/Actions.md +3 -3
  282. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  283. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +4 -4
  284. package/api/@xmachines/play-svelte/type-aliases/OnRenderError.md +27 -0
  285. package/api/@xmachines/play-svelte/type-aliases/RenderErrorKind.md +21 -0
  286. package/api/@xmachines/play-svelte-spa-router/README.md +9 -5
  287. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
  288. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +8 -8
  289. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  290. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +5 -5
  291. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  292. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +9 -9
  293. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +6 -6
  294. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  295. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  296. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  297. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +8 -8
  298. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  299. package/api/@xmachines/play-sveltekit-router/README.md +65 -13
  300. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
  301. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +29 -19
  302. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  303. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +5 -5
  304. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +13 -16
  305. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  306. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +9 -9
  307. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +6 -6
  308. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  309. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  310. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  311. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +8 -8
  312. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +25 -0
  313. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +21 -0
  314. package/api/@xmachines/play-tanstack-react-router/README.md +34 -16
  315. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
  316. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  317. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +5 -5
  318. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  319. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +9 -9
  320. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +14 -14
  321. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +6 -6
  322. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  323. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  324. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  325. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  326. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  327. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  328. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +9 -9
  329. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +4 -4
  330. package/api/@xmachines/play-tanstack-router/README.md +5 -3
  331. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  332. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  333. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +9 -9
  334. package/api/@xmachines/play-tanstack-solid-router/README.md +45 -11
  335. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
  336. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  337. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +5 -5
  338. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +9 -9
  339. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +14 -14
  340. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +6 -6
  341. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  342. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  343. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  344. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  345. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  346. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  347. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +9 -9
  348. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +4 -4
  349. package/api/@xmachines/play-url/README.md +1 -1
  350. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +12 -12
  351. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +12 -12
  352. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +13 -13
  353. package/api/@xmachines/play-url/index/functions/buildPath.md +2 -2
  354. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  355. package/api/@xmachines/play-url/index/functions/createLruCache.md +7 -7
  356. package/api/@xmachines/play-url/index/functions/getCandidates.md +4 -4
  357. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +5 -5
  358. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  359. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  360. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  361. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  362. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  363. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  364. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +6 -6
  365. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  366. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  367. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  368. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  369. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  370. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +5 -5
  371. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  372. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  373. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +6 -6
  374. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +6 -6
  375. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +5 -5
  376. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +9 -9
  377. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  378. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +14 -14
  379. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +6 -6
  380. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +5 -5
  381. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +7 -7
  382. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  383. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  384. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  385. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  386. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +2 -2
  387. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  388. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  389. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  390. package/api/@xmachines/play-view/README.md +45 -19
  391. package/api/@xmachines/play-view/errors/README.md +1 -0
  392. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +13 -13
  393. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +12 -12
  394. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +181 -0
  395. package/api/@xmachines/play-view/index/README.md +10 -4
  396. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +13 -12
  397. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +34 -0
  398. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  399. package/api/@xmachines/play-view/index/functions/composeViews.md +8 -2
  400. package/api/@xmachines/play-view/index/functions/createActorProxy.md +39 -0
  401. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +35 -0
  402. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  403. package/api/@xmachines/play-view/index/functions/createViewSession.md +29 -0
  404. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  405. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +45 -0
  406. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  407. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  408. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  409. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  410. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  411. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +12 -12
  412. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +10 -10
  413. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +7 -7
  414. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +19 -0
  415. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +8 -8
  416. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  417. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  418. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +4 -4
  419. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +7 -7
  420. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +5 -5
  421. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +155 -0
  422. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +12 -0
  423. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +23 -0
  424. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +22 -3
  425. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +7 -6
  426. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +6 -6
  427. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +5 -5
  428. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  429. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +21 -0
  430. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +5 -5
  431. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  432. package/api/@xmachines/play-vue/README.md +20 -15
  433. package/api/@xmachines/play-vue/functions/defineRegistry.md +4 -4
  434. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  435. package/api/@xmachines/play-vue/functions/useBoundProp.md +13 -7
  436. package/api/@xmachines/play-vue/functions/useFieldValidation.md +12 -5
  437. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  438. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  439. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +4 -4
  440. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  441. package/api/@xmachines/play-vue/interfaces/RenderErrorInfo.md +16 -0
  442. package/api/@xmachines/play-vue/interfaces/RendererProps.md +7 -7
  443. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  444. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  445. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +5 -5
  446. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +4 -4
  447. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +4 -4
  448. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +9 -9
  449. package/api/@xmachines/play-vue/type-aliases/OnRenderError.md +27 -0
  450. package/api/@xmachines/play-vue/type-aliases/RenderErrorKind.md +21 -0
  451. package/api/@xmachines/play-vue/variables/ActionProvider.md +35 -54
  452. package/api/@xmachines/play-vue/variables/PlayRenderer.md +4 -2
  453. package/api/@xmachines/play-vue/variables/Renderer.md +61 -78
  454. package/api/@xmachines/play-vue/variables/StateProvider.md +44 -63
  455. package/api/@xmachines/play-vue/variables/ValidationProvider.md +26 -45
  456. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +17 -30
  457. package/api/@xmachines/play-vue-router/README.md +19 -12
  458. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +11 -11
  459. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +11 -11
  460. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +5 -5
  461. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  462. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +9 -9
  463. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +6 -6
  464. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  465. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +5 -5
  466. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  467. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +90 -105
  468. package/api/@xmachines/play-xstate/README.md +64 -12
  469. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +11 -11
  470. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +12 -12
  471. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +11 -11
  472. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +13 -13
  473. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +13 -13
  474. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  475. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +13 -13
  476. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +13 -13
  477. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +44 -68
  478. package/api/@xmachines/play-xstate/index/functions/compose.md +22 -22
  479. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +9 -9
  480. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +10 -10
  481. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +7 -7
  482. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +12 -12
  483. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +5 -5
  484. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +6 -6
  485. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +5 -5
  486. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +2 -2
  487. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  488. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +4 -4
  489. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  490. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +4 -4
  491. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +7 -7
  492. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +7 -7
  493. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  494. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  495. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +7 -7
  496. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  497. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +10 -10
  498. package/api/@xmachines/play-xstate/with-view/functions/withView.md +4 -4
  499. package/api/@xmachines/shared/README.md +4 -3
  500. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  501. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  502. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  503. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  504. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +4 -4
  505. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  506. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  507. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +2 -2
  508. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  509. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +2 -2
  510. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  511. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  512. package/contributing/architecture.md +88 -53
  513. package/contributing/configuration.md +44 -62
  514. package/contributing/deployment.md +131 -161
  515. package/contributing/development.md +33 -8
  516. package/contributing/migrating-to-play-atom.md +10 -4
  517. package/contributing/testing.md +67 -34
  518. package/examples/@xmachines/play-dom-gallery-demo/README.md +127 -0
  519. package/examples/@xmachines/play-dom-gallery-demo/functions/createConfirmDialog.md +33 -0
  520. package/examples/@xmachines/play-dom-gallery-demo/functions/createDebugPanel.md +31 -0
  521. package/examples/@xmachines/play-dom-gallery-demo/functions/initApp.md +22 -0
  522. package/examples/@xmachines/play-dom-gallery-demo/functions/initShell.md +33 -0
  523. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  524. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  525. package/examples/@xmachines/play-dom-gallery-demo/interfaces/ShellOptions.md +18 -0
  526. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  527. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  528. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  529. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  530. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GalleryActor.md +20 -0
  531. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GallerySlug.md +18 -0
  532. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/KitCatalog.md +16 -0
  533. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  534. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  535. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  536. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  537. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  538. package/examples/@xmachines/play-dom-gallery-demo/variables/Button.md +12 -0
  539. package/examples/@xmachines/play-dom-gallery-demo/variables/Field.md +30 -0
  540. package/examples/@xmachines/play-dom-gallery-demo/variables/Page.md +16 -0
  541. package/examples/@xmachines/play-dom-gallery-demo/variables/Panel.md +15 -0
  542. package/examples/@xmachines/play-dom-gallery-demo/variables/Text.md +15 -0
  543. package/examples/@xmachines/play-dom-gallery-demo/variables/authCatalog.md +126 -0
  544. package/examples/@xmachines/play-dom-gallery-demo/variables/demoComponents.md +21 -0
  545. package/examples/@xmachines/play-dom-gallery-demo/variables/donutCatalog.md +135 -0
  546. package/examples/@xmachines/play-dom-gallery-demo/variables/fetchCatalog.md +119 -0
  547. package/examples/@xmachines/play-dom-gallery-demo/variables/flightCatalog.md +146 -0
  548. package/examples/@xmachines/play-dom-gallery-demo/variables/galleryMachines.md +11 -0
  549. package/examples/@xmachines/play-dom-gallery-demo/variables/stopwatchCatalog.md +119 -0
  550. package/examples/@xmachines/play-dom-gallery-demo/variables/temperatureCatalog.md +122 -0
  551. package/examples/@xmachines/play-dom-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  552. package/examples/@xmachines/{play-dom-demo/variables/authCatalog.md → play-dom-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  553. package/examples/@xmachines/play-dom-gallery-demo/variables/triviaCatalog.md +129 -0
  554. package/examples/@xmachines/play-dom-router-demo/README.md +41 -33
  555. package/examples/@xmachines/play-dom-router-donut-demo/README.md +78 -0
  556. package/examples/@xmachines/play-dom-router-flight-demo/README.md +76 -0
  557. package/examples/@xmachines/play-dom-router-todomvc-demo/README.md +76 -0
  558. package/examples/@xmachines/play-dom-router-trivia-demo/README.md +76 -0
  559. package/examples/@xmachines/play-react-gallery-demo/README.md +123 -0
  560. package/examples/@xmachines/play-react-gallery-demo/functions/App.md +13 -0
  561. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  562. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  563. package/examples/@xmachines/play-react-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  564. package/examples/@xmachines/play-react-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  565. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  566. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  567. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GalleryActor.md +20 -0
  568. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GallerySlug.md +18 -0
  569. package/examples/@xmachines/play-react-gallery-demo/type-aliases/KitCatalog.md +16 -0
  570. package/examples/@xmachines/play-react-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  571. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  572. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  573. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  574. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  575. package/examples/@xmachines/play-react-gallery-demo/variables/Button.md +12 -0
  576. package/examples/@xmachines/play-react-gallery-demo/variables/DebugPanel.md +21 -0
  577. package/examples/@xmachines/play-react-gallery-demo/variables/Field.md +24 -0
  578. package/examples/@xmachines/play-react-gallery-demo/variables/Page.md +14 -0
  579. package/examples/@xmachines/play-react-gallery-demo/variables/Panel.md +15 -0
  580. package/examples/@xmachines/play-react-gallery-demo/variables/Shell.md +26 -0
  581. package/examples/@xmachines/play-react-gallery-demo/variables/Text.md +15 -0
  582. package/examples/@xmachines/play-react-gallery-demo/variables/authCatalog.md +126 -0
  583. package/examples/@xmachines/play-react-gallery-demo/variables/demoComponents.md +21 -0
  584. package/examples/@xmachines/play-react-gallery-demo/variables/donutCatalog.md +135 -0
  585. package/examples/@xmachines/play-react-gallery-demo/variables/fetchCatalog.md +119 -0
  586. package/examples/@xmachines/play-react-gallery-demo/variables/flightCatalog.md +146 -0
  587. package/examples/@xmachines/play-react-gallery-demo/variables/galleryMachines.md +11 -0
  588. package/examples/@xmachines/play-react-gallery-demo/variables/stopwatchCatalog.md +119 -0
  589. package/examples/@xmachines/play-react-gallery-demo/variables/temperatureCatalog.md +122 -0
  590. package/examples/@xmachines/play-react-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  591. package/examples/@xmachines/{play-vue-demo/variables/authCatalog.md → play-react-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  592. package/examples/@xmachines/play-react-gallery-demo/variables/triviaCatalog.md +129 -0
  593. package/examples/@xmachines/play-react-router-demo/README.md +21 -9
  594. package/examples/@xmachines/play-react-router-donut-demo/README.md +85 -0
  595. package/examples/@xmachines/play-react-router-flight-demo/README.md +74 -0
  596. package/examples/@xmachines/play-react-router-todomvc-demo/README.md +74 -0
  597. package/examples/@xmachines/play-react-router-trivia-demo/README.md +74 -0
  598. package/examples/@xmachines/play-solid-gallery-demo/README.md +123 -0
  599. package/examples/@xmachines/play-solid-gallery-demo/functions/App.md +13 -0
  600. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  601. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  602. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  603. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  604. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  605. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  606. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GalleryActor.md +20 -0
  607. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GallerySlug.md +18 -0
  608. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/KitCatalog.md +16 -0
  609. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  610. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  611. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  612. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  613. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  614. package/examples/@xmachines/play-solid-gallery-demo/variables/Button.md +11 -0
  615. package/examples/@xmachines/play-solid-gallery-demo/variables/DebugPanel.md +22 -0
  616. package/examples/@xmachines/play-solid-gallery-demo/variables/Field.md +11 -0
  617. package/examples/@xmachines/play-solid-gallery-demo/variables/Page.md +11 -0
  618. package/examples/@xmachines/play-solid-gallery-demo/variables/Panel.md +11 -0
  619. package/examples/@xmachines/play-solid-gallery-demo/variables/Shell.md +26 -0
  620. package/examples/@xmachines/play-solid-gallery-demo/variables/Text.md +11 -0
  621. package/examples/@xmachines/play-solid-gallery-demo/variables/authCatalog.md +126 -0
  622. package/examples/@xmachines/play-solid-gallery-demo/variables/demoComponents.md +21 -0
  623. package/examples/@xmachines/play-solid-gallery-demo/variables/donutCatalog.md +135 -0
  624. package/examples/@xmachines/play-solid-gallery-demo/variables/fetchCatalog.md +119 -0
  625. package/examples/@xmachines/play-solid-gallery-demo/variables/flightCatalog.md +146 -0
  626. package/examples/@xmachines/play-solid-gallery-demo/variables/galleryMachines.md +11 -0
  627. package/examples/@xmachines/play-solid-gallery-demo/variables/stopwatchCatalog.md +119 -0
  628. package/examples/@xmachines/play-solid-gallery-demo/variables/temperatureCatalog.md +122 -0
  629. package/examples/@xmachines/play-solid-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  630. package/examples/@xmachines/{play-react-demo/variables/authCatalog.md → play-solid-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  631. package/examples/@xmachines/play-solid-gallery-demo/variables/triviaCatalog.md +129 -0
  632. package/examples/@xmachines/play-solid-router-demo/README.md +17 -9
  633. package/examples/@xmachines/play-solid-router-donut-demo/README.md +86 -0
  634. package/examples/@xmachines/play-solid-router-flight-demo/README.md +75 -0
  635. package/examples/@xmachines/play-solid-router-todomvc-demo/README.md +75 -0
  636. package/examples/@xmachines/play-solid-router-trivia-demo/README.md +75 -0
  637. package/examples/@xmachines/play-svelte-gallery-demo/README.md +130 -0
  638. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  639. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  640. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/App.md +9 -0
  641. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  642. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  643. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  644. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  645. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GalleryActor.md +20 -0
  646. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GallerySlug.md +18 -0
  647. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/KitCatalog.md +16 -0
  648. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  649. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  650. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  651. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  652. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  653. package/examples/@xmachines/play-svelte-gallery-demo/variables/App.md +9 -0
  654. package/examples/@xmachines/play-svelte-gallery-demo/variables/authCatalog.md +126 -0
  655. package/examples/@xmachines/play-svelte-gallery-demo/variables/demoComponents.md +21 -0
  656. package/examples/@xmachines/play-svelte-gallery-demo/variables/donutCatalog.md +135 -0
  657. package/examples/@xmachines/play-svelte-gallery-demo/variables/fetchCatalog.md +119 -0
  658. package/examples/@xmachines/play-svelte-gallery-demo/variables/flightCatalog.md +146 -0
  659. package/examples/@xmachines/play-svelte-gallery-demo/variables/galleryMachines.md +11 -0
  660. package/examples/@xmachines/play-svelte-gallery-demo/variables/stopwatchCatalog.md +119 -0
  661. package/examples/@xmachines/play-svelte-gallery-demo/variables/temperatureCatalog.md +122 -0
  662. package/examples/@xmachines/play-svelte-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  663. package/examples/@xmachines/{play-solid-demo/variables/authCatalog.md → play-svelte-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  664. package/examples/@xmachines/play-svelte-gallery-demo/variables/triviaCatalog.md +129 -0
  665. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +9 -9
  666. package/examples/@xmachines/play-svelte-spa-router-donut-demo/README.md +77 -0
  667. package/examples/@xmachines/play-svelte-spa-router-flight-demo/README.md +76 -0
  668. package/examples/@xmachines/play-svelte-spa-router-todomvc-demo/README.md +76 -0
  669. package/examples/@xmachines/play-svelte-spa-router-trivia-demo/README.md +76 -0
  670. package/examples/@xmachines/play-sveltekit-router-demo/README.md +9 -9
  671. package/examples/@xmachines/play-sveltekit-router-donut-demo/README.md +103 -0
  672. package/examples/@xmachines/play-sveltekit-router-flight-demo/README.md +86 -0
  673. package/examples/@xmachines/play-sveltekit-router-todomvc-demo/README.md +86 -0
  674. package/examples/@xmachines/play-sveltekit-router-trivia-demo/README.md +86 -0
  675. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +22 -16
  676. package/examples/@xmachines/play-tanstack-react-router-donut-demo/README.md +78 -0
  677. package/examples/@xmachines/play-tanstack-react-router-flight-demo/README.md +74 -0
  678. package/examples/@xmachines/play-tanstack-react-router-todomvc-demo/README.md +74 -0
  679. package/examples/@xmachines/play-tanstack-react-router-trivia-demo/README.md +74 -0
  680. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +25 -17
  681. package/examples/@xmachines/play-tanstack-solid-router-donut-demo/README.md +91 -0
  682. package/examples/@xmachines/play-tanstack-solid-router-flight-demo/README.md +80 -0
  683. package/examples/@xmachines/play-tanstack-solid-router-todomvc-demo/README.md +80 -0
  684. package/examples/@xmachines/play-tanstack-solid-router-trivia-demo/README.md +80 -0
  685. package/examples/@xmachines/play-vue-gallery-demo/README.md +120 -0
  686. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  687. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  688. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  689. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  690. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  691. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  692. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GalleryActor.md +20 -0
  693. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GallerySlug.md +18 -0
  694. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/KitCatalog.md +16 -0
  695. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  696. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  697. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  698. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  699. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  700. package/examples/@xmachines/play-vue-gallery-demo/variables/App.md +11 -0
  701. package/examples/@xmachines/play-vue-gallery-demo/variables/authCatalog.md +126 -0
  702. package/examples/@xmachines/play-vue-gallery-demo/variables/demoComponents.md +11 -0
  703. package/examples/@xmachines/play-vue-gallery-demo/variables/donutCatalog.md +135 -0
  704. package/examples/@xmachines/play-vue-gallery-demo/variables/fetchCatalog.md +119 -0
  705. package/examples/@xmachines/play-vue-gallery-demo/variables/flightCatalog.md +146 -0
  706. package/examples/@xmachines/play-vue-gallery-demo/variables/galleryMachines.md +11 -0
  707. package/examples/@xmachines/play-vue-gallery-demo/variables/stopwatchCatalog.md +119 -0
  708. package/examples/@xmachines/play-vue-gallery-demo/variables/temperatureCatalog.md +122 -0
  709. package/examples/@xmachines/play-vue-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  710. package/examples/@xmachines/play-vue-gallery-demo/variables/todoMvcCatalog.md +151 -0
  711. package/examples/@xmachines/play-vue-gallery-demo/variables/triviaCatalog.md +129 -0
  712. package/examples/@xmachines/play-vue-router-demo/README.md +17 -11
  713. package/examples/@xmachines/play-vue-router-donut-demo/README.md +78 -0
  714. package/examples/@xmachines/play-vue-router-flight-demo/README.md +76 -0
  715. package/examples/@xmachines/play-vue-router-todomvc-demo/README.md +76 -0
  716. package/examples/@xmachines/play-vue-router-trivia-demo/README.md +76 -0
  717. package/examples/README.md +44 -6
  718. package/examples/form-validation.md +17 -13
  719. package/examples/multi-router-integration.md +268 -147
  720. package/examples/routing-patterns.md +46 -9
  721. package/examples/traffic-light.md +6 -2
  722. package/examples/xstate-example-ports.md +106 -0
  723. package/guides/actor-model.md +37 -19
  724. package/guides/atoms.md +48 -8
  725. package/guides/getting-started.md +66 -14
  726. package/guides/inspector.md +74 -14
  727. package/guides/routing.md +4 -1
  728. package/guides/state-machines.md +35 -13
  729. package/guides/views.md +34 -14
  730. package/package.json +6 -6
  731. package/rfc/play.md +31 -13
  732. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +0 -20
  733. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +0 -25
  734. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +0 -60
  735. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +0 -19
  736. package/examples/@xmachines/play-dom-demo/README.md +0 -162
  737. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +0 -35
  738. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +0 -27
  739. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +0 -24
  740. package/examples/@xmachines/play-dom-demo/functions/initShell.md +0 -25
  741. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +0 -9
  742. package/examples/@xmachines/play-dom-demo/variables/About.md +0 -12
  743. package/examples/@xmachines/play-dom-demo/variables/Button.md +0 -12
  744. package/examples/@xmachines/play-dom-demo/variables/Contact.md +0 -12
  745. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +0 -13
  746. package/examples/@xmachines/play-dom-demo/variables/Field.md +0 -19
  747. package/examples/@xmachines/play-dom-demo/variables/Home.md +0 -13
  748. package/examples/@xmachines/play-dom-demo/variables/Login.md +0 -13
  749. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +0 -16
  750. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +0 -13
  751. package/examples/@xmachines/play-dom-demo/variables/Overview.md +0 -13
  752. package/examples/@xmachines/play-dom-demo/variables/Panel.md +0 -14
  753. package/examples/@xmachines/play-dom-demo/variables/Profile.md +0 -13
  754. package/examples/@xmachines/play-dom-demo/variables/Settings.md +0 -13
  755. package/examples/@xmachines/play-dom-demo/variables/Stats.md +0 -13
  756. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +0 -30
  757. package/examples/@xmachines/play-react-demo/README.md +0 -163
  758. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +0 -35
  759. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +0 -9
  760. package/examples/@xmachines/play-react-demo/variables/About.md +0 -14
  761. package/examples/@xmachines/play-react-demo/variables/Button.md +0 -12
  762. package/examples/@xmachines/play-react-demo/variables/Contact.md +0 -14
  763. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +0 -15
  764. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +0 -16
  765. package/examples/@xmachines/play-react-demo/variables/Field.md +0 -18
  766. package/examples/@xmachines/play-react-demo/variables/Home.md +0 -14
  767. package/examples/@xmachines/play-react-demo/variables/Login.md +0 -16
  768. package/examples/@xmachines/play-react-demo/variables/NavBar.md +0 -16
  769. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +0 -15
  770. package/examples/@xmachines/play-react-demo/variables/Navigation.md +0 -14
  771. package/examples/@xmachines/play-react-demo/variables/Overview.md +0 -14
  772. package/examples/@xmachines/play-react-demo/variables/Panel.md +0 -15
  773. package/examples/@xmachines/play-react-demo/variables/Profile.md +0 -14
  774. package/examples/@xmachines/play-react-demo/variables/Settings.md +0 -14
  775. package/examples/@xmachines/play-react-demo/variables/Shell.md +0 -19
  776. package/examples/@xmachines/play-react-demo/variables/Stats.md +0 -14
  777. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +0 -30
  778. package/examples/@xmachines/play-solid-demo/README.md +0 -163
  779. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +0 -35
  780. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +0 -9
  781. package/examples/@xmachines/play-solid-demo/variables/About.md +0 -9
  782. package/examples/@xmachines/play-solid-demo/variables/Button.md +0 -11
  783. package/examples/@xmachines/play-solid-demo/variables/Contact.md +0 -9
  784. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +0 -9
  785. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +0 -17
  786. package/examples/@xmachines/play-solid-demo/variables/Field.md +0 -11
  787. package/examples/@xmachines/play-solid-demo/variables/Home.md +0 -9
  788. package/examples/@xmachines/play-solid-demo/variables/Login.md +0 -9
  789. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +0 -11
  790. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +0 -15
  791. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +0 -9
  792. package/examples/@xmachines/play-solid-demo/variables/Overview.md +0 -9
  793. package/examples/@xmachines/play-solid-demo/variables/Panel.md +0 -11
  794. package/examples/@xmachines/play-solid-demo/variables/Profile.md +0 -9
  795. package/examples/@xmachines/play-solid-demo/variables/Settings.md +0 -9
  796. package/examples/@xmachines/play-solid-demo/variables/Shell.md +0 -18
  797. package/examples/@xmachines/play-solid-demo/variables/Stats.md +0 -9
  798. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +0 -30
  799. package/examples/@xmachines/play-svelte-demo/README.md +0 -137
  800. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +0 -35
  801. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +0 -9
  802. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +0 -9
  803. package/examples/@xmachines/play-svelte-demo/variables/App.md +0 -9
  804. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +0 -197
  805. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +0 -30
  806. package/examples/@xmachines/play-vue-demo/README.md +0 -159
  807. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +0 -35
  808. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +0 -9
  809. package/examples/@xmachines/play-vue-demo/variables/App.md +0 -9
  810. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +0 -11
@@ -0,0 +1,16 @@
1
+ [API](../../../README.md) / [@xmachines/play-dom](../README.md) / RenderErrorInfo
2
+
3
+ # Interface: RenderErrorInfo
4
+
5
+ Defined in: `@xmachines/json-render-core`
6
+
7
+ What a renderer tells the handler about a failure.
8
+
9
+ ## Properties
10
+
11
+ | Property | Type | Description | Defined in |
12
+ | -------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------- |
13
+ | <a id="property-action"></a> `action?` | `string` | The action name, for `action` and `watch`. | - |
14
+ | <a id="property-key"></a> `key?` | `string` | The key of the element whose code failed. For `props` and `visible`, the child, not the boundary. | - |
15
+ | <a id="property-kind"></a> `kind` | [`RenderErrorKind`](../type-aliases/RenderErrorKind.md) | The place where the failure occurred. | - |
16
+ | <a id="property-type"></a> `type?` | `string` | The component type of that element. | - |
@@ -11,18 +11,20 @@ empty map, so `renderSpec(spec, store, registry)` renders a static tree.
11
11
 
12
12
  ## Properties
13
13
 
14
- | Property | Type | Description | Defined in |
15
- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
16
- | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language. Converted to a `DirectiveRegistry` once per `renderSpec` call and forwarded to `PropResolutionContext.directives`, matching the framework renderers' `directives` prop (@json-render 0.19). Built-in expressions always take precedence over custom directives. | - |
17
- | <a id="property-fallback"></a> `fallback?` | [`DomComponentRenderer`](../type-aliases/DomComponentRenderer.md) | Renderer called when `registry` has no entry for an element's `type` (GAP-04). If absent, unknown types render as `null`. | - |
18
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Map of named compute functions forwarded to `PropResolutionContext` (GAP-03). Enables `{ $computed: "fn", args }` prop expressions to resolve. When absent, `$computed` expressions return `undefined` (no throw). | - |
19
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action names → async `ActionHandler` functions, consumed by `defineRegistry`'s `emit()`/`watch` dispatch. Defaults to `{}`. | - |
20
- | <a id="property-loading"></a> `loading?` | `boolean` | Flag indicating the spec is still streaming (GAP-06). When `true`, components can read `ctx.loading` to render skeleton states, and missing-child warnings (GAP-07) are suppressed since referenced elements may not yet have arrived in the incremental spec. | - |
21
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation callback forwarded to `DomRenderContext.navigate`. Invoked automatically by `defineRegistry`'s `emit()` when an action binding resolves with `onSuccess: { navigate: "/path" }`. Also readable by component implementations via `ctx.navigate`. | - |
22
- | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook forwarded to `DomRenderContext.onConfirm`. Consulted by `defineRegistry`'s `emit()` before executing an action binding that declares `confirm`. Without it, confirm-gated actions are skipped with a `console.warn` (never executed unconfirmed). | - |
23
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback matching `RenderErrorHandler = (error, name)`. Invoked for three distinct error classes: - `(error, elementType)` when a component renderer throws (GAP-08) - `(error, actionName)` when an action handler rejects during `emit()` - `(error, actionName)` when an action handler rejects in a `watch` binding If absent, all three fall back to `console.error`. Forwarded into `DomRenderContext.onRenderError` so `emit()` and `watch` handlers route errors through the same channel as component render errors. | - |
24
- | <a id="property-onvalidationsetup"></a> `onValidationSetup?` | (`cleanup`) => `void` | Called with an unregister callback for every field an element registers through `ctx.validation.registerField`, so a host can release the registrations of an element instance when it unmounts. Mirrors `onWatchSetup`. | - |
25
- | <a id="property-onwatchsetup"></a> `onWatchSetup?` | (`cleanup`) => `void` \| (() => `void`) | Callback invoked with each watch subscription cleanup function (GAP-02). When an element declares `watch`, the renderer sets up a store subscription and passes its unsubscribe function to this callback. Host renderers collect these to call on teardown. When absent, `watch` bindings are not wired. May return a replacement cleanup: when the caller wraps the supplied cleanup (e.g. to drop it from its own collection when invoked), the incremental renderer registers the returned wrapper so an unmount-driven release also runs the caller's bookkeeping. Returning nothing keeps the supplied cleanup. | - |
26
- | <a id="property-send"></a> `send?` | (`event`) => `void` | Dispatcher for interaction events (e.g. `actor.send`), exposed to component implementations via `ctx.send`. Defaults to a no-op. | - |
27
- | <a id="property-validation"></a> `validation?` | [`ValidationRegistry`](ValidationRegistry.md) | Field-validation registry shared by the whole tree, exposed to components as `ctx.validation` and used by the `validateForm` built-in. One is created per `renderSpec` call when omitted; a host that re-renders (e.g. the incremental renderer) must create one for its lifetime and pass it on every pass so registrations survive. | - |
28
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions forwarded to `DomRenderContext.validationFunctions`. Components pass these as `customFunctions` to `runValidationCheck` / `runValidation` from `@xmachines/json-render-core`. Has no effect on prop resolution. | - |
14
+ | Property | Type | Description | Defined in |
15
+ | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- |
16
+ | <a id="property-confirmdialog"></a> `confirmDialog?` | `boolean` | `false` turns the default confirm dialog off, for a host whose component shows the pending confirmation through `ctx.confirmation`. The default, `true`, shows the dialog on `document.body` for each binding with `confirm` that waits, when the host gives no `onConfirm`, as `JSONUIProvider` of the framework renderers shows `ConfirmDialog`. The renderers that share one validation registry share the setting: the last pass sets it. | - |
17
+ | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language. Converted to a `DirectiveRegistry` once per `renderSpec` call and forwarded to `PropResolutionContext.directives`, matching the framework renderers' `directives` prop (@json-render 0.19). Built-in expressions always take precedence over custom directives. | - |
18
+ | <a id="property-fallback"></a> `fallback?` | [`DomComponentRenderer`](../type-aliases/DomComponentRenderer.md) | Renderer called when `registry` has no entry for an element's `type` (GAP-04). If absent, unknown types render as `null`. | - |
19
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Map of named compute functions forwarded to `PropResolutionContext` (GAP-03). Enables `{ $computed: "fn", args }` prop expressions to resolve. When absent, `$computed` expressions return `undefined` (no throw). | - |
20
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action names → async `ActionHandler` functions, consumed by `defineRegistry`'s `emit()`/`watch` dispatch. Defaults to `{}`. | - |
21
+ | <a id="property-loading"></a> `loading?` | `boolean` | Flag indicating the spec is still streaming (GAP-06). When `true`, components can read `ctx.loading` to render skeleton states, and missing-child warnings (GAP-07) are suppressed since referenced elements may not yet have arrived in the incremental spec. | - |
22
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation callback forwarded to `DomRenderContext.navigate`. Invoked automatically by `defineRegistry`'s `emit()` when an action binding resolves with `onSuccess: { navigate: "/path" }`. Also readable by component implementations via `ctx.navigate`. | - |
23
+ | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook forwarded to `DomRenderContext.onConfirm`. Consulted by `defineRegistry`'s `emit()` before executing an action binding that declares `confirm`. Without it, the binding waits as the pending confirmation of the tree (`ctx.confirmation`), and the default confirm dialog shows it (see `confirmDialog`). | - |
24
+ | <a id="property-oneffectcleanup"></a> `onEffectCleanup?` | (`cleanup`) => `void` | Called with each cleanup that an effect of a component returns (see `DomRenderContext.effect`). `renderSpec` keeps no instance from one call to the next, so the host calls each cleanup when it discards the tree. When absent, the renderer drops the cleanups. The incremental renderer runs the cleanups itself, and it ignores this option. | - |
25
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`OnRenderError`](../type-aliases/OnRenderError.md) | The error handler, `(error, name, info)`. Each failure in code that the renderer runs reaches it one time. `info.kind` names the place: - `element`, with `name` the type of the element: a component renderer below the root throws (GAP-08), an effect of it throws, or a read of its children after the pass fails. The element shows nothing. - `props` and `visible`, with `name` the type of the PARENT: a prop expression or the `visible` condition of an element below the root throws. The boundary of the parent catches it, as in the framework renderers, and the parent shows nothing. `info.key` and `info.type` name the element whose expression threw. - `root`: the root fails, and it has no boundary above it: its component throws, a prop of it fails to resolve, or its `visible` condition throws. The renderer shows nothing and throws nothing, also without a handler, so a root that a stream gives half does not stop the host. A new version of the root renders again. - `action` and `watch`, with `name` the action name: an `on` chain or a `watch` chain fails. A handler that throws gives its error to `reportError` one time, and no other element fails. If absent, the renderer reads the handler of the registry, which `defineRegistry(catalog, { onRenderError })` sets. Without either, each failure gives one `console.error` line of the form `[json-render] <kind> error in <Type> "<key>":`. Forwarded into `DomRenderContext.onRenderError` so `emit()` and `watch` handlers route errors through the same channel as component render errors. | - |
26
+ | <a id="property-onvalidationsetup"></a> `onValidationSetup?` | (`cleanup`) => `void` | Called with an unregister callback for every field an element registers through `ctx.validation.registerField`, so a host can release the registrations of an element instance when it unmounts. Mirrors `onWatchSetup`. | - |
27
+ | <a id="property-onwatchsetup"></a> `onWatchSetup?` | (`cleanup`, `end`, `baseline`) => `void` \| (() => `void`) | Callback invoked with each watch subscription cleanup function (GAP-02). When an element declares `watch`, the renderer sets up a store subscription and passes its unsubscribe function to this callback. Host renderers collect these to call on teardown. When absent, `watch` bindings are not wired. May return a replacement cleanup: when the caller wraps the supplied cleanup (e.g. to drop it from its own collection when invoked), the incremental renderer registers the returned wrapper so an unmount-driven release also runs the caller's bookkeeping. Returning nothing keeps the supplied cleanup. The cleanup stops the subscription, and the bindings that a change still runs go on. A host that renders the tree again on each change must do so after the store notification, for example in a microtask: each watch then hears the change before the host releases it. `end` stops the chain before its next binding, and a change that waits for its run. Call it when the element goes for good. The incremental renderer calls it for a removed element, for an element whose watched paths or item path a new render changes, after a pass that throws, and on `dispose`. `baseline` reads and sets the watched values that the next change compares against. The incremental renderer gives the values of an earlier subscription of the element to its new one, so a write that came before a new spec still fires, as the effect of react compares against the values of its last run. | - |
28
+ | <a id="property-send"></a> `send?` | (`event`) => `void` | Dispatcher for interaction events (e.g. `actor.send`), exposed to component implementations via `ctx.send`. Defaults to a no-op. | - |
29
+ | <a id="property-validation"></a> `validation?` | [`ValidationRegistry`](ValidationRegistry.md) | Field-validation registry shared by the whole tree, exposed to components as `ctx.validation` and used by the `validateForm` built-in. One is created per `renderSpec` call when omitted; a host that re-renders (e.g. the incremental renderer) must create one for its lifetime and pass it on every pass so registrations survive. | - |
30
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions forwarded to `DomRenderContext.validationFunctions`. Components pass these as `customFunctions` to `runValidationCheck` / `runValidation` from `@xmachines/json-render-core`. Has no effect on prop resolution. | - |
@@ -22,11 +22,12 @@ and are available to component implementations via `ctx.ctx.*`.
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description | Defined in |
26
- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
27
- | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language (e.g. `{ $format: "currency", value: ... }`). Each entry is a `DirectiveDefinition` built with `defineDirective` from `@xmachines/json-render-core`. The array is converted to a `DirectiveRegistry` once per render pass and forwarded to `resolveElementProps` via `PropResolutionContext.directives`. Built-in expressions (`$state`, `$cond`, etc.) always take precedence over custom directives. Mirrors the `directives` prop on `JSONUIProvider` / `JsonUIProvider` introduced in **Json-render** 0.19. **Example** `import { defineDirective, resolvePropValue } from "@xmachines/json-render-core"; import { z } from "zod"; const formatDirective = defineDirective({ name: "$format", description: "Locale-aware number formatting.", schema: z.object({ $format: z.enum(["number", "currency"]), value: z.unknown() }), resolve(value, ctx) { const resolved = resolvePropValue(value.value, ctx); return new Intl.NumberFormat().format(resolved as number); }, }); renderSpec(spec, store, registry, { directives: [formatDirective] });` | - |
28
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named compute functions for `{ $computed: "name", args: {...} }` prop expressions. Each function receives the resolved `args` object and returns the computed value. Forwarded directly to `resolveElementProps` via `PropResolutionContext.functions`, matching the `FunctionsContext` provider in the framework renderers. Without this option, `$computed` expressions resolve to `undefined` (no throw). **Example** `renderSpec(spec, store, registry, { functions: { fullName: (args) => `${args.first} ${args.last}`, formatCurrency: (args) => new Intl.NumberFormat().format(args.amount as number), }, });` Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | - |
29
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Programmatic navigation function. Called automatically when an action binding resolves with `onSuccess: { navigate: "/path" }`. The resolved path string is passed as the sole argument. Mirrors the `navigate` prop in `ActionProvider` from the framework renderers, where it is captured in the `execute()` closure. Also available to component implementations directly via `ctx.ctx.navigate` for cases where navigation needs to be triggered outside of an action binding. **Example** `import { useNavigate } from "my-router"; const navigate = useNavigate(); renderSpec(spec, store, registry, { navigate });` Spec binding that triggers navigation: `{ "on": { "click": { "action": "doSomething", "onSuccess": { "navigate": "/dashboard" } } } }` | - |
30
- | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook for actions that declare `confirm` in their binding. Consulted by `emit()` before executing a confirm-gated action. Return (or resolve) `true` to execute, `false` to skip. Without this handler, confirm-gated actions are skipped with a `console.warn` — they never execute unconfirmed. See [ConfirmHandler](../type-aliases/ConfirmHandler.md) for the full contract. This is the headless equivalent of the `pendingConfirmation` / `confirmAction()` / `cancelAction()` flow in the framework adapters. | - |
31
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Unified error handler for component render errors and action handler rejections. Matches `RenderErrorHandler = (error: unknown, name: string) => void`. Invoked for three distinct error classes: - `(error, elementType)` — when a component renderer throws synchronously during `renderSpec` - `(error, actionName)` — when an action handler rejects during `emit()` (on-event path) - `(error, actionName)` — when an action handler rejects during a `watch` binding callback When provided, suppresses the `console.error` fallback for all three error types. Forwarded into `renderSpec` as the `onRenderError` parameter and into `DomRenderContext.onRenderError` so both `emit()` and `watch` handlers route their errors through the same channel as component render errors. **Example** `renderSpec(spec, store, registry, { onRenderError: (err, name) => { myErrorReporter.capture(err, { context: name }); }, });` | - |
32
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for inline field validation. Each function receives `(value, args?)` and returns `true` (valid) or `false` (invalid). Functions are available to component implementations via `ctx.ctx.validationFunctions` and should be passed as `customFunctions` to `runValidationCheck` / `runValidation` from `@xmachines/json-render-core`. Mirrors `customFunctions` in `ValidationProvider` from the framework renderers. The DOM renderer has no automatic `ValidationProvider` tree — validation must be invoked explicitly by component implementations. **Example** `import { runValidationCheck } from "@xmachines/json-render-core"; renderSpec(spec, store, registry, { validationFunctions: { isEven: (value) => typeof value === "number" && value % 2 === 0, phoneNumber: (value) => /^\+?[\d\s\-()]{7,}$/.test(String(value)), }, }); // Inside a ComponentFn: const MyField: ComponentFn<typeof catalog, "MyField"> = ({ ctx }) => { const result = runValidationCheck( { type: "isEven", message: "must be even" }, { value: someValue, stateModel: {}, customFunctions: ctx.ctx.validationFunctions }, ); // result.valid, result.message };` | - |
25
+ | Property | Type | Description | Defined in |
26
+ | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
27
+ | <a id="property-confirmdialog"></a> `confirmDialog?` | `boolean` | `false` turns the default confirm dialog off, for a host whose component shows the pending confirmation through `ctx.confirmation`. Without `onConfirm`, the default (`true`) shows the dialog on `document.body` for each binding with `confirm` that waits. | - |
28
+ | <a id="property-directives"></a> `directives?` | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives — user-defined `$`-prefixed dynamic values that extend the spec expression language (e.g. `{ $format: "currency", value: ... }`). Each entry is a `DirectiveDefinition` built with `defineDirective` from `@xmachines/json-render-core`. The array is converted to a `DirectiveRegistry` once per render pass and forwarded to `resolveElementProps` via `PropResolutionContext.directives`. Built-in expressions (`$state`, `$cond`, etc.) always take precedence over custom directives. Mirrors the `directives` prop on `JSONUIProvider` / `JsonUIProvider` introduced in **Json-render** 0.19. **Example** `import { defineDirective, resolvePropValue } from "@xmachines/json-render-core"; import { z } from "zod"; const formatDirective = defineDirective({ name: "$format", description: "Locale-aware number formatting.", schema: z.object({ $format: z.enum(["number", "currency"]), value: z.unknown() }), resolve(value, ctx) { const resolved = resolvePropValue(value.value, ctx); return new Intl.NumberFormat().format(resolved as number); }, }); renderSpec(spec, store, registry, { directives: [formatDirective] });` | - |
29
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Named compute functions for `{ $computed: "name", args: {...} }` prop expressions. Each function receives the resolved `args` object and returns the computed value. Forwarded directly to `resolveElementProps` via `PropResolutionContext.functions`, matching the `FunctionsContext` provider in the framework renderers. Without this option, `$computed` expressions resolve to `undefined` (no throw). **Example** `renderSpec(spec, store, registry, { functions: { fullName: (args) => `${args.first} ${args.last}`, formatCurrency: (args) => new Intl.NumberFormat().format(args.amount as number), }, });` Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | - |
30
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Programmatic navigation function. Called automatically when an action binding resolves with `onSuccess: { navigate: "/path" }`. The resolved path string is passed as the sole argument. Mirrors the `navigate` prop in `ActionProvider` from the framework renderers, where it is captured in the `execute()` closure. Also available to component implementations directly via `ctx.ctx.navigate` for cases where navigation needs to be triggered outside of an action binding. **Example** `import { useNavigate } from "my-router"; const navigate = useNavigate(); renderSpec(spec, store, registry, { navigate });` Spec binding that triggers navigation: `{ "on": { "click": { "action": "doSomething", "onSuccess": { "navigate": "/dashboard" } } } }` | - |
31
+ | <a id="property-onconfirm"></a> `onConfirm?` | [`ConfirmHandler`](../type-aliases/ConfirmHandler.md) | Confirmation hook for actions that declare `confirm` in their binding. Consulted by `emit()` before executing a confirm-gated action. Return (or resolve) `true` to execute, `false` to skip. Without this handler, the binding waits as the pending confirmation of the tree (`ctx.confirmation`), and the default confirm dialog shows it. See [ConfirmHandler](../type-aliases/ConfirmHandler.md) for the full contract. | - |
32
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`OnRenderError`](../type-aliases/OnRenderError.md) | Unified error handler, `(error, name, info)`, for every failure in code that the renderer runs. Each failure reaches it one time: - `info.kind` `"element"` — a component renderer below the root throws, an effect of it throws, or a read of its children after the pass fails - `"props"` / `"visible"` — a prop expression or the `visible` condition of an element throws; the boundary of the parent fails - `"root"` — the root fails (its component, a prop, or its `visible` condition); it has no boundary above it. The renderer shows nothing and throws nothing, also without a handler. A new version of the root renders again - `"action"` / `"watch"` — an `on` chain or a `watch` chain fails `name` is the element type (for `props` and `visible`, the type of the boundary that fails), or the action name for `action` and `watch`. `info.key`, `info.type` and `info.action` name the element and the action. A handler with two parameters still works. When provided, suppresses the `console.error` fallback for each of them. Without it, the renderer reads the handler that `defineRegistry(catalog, { onRenderError })` put on the registry, and then writes one `[json-render]` console line. A handler that throws gives its error to `reportError` one time, and no other element fails. Forwarded into `renderSpec` as the `onRenderError` parameter and into `DomRenderContext.onRenderError` so both `emit()` and `watch` handlers route their errors through the same channel as component render errors. **Example** `renderSpec(spec, store, registry, { onRenderError: (err, name, info) => { myErrorReporter.capture(err, { context: name, ...info }); }, });` | - |
33
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for inline field validation. Each function receives `(value, args?)` and returns `true` (valid) or `false` (invalid). Functions are available to component implementations via `ctx.ctx.validationFunctions` and should be passed as `customFunctions` to `runValidationCheck` / `runValidation` from `@xmachines/json-render-core`. Mirrors `customFunctions` in `ValidationProvider` from the framework renderers. The DOM renderer has no automatic `ValidationProvider` tree — validation must be invoked explicitly by component implementations. **Example** `import { runValidationCheck } from "@xmachines/json-render-core"; renderSpec(spec, store, registry, { validationFunctions: { isEven: (value) => typeof value === "number" && value % 2 === 0, phoneNumber: (value) => /^\+?[\d\s\-()]{7,}$/.test(String(value)), }, }); // Inside a ComponentFn: const MyField: ComponentFn<typeof catalog, "MyField"> = ({ ctx }) => { const result = runValidationCheck( { type: "isEven", message: "must be even" }, { value: someValue, stateModel: {}, customFunctions: ctx.ctx.validationFunctions }, ); // result.valid, result.message };` | - |
@@ -8,14 +8,17 @@ Registry of validated fields for one rendered tree.
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Modifier | Type | Description | Defined in |
12
- | ------------------------------------------------------- | ---------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
13
- | <a id="property-clear"></a> `clear` | `public` | (`path`) => `void` | Forget a field's recorded state; the registration itself survives. | - |
14
- | <a id="property-customfunctions"></a> `customFunctions` | `readonly` | `Record`\<`string`, `ValidationFunction`\> | Custom validation functions available to every check. | - |
15
- | <a id="property-fieldstates"></a> `fieldStates` | `readonly` | `Record`\<`string`, [`FieldValidationState`](FieldValidationState.md)\> | Validation state by field state path. | - |
16
- | <a id="property-registerfield"></a> `registerField` | `public` | (`path`, `config`) => `void` | Register (or update) a field's validation config. Called by component implementations during render, normally via `ctx.validation`. Registrations are reference-counted per path: two elements bound to the same state path each hold one, so one of them going away does not un-validate the other. | - |
17
- | <a id="property-releasefield"></a> `releaseField` | `public` | (`path`) => `void` | Drop one reference to a field's registration, keeping its recorded state. The registration itself goes away once the last reference is released. This is what the render context's per-element cleanup calls: an element instance releases its registrations when it unmounts or before it re-renders, and `fieldStates` survives — matching the framework ValidationProvider, whose field states outlive a re-render. | - |
18
- | <a id="property-touch"></a> `touch` | `public` | (`path`) => `void` | Mark a field as interacted with, without validating it. | - |
19
- | <a id="property-unregisterfield"></a> `unregisterField` | `public` | (`path`) => `void` | Drop a field's registration entirely, references and recorded state. | - |
20
- | <a id="property-validate"></a> `validate` | `public` | (`path`, `config?`) => `ValidationResult` | Validate one field against the live store snapshot and record the result. Uses the field's registered config unless one is passed explicitly. | - |
21
- | <a id="property-validateall"></a> `validateAll` | `public` | () => `boolean` | Validate every registered field. Returns true when all are valid. | - |
11
+ | Property | Modifier | Type | Description | Defined in |
12
+ | ------------------------------------------------------- | ---------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
13
+ | <a id="property-clear"></a> `clear` | `public` | (`path`) => `void` | Forget a field's recorded state; the registration itself survives. | - |
14
+ | <a id="property-customfunctions"></a> `customFunctions` | `readonly` | `Record`\<`string`, `ValidationFunction`\> | Custom validation functions available to every check. | - |
15
+ | <a id="property-dropreleased"></a> `dropReleased?` | `public` | () => `void` | End a pass. The registry forgets the state of each field whose last registration went away and that did not register again. It also forgets the state of a field that only new owners hold now: an element that goes and another element that registers the path in the same pass start the field fresh, as in the framework renderers, whatever the order of the two. What a new owner wrote in the pass stays, as if the field started fresh at the change: a `touch` of the new owner gives no result of the old one. A write of the old owner in the pass goes. An owner that registers again in place keeps the state. The fresh start comes when the pass ends. A component of the new element that reads `fieldStates` while it renders in that pass still reads the state of the old element. The incremental renderer then renders it again (see `onFreshPaths`), as React renders it again after the unmount of the old one. A caller that does not mark its passes with `startPass` calls it when a pass ends, for example a host that renders with `renderSpec` alone on a registry of its own. The incremental renderer and a host that uses `startPass` end a pass with the function that `startPass` returns, and not with this. The registry counts the passes by these calls, or by `startPass`: an owner that came to the path in an earlier pass is an owner from before the pass. Without the calls, no owner is from before, and the state of a field stays with its path. | - |
16
+ | <a id="property-fieldstates"></a> `fieldStates` | `readonly` | `Readonly`\<`Record`\<`string`, `ReadonlyFieldValidationState`\>\> | Validation state by field state path. The registry gives the same object until a state changes, as the state of react does. The object and each state in it are shared by every reader, so they are read-only at each level: the registry of this package freezes the object, each state, and the result of each state with its errors and its checks. | - |
17
+ | <a id="property-onfreshpaths"></a> `onFreshPaths?` | `public` | (`listener`) => () => `void` | Call `listener` with the paths whose state changed: a pass that started a field fresh for a new element that took over the path, or a write of the state, such as a `touch` or a `validateAll`. Each renderer of the registry renders the elements that hold such a path again, so they show the state of now, as React renders a component again when the state of its provider changes. A write in a pass reaches the listeners when the pass ends, and a write between two passes at once. The writes of one `validateAll` reach them together. The registry calls the listeners after the outermost pass ends, and it holds each one weakly: the caller keeps its listener while it needs the calls. An error of a listener goes to `reportError`, and the other listeners still run. Returns the function that stops the calls. | - |
18
+ | <a id="property-registerfield"></a> `registerField` | `public` | (`path`, `config`, `owner?`) => `void` | Register (or update) a field's validation config. Called by component implementations during render, normally via `ctx.validation`. Registrations are reference-counted per path: two elements bound to the same state path each hold one, so one of them going away does not un-validate the other. `owner` names the element instance that registers. For a registration through `ctx.validation`, the renderer gives the element, its type, its repeat rows, the keys and the types of the elements above it, and the named slot that holds it. Registrations that name no owner count as one owner. See [ValidationRegistry.dropReleased](#property-dropreleased) for what it changes. | - |
19
+ | <a id="property-releasefield"></a> `releaseField` | `public` | (`path`, `owner?`) => `void` | Drop one reference to a field's registration. The registration goes away once the last reference is released, and [ValidationRegistry.dropReleased](#property-dropreleased) forgets its state, unless the field registers again first. Until then `fieldStates` keeps the state, so an element that renders before the field in the same pass still reads it. This is what the render context's per-element cleanup calls: an element instance releases its registrations when it unmounts or before it re-renders. An element that renders again in place registers again in the same pass, so its state survives — matching the framework ValidationProvider, whose field states outlive a re-render and go at the last unregister. `owner` is the owner that [ValidationRegistry.registerField](#property-registerfield) got. | - |
20
+ | <a id="property-startpass"></a> `startPass?` | `public` | (`options?`) => () => `void` | Start a pass, and return the function that ends it. The incremental renderer calls it before each pass, and a host that renders with `renderSpec` before its render. A pass of a renderer that starts inside a pass ends with the outer one. A pass of the host that starts inside a pass commits the passes that run when it ends, as react commits a nested `flushSync` when it returns, and a call of the host after it sees that commit. An owner that comes to a path between two passes, for example through a late read of the children of a component, then comes before the next pass. A caller that does not call it ends and counts each pass with `dropReleased` alone, and inside a pass `dropReleased` does nothing. All the callers of one registry follow the same rule: after the first `startPass`, `dropReleased` does nothing, and the registry warns one time. An outermost pass that starts before the join of the outermost pass before it ends joins that pass, as react joins the updates of one commit. The `batch` of the pass before sets how long its join lasts (see [PassOptions](PassOptions.md)): to the next microtask for a store write, and to the end of the task, also after an `await`, for a new spec. A write of a field state, a `clear`, or a field that registers between the two passes ends the join. A write of a field state or a `clear` before the commit point of a store write does not: it is part of that commit (see the pass of a store write below). The renderers of one registry that react to one write of the store, or that a host hands new specs in one task, then run one pass. A field that moves from one renderer to the other starts fresh, whatever the order of the two. A pass that a handler of a pass queued is a new pass, as an update that a commit schedules is a new commit: its caller gives `join: false`. The incremental renderer marks the pass of a store write and the pass of a new spec. React commits a store write and a new spec after the handler that gives them, so the registry holds the effects of such a pass on the fields, a release, a new config and a fresh start, until its commit point: the next microtask, the next pass that does not join it, the bindings of a `watch`, or a field that registers between two passes. The commit point of a store write ends the join, so a pass after it starts a new commit. The commit point of a new spec keeps the join to the end of the task (see [PassOptions](PassOptions.md)). The renderer shows the store writes of the task at the commit point, in one render, as react renders the writes of one handler in one render. The commit point then does the work of the commit, it runs the effects that the components of the commit gave `ctx.effect` and the checks of the watches, and it renders the holders of the commit again, before its microtask ends. React ends the commit of a synchronous update in its microtask in the same way: it runs the effects of the commit before the renders that its layout effects start. The checks of the watches run after the effects, as react runs the effect of a child before the watch of its parent. The watches of one change see one commit. Their writes and the writes of those effects make one commit after them, and the commit point shows its store writes before its microtask ends, as react renders a store write of an effect at the end of the flush of the effects. A watch compares the store of its commit, from before the effects: when an effect writes a watched path, the watch sees the change at the commit point of that write. A `touch`, a `validate`, a `clear` or a `validateAll` before the commit point sees the fields of before the write, as in react. A write of a field state between two passes renders the holders of its path, and the registry holds the effects of that render in the same way. The incremental renderer renders them at the commit point when a store write of it waits, in the one render of its store writes, as react renders them after the handler. A render of a holder for its new config, which the end of such a pass starts, waits with it. The end of a pass of the host shows the store writes that wait, as `flushSync` of react renders the updates that wait, and it commits them with the passes that it joins. A call of the host inside such a pass sees the fields of the last commit, as a call inside the callback of `flushSync` of react does. This also holds after a store write before the pass: the end of the pass shows and commits that write too. The end of a pass of the host then runs the effects of its commit, as `flushSync` of react does: the effects that the components of the incremental renderer gave `ctx.effect`, also in a render before the pass, and then the checks of the watches. It commits their writes, and it runs the effects of those writes in the same way. The end of an outermost pass of the host ends its join, so a later pass starts a new commit. | - |
21
+ | <a id="property-touch"></a> `touch` | `public` | (`path`, `owner?`) => `void` | Mark a field as interacted with, without validating it. `owner` names the element that touches it, as for `registerField`. | - |
22
+ | <a id="property-unregisterfield"></a> `unregisterField` | `public` | (`path`) => `void` | Drop a field's registration entirely, references and recorded state. | - |
23
+ | <a id="property-validate"></a> `validate` | `public` | (`path`, `config?`, `owner?`) => `ReadonlyValidationResult` | Validate one field against the live store snapshot and record the result. Uses the field's registered config unless one is passed explicitly. `owner` names the element that validates, as for `registerField`. The result is the result of the state of the field, which every reader of `fieldStates` shares, so it is read-only at each level: the registry of this package freezes it. | - |
24
+ | <a id="property-validateall"></a> `validateAll` | `public` | () => `boolean` | Validate every registered field. Returns true when all are valid. The listeners of `onFreshPaths` hear of the new states one time, when the last field is validated, so no holder renders in the loop. | - |
@@ -18,10 +18,10 @@ Catalog-typed action function — mirrors `ActionFn<C, K>` from @xmachines/json-
18
18
 
19
19
  ## Type Parameters
20
20
 
21
- | Type Parameter |
22
- | ------------------------------------------------ |
23
- | `C` _extends_ `Catalog` |
24
- | `K` _extends_ keyof `InferCatalogActions`\<`C`\> |
21
+ | Type Parameter |
22
+ | ------------------------------------------------------------------------------ |
23
+ | <a id="type-parameter-c"></a> `C` _extends_ `Catalog` |
24
+ | <a id="type-parameter-k"></a> `K` _extends_ keyof `InferCatalogActions`\<`C`\> |
25
25
 
26
26
  ## Parameters
27
27
 
@@ -13,6 +13,6 @@ Each key is a catalog action name; each value is an `ActionFn<C, K>` for that ac
13
13
 
14
14
  ## Type Parameters
15
15
 
16
- | Type Parameter |
17
- | ----------------------- |
18
- | `C` _extends_ `Catalog` |
16
+ | Type Parameter |
17
+ | ----------------------------------------------------- |
18
+ | <a id="type-parameter-c"></a> `C` _extends_ `Catalog` |
@@ -29,9 +29,9 @@ function MyButton({ props, emit }: BaseComponentProps<{ label: string }>) {
29
29
 
30
30
  ## Type Parameters
31
31
 
32
- | Type Parameter | Default type |
33
- | --------------------------------------------- | ------------------------------- |
34
- | `P` _extends_ `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
32
+ | Type Parameter | Default type |
33
+ | --------------------------------------------------------------------------- | ------------------------------- |
34
+ | <a id="type-parameter-p"></a> `P` _extends_ `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
35
35
 
36
36
  ## Properties
37
37
 
@@ -118,7 +118,7 @@ Defined in: `@xmachines/json-render-dom`
118
118
  ### slots?
119
119
 
120
120
  ```ts
121
- optional slots?: Record<string, Node[]>;
121
+ slots?: Record<string, Node[]>;
122
122
  ```
123
123
 
124
124
  Defined in: `@xmachines/json-render-dom`
@@ -20,6 +20,6 @@ catalog defines actions, and optional when it does not.
20
20
 
21
21
  ## Type Parameters
22
22
 
23
- | Type Parameter |
24
- | ----------------------- |
25
- | `C` _extends_ `Catalog` |
23
+ | Type Parameter |
24
+ | ----------------------------------------------------- |
25
+ | <a id="type-parameter-c"></a> `C` _extends_ `Catalog` |
@@ -10,10 +10,10 @@ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  ## Type Parameters
12
12
 
13
- | Type Parameter |
14
- | --------------------------------------------------- |
15
- | `C` _extends_ `Catalog` |
16
- | `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
13
+ | Type Parameter |
14
+ | --------------------------------------------------------------------------------- |
15
+ | <a id="type-parameter-c"></a> `C` _extends_ `Catalog` |
16
+ | <a id="type-parameter-k"></a> `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
17
17
 
18
18
  ## Parameters
19
19
 
@@ -10,6 +10,6 @@ Defined in: `@xmachines/json-render-dom`
10
10
 
11
11
  ## Type Parameters
12
12
 
13
- | Type Parameter |
14
- | ----------------------- |
15
- | `C` _extends_ `Catalog` |
13
+ | Type Parameter |
14
+ | ----------------------------------------------------- |
15
+ | <a id="type-parameter-c"></a> `C` _extends_ `Catalog` |