@xmachines/docs 1.0.0-beta.55 → 1.0.0-beta.57
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.
- package/README.md +4 -4
- package/api/@xmachines/play/README.md +3 -3
- package/api/@xmachines/play/classes/NonNullableError.md +7 -7
- package/api/@xmachines/play/classes/PlayError.md +7 -7
- package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
- package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
- package/api/@xmachines/play-actor/README.md +7 -7
- package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
- package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
- package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
- package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
- package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +7 -7
- package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +8 -8
- package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
- package/api/@xmachines/play-dom/README.md +13 -19
- package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -11
- package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
- package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
- package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
- package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
- package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +12 -11
- package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -7
- package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +19 -18
- package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -6
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -13
- package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +14 -13
- package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +12 -11
- package/api/@xmachines/play-dom/type-aliases/ActionFn.md +3 -3
- package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +9 -9
- package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +3 -3
- package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +5 -5
- package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/SetState.md +3 -3
- package/api/@xmachines/play-dom/variables/schema.md +26 -20
- package/api/@xmachines/play-dom-router/README.md +4 -4
- package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
- package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
- package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-react/README.md +9 -15
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
- package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
- package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
- package/api/@xmachines/play-react/functions/Renderer.md +1 -1
- package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
- package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
- package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
- package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-react/functions/useActor.md +1 -1
- package/api/@xmachines/play-react/functions/useBoundProp.md +2 -2
- package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
- package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
- package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +13 -12
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
- package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
- package/api/@xmachines/play-react/interfaces/RendererProps.md +8 -8
- package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
- package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
- package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
- package/api/@xmachines/play-react-router/README.md +5 -5
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
- package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-router/README.md +5 -5
- package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
- package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
- package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
- package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
- package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
- package/api/@xmachines/play-router/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
- package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
- package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
- package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
- package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
- package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
- package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
- package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
- package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
- package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-signals/README.md +5 -5
- package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
- package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
- package/api/@xmachines/play-solid/README.md +13 -19
- package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
- package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-solid/functions/useAction.md +1 -1
- package/api/@xmachines/play-solid/functions/useActions.md +1 -1
- package/api/@xmachines/play-solid/functions/useActor.md +1 -1
- package/api/@xmachines/play-solid/functions/useBoundProp.md +2 -2
- package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
- package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
- package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
- package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
- package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
- package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
- package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
- package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
- package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +13 -12
- package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
- package/api/@xmachines/play-solid/interfaces/RendererProps.md +8 -8
- package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
- package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +2 -8
- package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
- package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
- package/api/@xmachines/play-solid-router/README.md +5 -5
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
- package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
- package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-svelte/README.md +26 -31
- package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
- package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
- package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
- package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
- package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
- package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
- package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
- package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
- package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
- package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/JSONUIProviderProps.md +7 -0
- package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +17 -1
- package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
- package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/README.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-sveltekit-router/README.md +6 -6
- package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/README.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/README.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-vue/README.md +12 -18
- package/api/@xmachines/play-vue/functions/defineRegistry.md +3 -3
- package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
- package/api/@xmachines/play-vue/functions/useActor.md +1 -1
- package/api/@xmachines/play-vue/functions/useBoundProp.md +2 -2
- package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
- package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
- package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +12 -11
- package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
- package/api/@xmachines/play-vue/interfaces/RendererProps.md +8 -8
- package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
- package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
- package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/JSONUIProvider.md +10 -1
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-vue/variables/Renderer.md +10 -1
- package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
- package/api/@xmachines/play-vue-router/README.md +4 -4
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-xstate/README.md +3 -3
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +31 -31
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
- package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
- package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
- package/api/@xmachines/shared/README.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +3 -3
- package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
- package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
- package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
- package/api/llms.txt +2 -2
- package/contributing/architecture.md +9 -9
- package/contributing/configuration.md +12 -12
- package/contributing/deployment.md +9 -9
- package/contributing/development.md +43 -43
- package/contributing/testing.md +15 -15
- package/examples/@xmachines/play-dom-demo/README.md +12 -12
- package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
- package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
- package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-dom-router-demo/README.md +12 -12
- package/examples/@xmachines/play-react-demo/README.md +13 -13
- package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
- package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-react-router-demo/README.md +12 -12
- package/examples/@xmachines/play-solid-demo/README.md +12 -12
- package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
- package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-solid-router-demo/README.md +12 -12
- package/examples/@xmachines/play-svelte-demo/README.md +12 -12
- package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-spa-router-demo/README.md +12 -12
- package/examples/@xmachines/play-sveltekit-router-demo/README.md +12 -12
- package/examples/@xmachines/play-tanstack-react-router-demo/README.md +12 -12
- package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +12 -12
- package/examples/@xmachines/play-vue-demo/README.md +14 -14
- package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-vue-router-demo/README.md +12 -12
- package/examples/README.md +3 -3
- package/examples/form-validation.md +2 -2
- package/guides/getting-started.md +35 -42
- package/guides/signals.md +2 -2
- package/guides/state-machines.md +1 -1
- package/package.json +2 -2
- package/rfc/play.md +16 -16
|
@@ -19,11 +19,11 @@ Vue 3 renderer demo for [`@xmachines/play-vue`](../../../api/@xmachines/play-vue
|
|
|
19
19
|
From the repository root:
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
|
|
23
|
-
|
|
22
|
+
pnpm install
|
|
23
|
+
pnpm --filter @xmachines/play-vue-demo run dev
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Then open `http://localhost:
|
|
26
|
+
Then open `http://localhost:3004`.
|
|
27
27
|
|
|
28
28
|
## Step-by-Step Code Flow
|
|
29
29
|
|
|
@@ -53,7 +53,7 @@ app.mount("#app");
|
|
|
53
53
|
<!-- src/App.vue -->
|
|
54
54
|
<script setup lang="ts">
|
|
55
55
|
import type { ComponentsMap } from "@xmachines/play-vue";
|
|
56
|
-
import type { ActionFn } from "@json-render
|
|
56
|
+
import type { ActionFn } from "@xmachines/json-render-vue";
|
|
57
57
|
|
|
58
58
|
const typedActor = assertNonNullable(inject<AuthActor>("actor"), "actor");
|
|
59
59
|
|
|
@@ -115,7 +115,7 @@ const registryResult = computed(() =>
|
|
|
115
115
|
|
|
116
116
|
- `src/main.ts` - actor creation/start and Vue app mount with actor injection
|
|
117
117
|
- `src/App.vue` - typed `ComponentsMap` declaration, registry construction, and `PlayUIProvider` + `PlayRenderer` composition
|
|
118
|
-
- `src/catalog.ts` - `authCatalog` built via `defineCatalog` with the `@json-render
|
|
118
|
+
- `src/catalog.ts` - `authCatalog` built via `defineCatalog` with the `@xmachines/json-render-vue` schema
|
|
119
119
|
- `src/components/` - demo view components bound to catalog component keys (Home, Login, Dashboard, Profile, etc.)
|
|
120
120
|
- `src/index.ts` - re-exports all components and catalog for library-pattern testing
|
|
121
121
|
- `test/library-pattern.test.ts` - architecture boundary and invariant assertions
|
|
@@ -149,21 +149,21 @@ Watcher notifications are one-shot. Cleanup is explicit: `actor.stop()` is calle
|
|
|
149
149
|
|
|
150
150
|
These commands are defined in `package.json`:
|
|
151
151
|
|
|
152
|
-
| Command
|
|
153
|
-
|
|
|
154
|
-
| `
|
|
155
|
-
| `
|
|
156
|
-
| `
|
|
157
|
-
| `
|
|
158
|
-
| `
|
|
152
|
+
| Command | Description |
|
|
153
|
+
| --------------------------------------------------------- | ---------------------------------------------- |
|
|
154
|
+
| `pnpm --filter @xmachines/play-vue-demo run dev` | Start Vite dev server (http://localhost:3004/) |
|
|
155
|
+
| `pnpm --filter @xmachines/play-vue-demo run build` | Build production bundle |
|
|
156
|
+
| `pnpm --filter @xmachines/play-vue-demo run preview` | Preview built bundle |
|
|
157
|
+
| `pnpm --filter @xmachines/play-vue-demo run test` | Run Vitest test suite |
|
|
158
|
+
| `pnpm --filter @xmachines/play-vue-demo run test:browser` | Run browser-focused Vitest suite |
|
|
159
159
|
|
|
160
160
|
## Verification
|
|
161
161
|
|
|
162
162
|
Use these checks to validate README claims against the current demo implementation:
|
|
163
163
|
|
|
164
164
|
```bash
|
|
165
|
-
|
|
166
|
-
|
|
165
|
+
pnpm --filter @xmachines/play-vue-demo run test
|
|
166
|
+
pnpm --filter @xmachines/play-vue-demo run test:browser
|
|
167
167
|
```
|
|
168
168
|
|
|
169
169
|
Expected result: library-pattern invariant tests pass and the browser renderer suite completes.
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
type AuthCatalog = typeof authCatalog;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-vue/examples/demo/src/catalog.ts#L6)
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
const App: DefineComponent<{}, {}, unknown>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-vue/examples/demo/src/env.d.ts#L5)
|
|
@@ -169,4 +169,4 @@ const authCatalog: Catalog<
|
|
|
169
169
|
>;
|
|
170
170
|
```
|
|
171
171
|
|
|
172
|
-
Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
172
|
+
Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.57/packages/play-vue/examples/demo/src/catalog.ts#L5)
|
|
@@ -19,11 +19,11 @@ Vue Router integration demo for the XMachines Play architecture using Vue Compos
|
|
|
19
19
|
From the repository root:
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
|
|
23
|
-
|
|
22
|
+
pnpm install
|
|
23
|
+
pnpm --filter @xmachines/play-vue-router-demo run dev
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Then open `http://localhost:
|
|
26
|
+
Then open `http://localhost:3010`.
|
|
27
27
|
|
|
28
28
|
## Step-by-Step Code Flow
|
|
29
29
|
|
|
@@ -114,21 +114,21 @@ Vue Router integration remains passive infrastructure. `RouterBridgeBase` owns s
|
|
|
114
114
|
|
|
115
115
|
These commands are defined in `package.json`:
|
|
116
116
|
|
|
117
|
-
| Command
|
|
118
|
-
|
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `
|
|
122
|
-
| `
|
|
123
|
-
| `
|
|
117
|
+
| Command | Description |
|
|
118
|
+
| ---------------------------------------------------------------- | ---------------------------------------------- |
|
|
119
|
+
| `pnpm --filter @xmachines/play-vue-router-demo run dev` | Start Vite dev server (http://localhost:3010/) |
|
|
120
|
+
| `pnpm --filter @xmachines/play-vue-router-demo run build` | Build production bundle |
|
|
121
|
+
| `pnpm --filter @xmachines/play-vue-router-demo run preview` | Preview built bundle |
|
|
122
|
+
| `pnpm --filter @xmachines/play-vue-router-demo run test` | Run Vitest test suite |
|
|
123
|
+
| `pnpm --filter @xmachines/play-vue-router-demo run test:browser` | Run browser-focused Vitest suite |
|
|
124
124
|
|
|
125
125
|
## Verification
|
|
126
126
|
|
|
127
127
|
Use these checks to validate README claims against the current demo implementation:
|
|
128
128
|
|
|
129
129
|
```bash
|
|
130
|
-
|
|
131
|
-
|
|
130
|
+
pnpm --filter @xmachines/play-vue-router-demo run test
|
|
131
|
+
pnpm --filter @xmachines/play-vue-router-demo run test:browser
|
|
132
132
|
```
|
|
133
133
|
|
|
134
134
|
Expected result: reactivity integration tests and the browser shared-demo suite both pass, confirming login/logout transitions update both view and URL correctly.
|
package/examples/README.md
CHANGED
|
@@ -58,16 +58,16 @@ The conceptual examples in this directory are TypeScript snippets. To run them:
|
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
60
|
# Install dependencies (from the monorepo root)
|
|
61
|
-
|
|
61
|
+
pnpm add @xmachines/play-xstate @xmachines/play-actor @xmachines/play-signals xstate
|
|
62
62
|
|
|
63
63
|
# Run with tsx
|
|
64
|
-
|
|
64
|
+
pnpm dlx tsx my-example.ts
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
To run a complete demo application, use the workspace package name:
|
|
68
68
|
|
|
69
69
|
```bash
|
|
70
|
-
|
|
70
|
+
pnpm --filter @xmachines/play-dom-router-demo run dev
|
|
71
71
|
```
|
|
72
72
|
|
|
73
73
|
## Key Packages
|
|
@@ -184,7 +184,7 @@ actor.stop();
|
|
|
184
184
|
|
|
185
185
|
## `$bindState` and `$state` Pattern
|
|
186
186
|
|
|
187
|
-
`meta.view` uses the `@json-render
|
|
187
|
+
`meta.view` uses the `@xmachines/json-render-core` spec format (`PlaySpec`). Two special directives wire the component to a local per-state state store:
|
|
188
188
|
|
|
189
189
|
| Directive | Direction | Usage |
|
|
190
190
|
| ----------------------------- | --------- | ----------------------------------------------------------- |
|
|
@@ -229,7 +229,7 @@ The machine spec above defines view structure — but nothing renders until you
|
|
|
229
229
|
|
|
230
230
|
```typescript
|
|
231
231
|
import { createRenderer, schema } from "@xmachines/play-dom";
|
|
232
|
-
import { defineCatalog } from "@json-render
|
|
232
|
+
import { defineCatalog } from "@xmachines/json-render-core";
|
|
233
233
|
import { z } from "zod";
|
|
234
234
|
import type { ComponentFn } from "@xmachines/play-dom";
|
|
235
235
|
|
|
@@ -20,13 +20,13 @@ Jump to the section that applies to you:
|
|
|
20
20
|
|
|
21
21
|
You need the following installed before cloning the repository:
|
|
22
22
|
|
|
23
|
-
| Requirement | Version
|
|
24
|
-
| ----------- |
|
|
25
|
-
| Node.js | `>= 22.0.0`
|
|
26
|
-
|
|
|
27
|
-
| Git | any recent version
|
|
23
|
+
| Requirement | Version | Notes |
|
|
24
|
+
| ----------- | ------------------ | --------------------------------------------------------------------------------------------------------------------- |
|
|
25
|
+
| Node.js | `>= 22.0.0` | Specified in all `package.json` `engines` fields |
|
|
26
|
+
| pnpm | via corepack | Enable with `corepack enable`; the version is pinned by the `packageManager` field. The project uses pnpm workspaces. |
|
|
27
|
+
| Git | any recent version | Conventional commit format is enforced by CI |
|
|
28
28
|
|
|
29
|
-
No global TypeScript install is needed — it is installed as a dev dependency via `
|
|
29
|
+
No global TypeScript install is needed — it is installed as a dev dependency via `pnpm install --frozen-lockfile`.
|
|
30
30
|
|
|
31
31
|
> **Node.js version manager tip:** If you manage multiple Node versions with `nvm` or `fnm`, install and activate Node 22 before proceeding.
|
|
32
32
|
|
|
@@ -41,18 +41,19 @@ cd xmachines-js
|
|
|
41
41
|
|
|
42
42
|
#### 2. Install dependencies
|
|
43
43
|
|
|
44
|
-
Always use `
|
|
44
|
+
Always use `pnpm install --frozen-lockfile` (not `pnpm install`) to respect the lockfile exactly:
|
|
45
45
|
|
|
46
46
|
```bash
|
|
47
|
-
|
|
47
|
+
corepack enable
|
|
48
|
+
pnpm install --frozen-lockfile
|
|
48
49
|
```
|
|
49
50
|
|
|
50
|
-
This installs
|
|
51
|
+
This installs the exact versions recorded in the lockfile for all workspace packages.
|
|
51
52
|
|
|
52
53
|
#### 3. Build all packages
|
|
53
54
|
|
|
54
55
|
```bash
|
|
55
|
-
|
|
56
|
+
pnpm run build
|
|
56
57
|
```
|
|
57
58
|
|
|
58
59
|
The root `tsc --build` command uses TypeScript project references to compile all packages in correct dependency order. Build outputs go to each package's `dist/` directory (gitignored).
|
|
@@ -62,7 +63,7 @@ The root `tsc --build` command uses TypeScript project references to compile all
|
|
|
62
63
|
Verify your setup is working end-to-end:
|
|
63
64
|
|
|
64
65
|
```bash
|
|
65
|
-
|
|
66
|
+
pnpm test
|
|
66
67
|
```
|
|
67
68
|
|
|
68
69
|
All tests should pass on a freshly cloned and built repository. If they do, your environment is correctly configured.
|
|
@@ -76,7 +77,7 @@ A fully configured dev container is provided at `.devcontainer/`. It uses Docker
|
|
|
76
77
|
**CLI:**
|
|
77
78
|
|
|
78
79
|
```bash
|
|
79
|
-
|
|
80
|
+
pnpm run devcontainer:up
|
|
80
81
|
```
|
|
81
82
|
|
|
82
83
|
To customize the container, copy the sample env file:
|
|
@@ -98,20 +99,12 @@ Available variables:
|
|
|
98
99
|
|
|
99
100
|
The test suite relies on TypeScript path aliases that resolve to source files. If aliases are not resolving:
|
|
100
101
|
|
|
101
|
-
1. Run `
|
|
102
|
+
1. Run `pnpm run build` first — some packages need their `dist/` present even in development.
|
|
102
103
|
2. Confirm your package's `vitest.config.ts` uses `defineXmVitestConfig` from `@xmachines/shared/vitest`, which automatically configures the `@xmachines/*` path aliases.
|
|
103
104
|
|
|
104
105
|
#### TypeScript errors about missing types after adding a dependency
|
|
105
106
|
|
|
106
|
-
Run `
|
|
107
|
-
|
|
108
|
-
#### `patch-package` errors during install
|
|
109
|
-
|
|
110
|
-
The patches in `patches/` are version-specific. If you updated a `@json-render` package, regenerate the patch:
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
npx patch-package <package-name>
|
|
114
|
-
```
|
|
107
|
+
Run `pnpm install --frozen-lockfile` again to ensure all types are installed. If you added a workspace-local dependency, also add the correct `references` entry in the package's `tsconfig.base.json`.
|
|
115
108
|
|
|
116
109
|
#### Lint errors about import extensions
|
|
117
110
|
|
|
@@ -150,7 +143,7 @@ This section covers installing XMachines packages into your own application and
|
|
|
150
143
|
### Prerequisites
|
|
151
144
|
|
|
152
145
|
- **Node.js** `>= 22.0.0`
|
|
153
|
-
- **
|
|
146
|
+
- **pnpm** via corepack (`corepack enable`)
|
|
154
147
|
- **TypeScript** `>= 5.7` (strict mode recommended)
|
|
155
148
|
- **XState** `v5` (required peer dependency for [`@xmachines/play-xstate`](../api/@xmachines/play-xstate/README.md))
|
|
156
149
|
|
|
@@ -163,7 +156,7 @@ All packages are ES modules (`"type": "module"`). Use `.js` extensions in all Ty
|
|
|
163
156
|
Every XMachines application needs these three packages plus XState:
|
|
164
157
|
|
|
165
158
|
```bash
|
|
166
|
-
|
|
159
|
+
pnpm add xstate @xmachines/play-xstate @xmachines/play-actor @xmachines/play-signals
|
|
167
160
|
```
|
|
168
161
|
|
|
169
162
|
| Package | Role |
|
|
@@ -177,26 +170,26 @@ npm install xstate @xmachines/play-xstate @xmachines/play-actor @xmachines/play-
|
|
|
177
170
|
|
|
178
171
|
```bash
|
|
179
172
|
# Provider pattern (framework-integrated routers)
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
173
|
+
pnpm add @xmachines/play-tanstack-react-router # TanStack Router (React)
|
|
174
|
+
pnpm add @xmachines/play-tanstack-solid-router # TanStack Router (SolidJS)
|
|
175
|
+
pnpm add @xmachines/play-react-router # React Router v7
|
|
176
|
+
pnpm add @xmachines/play-vue-router # Vue Router 4.x/5.x
|
|
177
|
+
pnpm add @xmachines/play-solid-router # SolidJS Router
|
|
185
178
|
|
|
186
179
|
# connectRouter pattern (framework-agnostic)
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
180
|
+
pnpm add @xmachines/play-dom-router # Vanilla DOM (Browser History API)
|
|
181
|
+
pnpm add @xmachines/play-sveltekit-router # SvelteKit
|
|
182
|
+
pnpm add @xmachines/play-svelte-spa-router # Svelte SPA Router
|
|
190
183
|
```
|
|
191
184
|
|
|
192
185
|
#### Step 3: Install a view renderer (pick one)
|
|
193
186
|
|
|
194
187
|
```bash
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
188
|
+
pnpm add @xmachines/play-react # React 18/19
|
|
189
|
+
pnpm add @xmachines/play-vue # Vue 3
|
|
190
|
+
pnpm add @xmachines/play-solid # SolidJS
|
|
191
|
+
pnpm add @xmachines/play-svelte # Svelte 5
|
|
192
|
+
pnpm add @xmachines/play-dom # Vanilla DOM
|
|
200
193
|
```
|
|
201
194
|
|
|
202
195
|
---
|
|
@@ -448,7 +441,7 @@ View renderers map `meta.view` specs from your machine states to real UI compone
|
|
|
448
441
|
|
|
449
442
|
```tsx
|
|
450
443
|
import { PlayUIProvider, PlayRenderer, defineRegistry } from "@xmachines/play-react";
|
|
451
|
-
import { defineCatalog } from "@json-render
|
|
444
|
+
import { defineCatalog } from "@xmachines/json-render-core";
|
|
452
445
|
import { schema } from "@xmachines/play-react";
|
|
453
446
|
import { z } from "zod";
|
|
454
447
|
|
|
@@ -495,7 +488,7 @@ function App() {
|
|
|
495
488
|
|
|
496
489
|
<script setup lang="ts">
|
|
497
490
|
import { PlayUIProvider, PlayRenderer, defineRegistry } from "@xmachines/play-vue";
|
|
498
|
-
import { defineCatalog } from "@json-render
|
|
491
|
+
import { defineCatalog } from "@xmachines/json-render-core";
|
|
499
492
|
import { schema } from "@xmachines/play-vue";
|
|
500
493
|
import { z } from "zod";
|
|
501
494
|
|
|
@@ -527,7 +520,7 @@ function App() {
|
|
|
527
520
|
|
|
528
521
|
```tsx
|
|
529
522
|
import { PlayUIProvider, PlayRenderer, defineRegistry } from "@xmachines/play-solid";
|
|
530
|
-
import { defineCatalog } from "@json-render
|
|
523
|
+
import { defineCatalog } from "@xmachines/json-render-core";
|
|
531
524
|
import { schema } from "@xmachines/play-solid";
|
|
532
525
|
import { z } from "zod";
|
|
533
526
|
|
|
@@ -566,7 +559,7 @@ function App() {
|
|
|
566
559
|
|
|
567
560
|
```typescript
|
|
568
561
|
import { createPlayUI, defineRegistry, schema } from "@xmachines/play-dom";
|
|
569
|
-
import { defineCatalog } from "@json-render
|
|
562
|
+
import { defineCatalog } from "@xmachines/json-render-core";
|
|
570
563
|
import { z } from "zod";
|
|
571
564
|
import type { ComponentFn } from "@xmachines/play-dom";
|
|
572
565
|
|
|
@@ -701,7 +694,7 @@ node --version
|
|
|
701
694
|
| [`extractMachineRoutes`](../api/@xmachines/play-router/functions/extractMachineRoutes.md) | Extracts a `RouteTree` from a state machine — used by framework-integrated router adapters |
|
|
702
695
|
| [`createRouteMapFromTree`](../api/@xmachines/play-router/functions/createRouteMapFromTree.md) | Builds a `RouteMap` from a `RouteTree` for bidirectional state ID ↔ URL lookups |
|
|
703
696
|
| [`connectRouter`](../api/@xmachines/play-dom-router/functions/connectRouter.md) | Connects a vanilla DOM router to an actor — returns a disconnect cleanup function |
|
|
704
|
-
| [`PlayRouterProvider`](../api/@xmachines/play-tanstack-react-router/
|
|
697
|
+
| [`PlayRouterProvider`](../api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md) | React component that connects a `PlayerActor` to TanStack React Router |
|
|
705
698
|
|
|
706
699
|
---
|
|
707
700
|
|
package/guides/signals.md
CHANGED
|
@@ -158,8 +158,8 @@ Failing to clean up watchers causes memory leaks and stale callbacks firing afte
|
|
|
158
158
|
|
|
159
159
|
## See also
|
|
160
160
|
|
|
161
|
-
- [Understanding the Actor Model](
|
|
162
|
-
- [Understanding State Machines](
|
|
161
|
+
- [Understanding the Actor Model](actor-model.md) — why the actor owns all signal writes
|
|
162
|
+
- [Understanding State Machines](state-machines.md) — how state nodes produce the metadata that signals derive
|
|
163
163
|
- [Getting Started](getting-started.md) — hands-on walkthrough using signals to observe an actor
|
|
164
164
|
- [@xmachines/play-signals](../api/@xmachines/play-signals/README.md) — API reference
|
|
165
165
|
- [Play RFC](../rfc/play.md) — architectural specification
|
package/guides/state-machines.md
CHANGED
|
@@ -124,7 +124,7 @@ const appMachine = setup({
|
|
|
124
124
|
|
|
125
125
|
`meta.route` is a string path. When the machine enters a state, `actor.currentRoute` (a `Signal.Computed`) derives this path and emits it. The router bridge reads it and updates the URL.
|
|
126
126
|
|
|
127
|
-
`meta.view` is a [`PlaySpec`](../api/@xmachines/play-actor/interfaces/PlaySpec.md) — a `@json-render
|
|
127
|
+
`meta.view` is a [`PlaySpec`](../api/@xmachines/play-actor/interfaces/PlaySpec.md) — a `@xmachines/json-render-core` spec object describing what to render. Use `typedSpec<TContext>(...)` from [`@xmachines/play-actor`](../api/@xmachines/play-actor/README.md) to validate `contextProps` entries at compile time. When the machine enters a state, `actor.currentView` is updated with this spec. The renderer reads it and projects it through framework components.
|
|
128
128
|
|
|
129
129
|
**The machine is the single source of truth for both routing and views.** There is no separate route configuration file. There is no switch statement in a component deciding what to render based on the URL. The state machine encodes all of that.
|
|
130
130
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xmachines/docs",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.57",
|
|
4
4
|
"description": "Documentation for XMachines",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"documentation",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@testing-library/jest-dom": "^6.9.1",
|
|
56
56
|
"@types/node": "^25.6.0",
|
|
57
|
-
"@xmachines/shared": "1.0.0-beta.
|
|
57
|
+
"@xmachines/shared": "1.0.0-beta.57",
|
|
58
58
|
"oxfmt": "^0.47.0",
|
|
59
59
|
"oxlint": "^1.62.0",
|
|
60
60
|
"typedoc": "^0.28.19",
|
package/rfc/play.md
CHANGED
|
@@ -143,7 +143,7 @@ The base class requires only two abstract members: **reactive state** and **type
|
|
|
143
143
|
```ts
|
|
144
144
|
import { Actor, type AnyActorLogic, type EventObject } from "xstate";
|
|
145
145
|
import type { Signal } from "@xmachines/play-signals";
|
|
146
|
-
import type { Spec } from "@json-render
|
|
146
|
+
import type { Spec } from "@xmachines/json-render-core";
|
|
147
147
|
|
|
148
148
|
// Optional capability: Routing
|
|
149
149
|
export interface Routable {
|
|
@@ -177,7 +177,7 @@ export abstract class AbstractActor<
|
|
|
177
177
|
|
|
178
178
|
1. Not all actors need routing (e.g. embedded sub-actors)
|
|
179
179
|
2. Not all actors need view rendering (e.g. background logic actors)
|
|
180
|
-
3. Catalog/schema concerns are handled by the renderer layer (`@json-render
|
|
180
|
+
3. Catalog/schema concerns are handled by the renderer layer (`@xmachines/json-render-core`), not the actor
|
|
181
181
|
|
|
182
182
|
### 5.2 Logic Layer
|
|
183
183
|
|
|
@@ -231,7 +231,7 @@ class PlayerActor<TMachine extends AnyStateMachine>
|
|
|
231
231
|
}
|
|
232
232
|
```
|
|
233
233
|
|
|
234
|
-
**Design Rationale:** The original design passed a `catalog` to `definePlayer` and returned `{ create, catalog }`. The implementation decoupled catalogs entirely — component schemas are defined via `@json-render
|
|
234
|
+
**Design Rationale:** The original design passed a `catalog` to `definePlayer` and returned `{ create, catalog }`. The implementation decoupled catalogs entirely — component schemas are defined via `@xmachines/json-render-core`'s `defineCatalog` and bound to renderers via `defineRegistry`, not to actors. This means a single actor can be rendered by different component libraries without change.
|
|
235
235
|
|
|
236
236
|
### 5.3 Router Layer
|
|
237
237
|
|
|
@@ -295,12 +295,12 @@ Each adapter extends `RouterBridgeBase` and implements the three abstract method
|
|
|
295
295
|
|
|
296
296
|
Each view renderer provides a `PlayRenderer` component that passively observes the actor's `currentView` signal and projects the JSON spec into framework-native components via `@json-render`.
|
|
297
297
|
|
|
298
|
-
| Package | Framework | JSON-Render Backend
|
|
299
|
-
| ----------------------- | ----------- |
|
|
300
|
-
| `@xmachines/play-react` | React | `@json-render
|
|
301
|
-
| `@xmachines/play-vue` | Vue 3 | `@json-render
|
|
302
|
-
| `@xmachines/play-solid` | SolidJS | `@json-render
|
|
303
|
-
| `@xmachines/play-dom` | Vanilla DOM | `@json-render
|
|
298
|
+
| Package | Framework | JSON-Render Backend |
|
|
299
|
+
| ----------------------- | ----------- | ------------------------------ |
|
|
300
|
+
| `@xmachines/play-react` | React | `@xmachines/json-render-react` |
|
|
301
|
+
| `@xmachines/play-vue` | Vue 3 | `@xmachines/json-render-vue` |
|
|
302
|
+
| `@xmachines/play-solid` | SolidJS | `@xmachines/json-render-solid` |
|
|
303
|
+
| `@xmachines/play-dom` | Vanilla DOM | `@xmachines/json-render-core` |
|
|
304
304
|
|
|
305
305
|
**Shared Architecture (all renderers):**
|
|
306
306
|
|
|
@@ -337,7 +337,7 @@ export { useActor } from "./useActor";
|
|
|
337
337
|
// Error handling
|
|
338
338
|
export { PlayErrorBoundary } from "./PlayErrorBoundary";
|
|
339
339
|
|
|
340
|
-
// Re-exports from @json-render
|
|
340
|
+
// Re-exports from @xmachines/json-render-react
|
|
341
341
|
export {
|
|
342
342
|
defineRegistry,
|
|
343
343
|
JSONUIProvider,
|
|
@@ -346,19 +346,19 @@ export {
|
|
|
346
346
|
VisibilityProvider,
|
|
347
347
|
ValidationProvider,
|
|
348
348
|
Renderer,
|
|
349
|
-
} from "@json-render
|
|
349
|
+
} from "@xmachines/json-render-react";
|
|
350
350
|
```
|
|
351
351
|
|
|
352
|
-
**Design Rationale:** `PlayRenderer` is now a **zero-prop leaf component** — it reads view context from the enclosing `ActorProvider` via `usePlayView()`. All mount-time concerns (actor bridging, signal subscription, store lifecycle, `onRenderError` injection) are centralised in `ActorProvider`. `PlayUIProvider` is the batteries-included composite that wraps `ActorProvider` + `JSONUIProvider` with a handler bridge. This mirrors the provider/renderer split in `@json-render
|
|
352
|
+
**Design Rationale:** `PlayRenderer` is now a **zero-prop leaf component** — it reads view context from the enclosing `ActorProvider` via `usePlayView()`. All mount-time concerns (actor bridging, signal subscription, store lifecycle, `onRenderError` injection) are centralised in `ActorProvider`. `PlayUIProvider` is the batteries-included composite that wraps `ActorProvider` + `JSONUIProvider` with a handler bridge. This mirrors the provider/renderer split in `@xmachines/json-render-*` and makes the separation of concerns explicit.
|
|
353
353
|
|
|
354
354
|
### 5.5 Schema Layer (External)
|
|
355
355
|
|
|
356
|
-
Component schemas and UI vocabularies are defined via `@json-render
|
|
356
|
+
Component schemas and UI vocabularies are defined via `@xmachines/json-render-core`, an external package not in the `@xmachines` scope.
|
|
357
357
|
|
|
358
358
|
- `defineCatalog` — Defines available components and prop schemas (via Zod)
|
|
359
|
-
- `defineRegistry` — Binds a catalog to framework-specific component implementations (available from each `@json-render
|
|
359
|
+
- `defineRegistry` — Binds a catalog to framework-specific component implementations (available from each `@xmachines/json-render-*` framework package)
|
|
360
360
|
|
|
361
|
-
The original RFC proposed an `@xmachines/play-ui` package for this purpose. The implementation delegates to `@json-render
|
|
361
|
+
The original RFC proposed an `@xmachines/play-ui` package for this purpose. The implementation delegates to `@xmachines/json-render-core` instead, which provides the same functionality with broader ecosystem support.
|
|
362
362
|
|
|
363
363
|
---
|
|
364
364
|
|
|
@@ -369,7 +369,7 @@ The original RFC proposed an `@xmachines/play-ui` package for this purpose. The
|
|
|
369
369
|
Defines the **UI vocabulary** — available components and their prop schemas. No framework code.
|
|
370
370
|
|
|
371
371
|
```ts
|
|
372
|
-
import { defineCatalog, z } from "@json-render
|
|
372
|
+
import { defineCatalog, z } from "@xmachines/json-render-core";
|
|
373
373
|
|
|
374
374
|
export const catalog = defineCatalog({
|
|
375
375
|
components: {
|