@xmachines/docs 1.0.0-beta.43 → 1.0.0-beta.45
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/api/@xmachines/play/README.md +5 -5
- package/api/@xmachines/play/classes/NonNullableError.md +5 -5
- package/api/@xmachines/play/classes/PlayError.md +5 -5
- package/api/@xmachines/play/functions/assertNonNullable.md +2 -2
- package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
- package/api/@xmachines/play-actor/README.md +7 -7
- package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
- package/api/@xmachines/play-actor/functions/typedSpec.md +2 -2
- package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +6 -6
- package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +6 -6
- package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
- package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
- package/api/@xmachines/play-dom/README.md +3 -2
- package/api/@xmachines/play-dom/classes/PlayRenderer.md +5 -5
- package/api/@xmachines/play-dom/functions/connectRenderer.md +2 -2
- package/api/@xmachines/play-dom/functions/createPlayUI.md +2 -2
- package/api/@xmachines/play-dom/functions/createRenderer.md +2 -2
- package/api/@xmachines/play-dom/functions/defineRegistry.md +2 -2
- package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
- package/api/@xmachines/play-dom/interfaces/ComponentContext.md +8 -8
- package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +14 -14
- package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
- package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +5 -5
- package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -13
- package/api/@xmachines/play-dom/interfaces/EventHandle.md +5 -5
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +4 -4
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
- package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
- package/api/@xmachines/play-dom/type-aliases/ActionFn.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/Actions.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +8 -8
- package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +3 -3
- package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DomSchema.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/MountFn.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/SetState.md +2 -2
- package/api/@xmachines/play-dom/variables/schema.md +2 -2
- package/api/@xmachines/play-dom-router/README.md +13 -11
- package/api/@xmachines/play-dom-router/functions/connectRouter.md +2 -2
- package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +2 -2
- package/api/@xmachines/play-dom-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-dom-router/functions/createRouter.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
- package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +15 -15
- package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
- package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-react/README.md +10 -4
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
- 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 +2 -2
- package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
- package/api/@xmachines/play-react/functions/usePlayView.md +2 -2
- package/api/@xmachines/play-react/functions/useSignalEffect.md +2 -2
- package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +9 -9
- package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +5 -5
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
- 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 +6 -6
- package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-react/type-aliases/PlayActor.md +2 -2
- package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-react/variables/ActorProvider.md +2 -2
- package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-react/variables/PlayUIProvider.md +2 -2
- package/api/@xmachines/play-react-router/README.md +13 -7
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -30
- package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-react-router/functions/createRouteMap.md +25 -7
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +12 -11
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +8 -8
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-router/README.md +14 -13
- package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +38 -34
- package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
- package/api/@xmachines/play-router/functions/buildRouteTree.md +2 -2
- package/api/@xmachines/play-router/functions/createRouteMap.md +22 -36
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +12 -11
- package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/extractQuery.md +2 -2
- package/api/@xmachines/play-router/functions/extractRouteParams.md +2 -2
- package/api/@xmachines/play-router/functions/findRouteById.md +2 -2
- package/api/@xmachines/play-router/functions/findRouteByPath.md +2 -2
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/isRouteReachable.md +2 -2
- package/api/@xmachines/play-router/functions/machineToGraph.md +2 -2
- package/api/@xmachines/play-router/functions/routeExists.md +2 -2
- package/api/@xmachines/play-router/functions/sanitizePathname.md +2 -2
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +2 -2
- package/api/@xmachines/play-router/functions/validateStateExists.md +2 -2
- package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +5 -5
- package/api/@xmachines/play-router/interfaces/LocationLike.md +4 -4
- package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +4 -4
- package/api/@xmachines/play-router/interfaces/MachineNodeData.md +6 -6
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
- package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteMatch.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteMatcher.md +9 -9
- package/api/@xmachines/play-router/interfaces/RouteNode.md +13 -13
- package/api/@xmachines/play-router/interfaces/RouteObject.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-router/interfaces/WindowLike.md +4 -4
- package/api/@xmachines/play-router/type-aliases/MachineGraph.md +2 -2
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
- package/api/@xmachines/play-signals/README.md +3 -3
- package/api/@xmachines/play-signals/functions/watchSignal.md +2 -2
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalState.md +4 -4
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +5 -5
- package/api/@xmachines/play-signals/namespaces/Signal/README.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +1 -1
- 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 +2 -2
- package/api/@xmachines/play-solid/README.md +11 -5
- 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 +2 -2
- package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
- 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 +2 -2
- 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 +9 -9
- 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 +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
- 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 +6 -6
- package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/PlayActor.md +2 -2
- 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 +2 -2
- package/api/@xmachines/play-solid/variables/ActorProvider.md +2 -2
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-solid/variables/PlayUIProvider.md +2 -2
- package/api/@xmachines/play-solid-router/README.md +18 -13
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +35 -31
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +5 -5
- package/api/@xmachines/play-svelte/README.md +9 -2
- 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 +2 -2
- package/api/@xmachines/play-svelte/functions/setActorContext.md +2 -2
- package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +13 -9
- 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 +5 -5
- package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
- package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +6 -6
- 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/ComponentFn.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +2 -2
- package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -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 +7 -1
- package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +2 -2
- package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-sveltekit-router/README.md +8 -2
- package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +2 -2
- package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/README.md +15 -9
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +34 -30
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +25 -7
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +12 -11
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +8 -8
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/README.md +17 -11
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -31
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-vue/README.md +12 -6
- package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
- package/api/@xmachines/play-vue/functions/getPlayViewContext.md +2 -2
- package/api/@xmachines/play-vue/functions/useActor.md +2 -2
- package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
- 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 +1 -1
- package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
- 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 +6 -6
- package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
- package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +2 -2
- package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +2 -2
- package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +3 -3
- package/api/@xmachines/play-vue/type-aliases/PlayActor.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 +1 -1
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-vue/variables/Renderer.md +1 -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 +18 -13
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +41 -31
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +26 -6
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-xstate/README.md +11 -11
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +2 -2
- package/api/@xmachines/play-xstate/functions/composeGuards.md +2 -2
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +2 -2
- package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +5 -3
- package/api/@xmachines/play-xstate/functions/definePlayer.md +3 -3
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +3 -3
- package/api/@xmachines/play-xstate/functions/eventMatches.md +2 -2
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +2 -2
- package/api/@xmachines/play-xstate/functions/hasContext.md +2 -2
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
- package/api/@xmachines/play-xstate/functions/negateGuard.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
- package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +6 -6
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +5 -5
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +5 -5
- package/api/@xmachines/shared/README.md +1 -1
- package/api/@xmachines/shared/vite-aliases/README.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
- package/api/@xmachines/shared/vitest/README.md +1 -1
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +2 -2
- package/api/llms.txt +2 -2
- package/examples/@xmachines/play-dom-demo/README.md +4 -4
- package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
- package/examples/@xmachines/play-dom-demo/functions/initShell.md +2 -2
- package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/About.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Contact.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Home.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Login.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Navigation.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Overview.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Profile.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Settings.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Stats.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-dom-router-demo/README.md +5 -5
- package/examples/@xmachines/play-react-demo/README.md +4 -4
- package/examples/@xmachines/play-react-demo/functions/App.md +2 -2
- package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Login.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/NavBar.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/NavBarView.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Overview.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Stats.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-react-router-demo/README.md +4 -4
- package/examples/@xmachines/play-solid-demo/README.md +4 -4
- package/examples/@xmachines/play-solid-demo/functions/App.md +2 -2
- package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/About.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Contact.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Home.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Login.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/NavBar.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Navigation.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Overview.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Profile.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Settings.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Stats.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-solid-router-demo/README.md +5 -5
- package/examples/@xmachines/play-svelte-demo/README.md +3 -3
- package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-svelte-spa-router-demo/README.md +4 -4
- package/examples/@xmachines/play-sveltekit-router-demo/README.md +4 -4
- package/examples/@xmachines/play-tanstack-react-router-demo/README.md +5 -5
- package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +6 -6
- package/examples/@xmachines/play-vue-demo/README.md +4 -4
- package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-vue-demo/variables/App.md +2 -2
- package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-vue-router-demo/README.md +4 -4
- package/package.json +2 -2
- package/rfc/play.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
[
|
|
1
|
+
[Examples](../../../api/@xmachines/play-vue-router/README.md) / @xmachines/play-vue-router-demo
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# @xmachines/play-vue-router-demo
|
|
4
4
|
|
|
5
5
|
Vue Router integration demo for the XMachines Play architecture using Vue Composition API.
|
|
6
6
|
|
|
@@ -133,5 +133,5 @@ Expected result: reactivity integration tests and the browser shared-demo suite
|
|
|
133
133
|
|
|
134
134
|
## Learn More
|
|
135
135
|
|
|
136
|
-
- [Vue Router](
|
|
137
|
-
- [Vue](../../../play-vue)
|
|
136
|
+
- [Vue Router](../../../api/@xmachines/play-vue-router/README.md)
|
|
137
|
+
- [Vue](../../../api/@xmachines/play-vue/README.md)
|
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.45",
|
|
4
4
|
"description": "Documentation for XMachines",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"documentation",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"test": "vitest run"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"@xmachines/shared": "1.0.0-beta.
|
|
52
|
+
"@xmachines/shared": "1.0.0-beta.45",
|
|
53
53
|
"oxfmt": "^0.45.0",
|
|
54
54
|
"oxlint": "^1.60.0",
|
|
55
55
|
"typedoc": "^0.28.19",
|
package/rfc/play.md
CHANGED
|
@@ -446,7 +446,7 @@ const registryResult = defineRegistry(catalog, {
|
|
|
446
446
|
|
|
447
447
|
// 3. Build route map from machine definition
|
|
448
448
|
const routeTree = extractMachineRoutes(machine);
|
|
449
|
-
const routeMap =
|
|
449
|
+
const routeMap = createRouteMapFromTree(routeTree);
|
|
450
450
|
|
|
451
451
|
// 4. Connect router adapter (router, actor, routeMap)
|
|
452
452
|
const bridge = new TanStackReactRouterBridge(tanstackRouter, actor, routeMap);
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMapFromMachine
|
|
2
|
-
|
|
3
|
-
# Function: createRouteMapFromMachine()
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
function createRouteMapFromMachine(machine): RouteMap;
|
|
7
|
-
```
|
|
8
|
-
|
|
9
|
-
Defined in: [create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.43/packages/play-router/src/create-route-map-from-machine.ts#L26)
|
|
10
|
-
|
|
11
|
-
Create a `RouteMap` from an XState state machine.
|
|
12
|
-
|
|
13
|
-
Extracts all routable states (those with `meta.route`) and builds a bidirectional
|
|
14
|
-
path ↔ stateId lookup structure. The returned map is used by `RouterBridgeBase`
|
|
15
|
-
subclasses to translate browser URL changes into `play.route` actor events and
|
|
16
|
-
vice-versa.
|
|
17
|
-
|
|
18
|
-
## Parameters
|
|
19
|
-
|
|
20
|
-
| Parameter | Type | Description |
|
|
21
|
-
| --------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
22
|
-
| `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine with `meta.route` annotations on states. |
|
|
23
|
-
|
|
24
|
-
## Returns
|
|
25
|
-
|
|
26
|
-
[`RouteMap`](../classes/RouteMap.md)
|
|
27
|
-
|
|
28
|
-
A `RouteMap` for passing to any `RouterBridgeBase`-based adapter.
|
|
29
|
-
|
|
30
|
-
## Example
|
|
31
|
-
|
|
32
|
-
```typescript
|
|
33
|
-
import { createRouteMapFromMachine } from "@xmachines/play-router";
|
|
34
|
-
import { connectRouter } from "@xmachines/play-dom-router";
|
|
35
|
-
|
|
36
|
-
const routeMap = createRouteMapFromMachine(myMachine);
|
|
37
|
-
const disconnect = connectRouter({ actor, router, routeMap });
|
|
38
|
-
```
|