@xmachines/docs 1.0.0-beta.53 → 1.0.0-beta.55
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 +1 -1
- 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 +2 -0
- package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
- package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
- package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
- package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
- package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
- package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
- package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
- 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 +2 -0
- package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
- package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
- 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 +12 -30
- package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
- package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -6
- package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
- package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -15
- package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -8
- package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +25 -0
- package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -5
- package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
- package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
- 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 +44 -0
- package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
- 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 +1 -1
- package/api/@xmachines/play-dom/variables/schema.md +1 -1
- 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 +16 -6
- package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +7 -3
- package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +16 -4
- 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 +6 -6
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-react/README.md +6 -6
- 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 +1 -1
- package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-react/functions/useSignalEffect.md +28 -26
- 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 +1 -1
- 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 +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 +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 +1 -1
- package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
- package/api/@xmachines/play-react-router/README.md +10 -1
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -365
- package/api/@xmachines/play-react-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
- package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +17 -7
- 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 +6 -6
- package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-react-router/{functions → variables}/PlayRouterProvider.md +6 -6
- package/api/@xmachines/play-router/README.md +12 -10
- package/api/@xmachines/play-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +9 -345
- package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
- package/api/@xmachines/play-router/functions/buildRouteTree.md +11 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +13 -6
- 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 +9 -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 +7 -2
- 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 +7 -7
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +17 -0
- 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 +6 -6
- 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/functions/watchSignal.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -2
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -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/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 +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 +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 +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
- 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 +5 -5
- 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 +1 -1
- 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 +1 -1
- package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
- package/api/@xmachines/play-solid-router/README.md +7 -1
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -360
- package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
- 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 +7 -7
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +17 -7
- 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 +6 -6
- package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
- 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/{functions → variables}/PlayRouterProvider.md +6 -6
- package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
- 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 +8 -8
- 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 +11 -11
- 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/PlayRenderer.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/classes/RouteMap.md +17 -5
- 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 +6 -6
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +16 -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 +6 -6
- 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/classes/RouteMap.md +17 -5
- 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 +16 -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 +6 -6
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/README.md +7 -1
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -384
- package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +17 -7
- 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 +6 -6
- package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +12 -4
- package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md +8 -6
- package/api/@xmachines/play-tanstack-router/README.md +58 -0
- package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +131 -0
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
- package/api/@xmachines/play-tanstack-solid-router/README.md +7 -1
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +25 -378
- package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +15 -7
- 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 +6 -6
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- 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 +30 -7
- package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
- package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
- 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 +1 -1
- 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 +1 -1
- package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
- 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 +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 +1 -1
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- 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/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +6 -395
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +16 -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 +6 -6
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +3 -3
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +70 -169
- 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/vite-aliases/README.md +1 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +7 -3
- package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +6 -5
- package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
- package/api/@xmachines/shared/vitest/README.md +5 -0
- package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
- package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
- package/api/README.md +1 -0
- package/api/llms.txt +4 -3
- package/contributing/architecture.md +6 -6
- package/contributing/configuration.md +1 -16
- package/contributing/deployment.md +8 -8
- package/contributing/testing.md +4 -4
- 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-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-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-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-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/guides/README.md +6 -44
- package/package.json +6 -3
- package/api/@xmachines/play-router/functions/createRouteMatcher.md +0 -53
- package/api/@xmachines/play-router/interfaces/RouteMatcher.md +0 -56
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -33
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue/src/define-registry.ts#L109)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
|
|
|
7
7
|
object;
|
|
8
8
|
```
|
|
9
9
|
|
|
10
|
-
Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
10
|
+
Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue/src/define-registry.ts#L113)
|
|
11
11
|
|
|
12
12
|
## Type Declaration
|
|
13
13
|
|
|
14
14
|
| Name | Type | Defined in |
|
|
15
15
|
| ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
16
|
-
| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
16
|
+
| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue/src/define-registry.ts#L117) |
|
|
17
17
|
|
|
18
18
|
## Type Parameters
|
|
19
19
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RenderErrorHandler = (error, elementType) => void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in:
|
|
9
|
+
Defined in: `.pnpm`
|
|
10
10
|
|
|
11
11
|
Callback invoked when an individual catalog component throws during render.
|
|
12
12
|
Implemented by each framework renderer's error boundary / error capture mechanism.
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
const PlayRenderer: DefineComponent<{}, {}, unknown>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue/src/vue-shim.d.ts#L3)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: RouteMap
|
|
4
4
|
|
|
5
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
5
|
+
Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L101)
|
|
6
6
|
|
|
7
7
|
Shared bidirectional route map base class.
|
|
8
8
|
|
|
@@ -17,10 +17,17 @@ own and inherit the full public API from here.
|
|
|
17
17
|
- Results are cached after the first match in an LRU cache (default 500 entries,
|
|
18
18
|
configurable via the `cacheSize` constructor option)
|
|
19
19
|
|
|
20
|
-
**Pattern syntax** (`:param` / `:param?`):
|
|
20
|
+
**Pattern syntax** (`:param` / `:param?` / `*`):
|
|
21
21
|
|
|
22
22
|
- `:param` — required segment, matches exactly one non-`/` segment
|
|
23
23
|
- `:param?` — optional segment, matches zero or one non-`/` segment
|
|
24
|
+
- `*` — wildcard, matches any number of segments (URLPattern semantics)
|
|
25
|
+
|
|
26
|
+
**StateId forms:** stateIds may be registered and looked up in either
|
|
27
|
+
`"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
|
|
28
|
+
`getStateIdByPath` returns the stateId exactly as registered;
|
|
29
|
+
`getPathByStateId` accepts both forms. Registering the same stateId in both
|
|
30
|
+
forms refers to one entry (the later registration wins for reverse lookup).
|
|
24
31
|
|
|
25
32
|
## Example
|
|
26
33
|
|
|
@@ -50,7 +57,7 @@ map.getPathByStateId("missing"); // null
|
|
|
50
57
|
new RouteMap(mappings, options?): RouteMap;
|
|
51
58
|
```
|
|
52
59
|
|
|
53
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
60
|
+
Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L127)
|
|
54
61
|
|
|
55
62
|
Build a route map from an array of state ID ↔ path mappings.
|
|
56
63
|
|
|
@@ -78,10 +85,14 @@ buckets for efficient candidate selection.
|
|
|
78
85
|
getPathByStateId(stateId): string | null;
|
|
79
86
|
```
|
|
80
87
|
|
|
81
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
88
|
+
Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L218)
|
|
82
89
|
|
|
83
90
|
Look up the path pattern registered for a state ID.
|
|
84
91
|
|
|
92
|
+
Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
|
|
93
|
+
which form was used at registration — lookups are canonicalized internally,
|
|
94
|
+
so consumers never need to try both forms.
|
|
95
|
+
|
|
85
96
|
#### Parameters
|
|
86
97
|
|
|
87
98
|
| Parameter | Type | Description |
|
|
@@ -98,6 +109,7 @@ The registered path pattern, or `null` if the state ID is unknown
|
|
|
98
109
|
|
|
99
110
|
```typescript
|
|
100
111
|
map.getPathByStateId("profile"); // "/profile/:userId"
|
|
112
|
+
map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
|
|
101
113
|
map.getPathByStateId("missing"); // null
|
|
102
114
|
```
|
|
103
115
|
|
|
@@ -109,7 +121,7 @@ map.getPathByStateId("missing"); // null
|
|
|
109
121
|
getStateIdByPath(path): string | null;
|
|
110
122
|
```
|
|
111
123
|
|
|
112
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
124
|
+
Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L178)
|
|
113
125
|
|
|
114
126
|
Resolve a URL path to its mapped state ID.
|
|
115
127
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: VueRouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:
|
|
5
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue-router/src/vue-router-bridge.ts#L32)
|
|
6
6
|
|
|
7
7
|
@xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
|
|
8
8
|
|
|
@@ -23,13 +23,13 @@ new VueRouterBridge(
|
|
|
23
23
|
routeMap): VueRouterBridge;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:
|
|
26
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue-router/src/vue-router-bridge.ts#L41)
|
|
27
27
|
|
|
28
28
|
#### Parameters
|
|
29
29
|
|
|
30
30
|
| Parameter | Type |
|
|
31
31
|
| ----------- | -------------------------------------------------------------------- |
|
|
32
|
-
| `vueRouter` | `
|
|
32
|
+
| `vueRouter` | `RouterClassic` |
|
|
33
33
|
| `actor` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) |
|
|
34
34
|
| `routeMap` | [`RouteMap`](RouteMap.md) |
|
|
35
35
|
|
|
@@ -41,20 +41,6 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:39](https://gitlab.com/xma
|
|
|
41
41
|
|
|
42
42
|
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
|
|
43
43
|
|
|
44
|
-
## Properties
|
|
45
|
-
|
|
46
|
-
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|
|
47
|
-
| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
48
|
-
| <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | `undefined` | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L125) |
|
|
49
|
-
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L103) |
|
|
50
|
-
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L102) |
|
|
51
|
-
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L115) |
|
|
52
|
-
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L104) |
|
|
53
|
-
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L126) |
|
|
54
|
-
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L128) |
|
|
55
|
-
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L127) |
|
|
56
|
-
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L116) |
|
|
57
|
-
|
|
58
44
|
## Methods
|
|
59
45
|
|
|
60
46
|
### connect()
|
|
@@ -63,7 +49,7 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:39](https://gitlab.com/xma
|
|
|
63
49
|
connect(): void;
|
|
64
50
|
```
|
|
65
51
|
|
|
66
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
52
|
+
Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L151)
|
|
67
53
|
|
|
68
54
|
Connect the router bridge to the Actor.
|
|
69
55
|
|
|
@@ -95,7 +81,7 @@ Adapters that need custom initial-sync behavior should override
|
|
|
95
81
|
disconnect(): void;
|
|
96
82
|
```
|
|
97
83
|
|
|
98
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
84
|
+
Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L256)
|
|
99
85
|
|
|
100
86
|
Disconnect the router bridge from the Actor.
|
|
101
87
|
|
|
@@ -117,385 +103,10 @@ Stops signal watching and unregisters framework-specific router listener.
|
|
|
117
103
|
dispose(): void;
|
|
118
104
|
```
|
|
119
105
|
|
|
120
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:
|
|
106
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-vue-router/src/vue-router-bridge.ts#L203)
|
|
121
107
|
|
|
122
108
|
Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`).
|
|
123
109
|
|
|
124
110
|
#### Returns
|
|
125
111
|
|
|
126
112
|
`void`
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
### extractParams()
|
|
131
|
-
|
|
132
|
-
```ts
|
|
133
|
-
protected extractParams(pathname, stateId): Record<string, string>;
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
Defined in: [play-router/src/router-bridge-base.ts:402](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L402)
|
|
137
|
-
|
|
138
|
-
Extract path parameters from URL using the URLPattern API.
|
|
139
|
-
|
|
140
|
-
Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
|
|
141
|
-
library. If `URLPattern` is unavailable and the matched route has parameterized
|
|
142
|
-
segments, a `URLPatternUnavailableError` is thrown — callers must provide a polyfill
|
|
143
|
-
for environments without native URLPattern support (Node.js < 24, older browsers).
|
|
144
|
-
|
|
145
|
-
#### Parameters
|
|
146
|
-
|
|
147
|
-
| Parameter | Type | Description |
|
|
148
|
-
| ---------- | -------- | ----------------------------------------------------- |
|
|
149
|
-
| `pathname` | `string` | The actual URL path (e.g., '/profile/john') |
|
|
150
|
-
| `stateId` | `string` | The matched state ID for looking up the route pattern |
|
|
151
|
-
|
|
152
|
-
#### Returns
|
|
153
|
-
|
|
154
|
-
`Record`\<`string`, `string`\>
|
|
155
|
-
|
|
156
|
-
Extracted path parameters, or empty object if no match
|
|
157
|
-
|
|
158
|
-
#### Throws
|
|
159
|
-
|
|
160
|
-
When URLPattern is absent and the route is parameterized
|
|
161
|
-
|
|
162
|
-
#### Inherited from
|
|
163
|
-
|
|
164
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
|
|
165
|
-
|
|
166
|
-
---
|
|
167
|
-
|
|
168
|
-
### extractQuery()
|
|
169
|
-
|
|
170
|
-
```ts
|
|
171
|
-
protected extractQuery(search): Record<string, string>;
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
Defined in: [play-router/src/router-bridge-base.ts:439](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L439)
|
|
175
|
-
|
|
176
|
-
Extract query parameters from URL search string.
|
|
177
|
-
|
|
178
|
-
#### Parameters
|
|
179
|
-
|
|
180
|
-
| Parameter | Type | Description |
|
|
181
|
-
| --------- | -------- | ------------------------------------------------ |
|
|
182
|
-
| `search` | `string` | URL search string (e.g., '?tab=security&page=1') |
|
|
183
|
-
|
|
184
|
-
#### Returns
|
|
185
|
-
|
|
186
|
-
`Record`\<`string`, `string`\>
|
|
187
|
-
|
|
188
|
-
Extracted query parameters or empty object
|
|
189
|
-
|
|
190
|
-
#### Inherited from
|
|
191
|
-
|
|
192
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
### getInitialRouterPath()
|
|
197
|
-
|
|
198
|
-
```ts
|
|
199
|
-
protected getInitialRouterPath(): string | null;
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue-router/src/vue-router-bridge.ts#L166)
|
|
203
|
-
|
|
204
|
-
Return the router's current pathname at connect() time.
|
|
205
|
-
|
|
206
|
-
Called once during connect() to perform the initial URL → actor sync.
|
|
207
|
-
router.subscribe() only fires on _future_ navigation events; it does not
|
|
208
|
-
replay the already-loaded location. Subclasses that can read the router's
|
|
209
|
-
current location synchronously (e.g. `router.state.location.pathname`)
|
|
210
|
-
should override this method so that deep-link / direct-URL loads drive the
|
|
211
|
-
actor to the correct state instead of leaving it at its machine default.
|
|
212
|
-
|
|
213
|
-
Return semantics:
|
|
214
|
-
|
|
215
|
-
- `string` → router has a current path; base connect() will sync actor from router
|
|
216
|
-
- `null` → router is active but has no current path yet; base connect() will sync router from actor
|
|
217
|
-
- `undefined` → adapter handles initial sync itself and base connect() should stay out of the way
|
|
218
|
-
|
|
219
|
-
The default returns `undefined`, preserving the previous behaviour for
|
|
220
|
-
bridges that have not yet implemented this hook.
|
|
221
|
-
|
|
222
|
-
#### Returns
|
|
223
|
-
|
|
224
|
-
`string` \| `null`
|
|
225
|
-
|
|
226
|
-
#### Overrides
|
|
227
|
-
|
|
228
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
|
|
229
|
-
|
|
230
|
-
---
|
|
231
|
-
|
|
232
|
-
### getInitialRouterSearch()
|
|
233
|
-
|
|
234
|
-
```ts
|
|
235
|
-
protected getInitialRouterSearch(): string | undefined;
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue-router/src/vue-router-bridge.ts#L178)
|
|
239
|
-
|
|
240
|
-
Return the initial URL search string for query-param forwarding on `connect()`.
|
|
241
|
-
|
|
242
|
-
Vue Router does not expose a raw `search` string on the normalized route — only
|
|
243
|
-
`fullPath` (e.g. `"/profile/123?tab=posts"`). The search is extracted by slicing
|
|
244
|
-
from the first `"?"`. Returns `undefined` when no query string is present so
|
|
245
|
-
`syncActorFromRouter` produces `query: {}` rather than parsing an empty string.
|
|
246
|
-
|
|
247
|
-
#### Returns
|
|
248
|
-
|
|
249
|
-
`string` \| `undefined`
|
|
250
|
-
|
|
251
|
-
#### Overrides
|
|
252
|
-
|
|
253
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterSearch`](../../play-router/classes/RouterBridgeBase.md#getinitialroutersearch)
|
|
254
|
-
|
|
255
|
-
---
|
|
256
|
-
|
|
257
|
-
### navigateRouter()
|
|
258
|
-
|
|
259
|
-
```ts
|
|
260
|
-
protected navigateRouter(path): void;
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue-router/src/vue-router-bridge.ts#L84)
|
|
264
|
-
|
|
265
|
-
Navigate Vue Router to the given path.
|
|
266
|
-
|
|
267
|
-
Receives a raw actor route value (stateId or concrete path).
|
|
268
|
-
`resolveNavigationPath` normalizes to a concrete path; parameterized patterns
|
|
269
|
-
are skipped. Navigation errors are thrown as [VueRouterNavigationError](#).
|
|
270
|
-
|
|
271
|
-
Echo suppression — preventing the watcher from re-driving the actor with the
|
|
272
|
-
router's response to this push — is handled by `lastSyncedPath` in the base
|
|
273
|
-
class. `syncRouterFromActor` sets `lastSyncedPath = resolved` before this call,
|
|
274
|
-
so when the watcher fires with the same path it short-circuits at the
|
|
275
|
-
`sanitizedPath === lastSyncedPath` check and sends no event.
|
|
276
|
-
|
|
277
|
-
#### Parameters
|
|
278
|
-
|
|
279
|
-
| Parameter | Type |
|
|
280
|
-
| --------- | -------- |
|
|
281
|
-
| `path` | `string` |
|
|
282
|
-
|
|
283
|
-
#### Returns
|
|
284
|
-
|
|
285
|
-
`void`
|
|
286
|
-
|
|
287
|
-
#### Overrides
|
|
288
|
-
|
|
289
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
|
|
290
|
-
|
|
291
|
-
---
|
|
292
|
-
|
|
293
|
-
### resolveNavigationPath()
|
|
294
|
-
|
|
295
|
-
```ts
|
|
296
|
-
protected resolveNavigationPath(route): string | null;
|
|
297
|
-
```
|
|
298
|
-
|
|
299
|
-
Defined in: [play-router/src/router-bridge-base.ts:424](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L424)
|
|
300
|
-
|
|
301
|
-
Resolve an actor route value to a concrete URL path for navigation.
|
|
302
|
-
|
|
303
|
-
Bridges that receive raw `actor.currentRoute` values in `navigateRouter`
|
|
304
|
-
can call this to normalize stateIds (with or without `#` prefix) to paths.
|
|
305
|
-
Returns `null` when navigation is not possible:
|
|
306
|
-
|
|
307
|
-
- unknown stateId with no route map entry
|
|
308
|
-
- parameterized pattern (e.g. `/profile/:id`) — no concrete values available
|
|
309
|
-
- non-path string that isn't a known stateId
|
|
310
|
-
|
|
311
|
-
Route maps may store stateIds with or without the `#` prefix; both forms
|
|
312
|
-
are tried automatically.
|
|
313
|
-
|
|
314
|
-
#### Parameters
|
|
315
|
-
|
|
316
|
-
| Parameter | Type | Description |
|
|
317
|
-
| --------- | -------- | -------------------------------------------------------------- |
|
|
318
|
-
| `route` | `string` | Raw actor route value (stateId, `#`-stateId, or concrete path) |
|
|
319
|
-
|
|
320
|
-
#### Returns
|
|
321
|
-
|
|
322
|
-
`string` \| `null`
|
|
323
|
-
|
|
324
|
-
Concrete URL path, or `null` if navigation should be skipped
|
|
325
|
-
|
|
326
|
-
#### Inherited from
|
|
327
|
-
|
|
328
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`resolveNavigationPath`](../../play-router/classes/RouterBridgeBase.md#resolvenavigationpath)
|
|
329
|
-
|
|
330
|
-
---
|
|
331
|
-
|
|
332
|
-
### sanitizePath()
|
|
333
|
-
|
|
334
|
-
```ts
|
|
335
|
-
protected sanitizePath(pathname): string | null;
|
|
336
|
-
```
|
|
337
|
-
|
|
338
|
-
Defined in: [play-router/src/router-bridge-base.ts:466](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L466)
|
|
339
|
-
|
|
340
|
-
Sanitize and validate a raw URL pathname received from the router.
|
|
341
|
-
|
|
342
|
-
Applies the path-length cap (2048 chars), strips query strings and fragments
|
|
343
|
-
that may have been included in the pathname segment, and normalises
|
|
344
|
-
consecutive slashes.
|
|
345
|
-
|
|
346
|
-
Implementations that bypass `syncActorFromRouter()` (e.g. when using
|
|
347
|
-
framework-native reactive watchers that receive pre-parsed route objects)
|
|
348
|
-
MUST call this method before passing the path to any route-map lookup.
|
|
349
|
-
`syncActorFromRouter()` calls this internally, so bridges that delegate
|
|
350
|
-
to it do not need to call `sanitizePath` themselves.
|
|
351
|
-
|
|
352
|
-
#### Parameters
|
|
353
|
-
|
|
354
|
-
| Parameter | Type | Description |
|
|
355
|
-
| ---------- | -------- | ------------------------------------------- |
|
|
356
|
-
| `pathname` | `string` | Raw URL pathname from the framework router. |
|
|
357
|
-
|
|
358
|
-
#### Returns
|
|
359
|
-
|
|
360
|
-
`string` \| `null`
|
|
361
|
-
|
|
362
|
-
Sanitized pathname, or `null` if the path is invalid / too long.
|
|
363
|
-
|
|
364
|
-
#### Inherited from
|
|
365
|
-
|
|
366
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`sanitizePath`](../../play-router/classes/RouterBridgeBase.md#sanitizepath)
|
|
367
|
-
|
|
368
|
-
---
|
|
369
|
-
|
|
370
|
-
### syncActorFromRouter()
|
|
371
|
-
|
|
372
|
-
```ts
|
|
373
|
-
protected syncActorFromRouter(pathname, search?): void;
|
|
374
|
-
```
|
|
375
|
-
|
|
376
|
-
Defined in: [play-router/src/router-bridge-base.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L324)
|
|
377
|
-
|
|
378
|
-
Sync actor state when router location changes.
|
|
379
|
-
|
|
380
|
-
**Known path:** sends a `play.route` event to the actor with the matched
|
|
381
|
-
stateId, params, and query. Prevents circular updates via the
|
|
382
|
-
`isProcessingNavigation` flag.
|
|
383
|
-
|
|
384
|
-
**Unknown/unmapped path:** does NOT send a `play.route` event (actor state
|
|
385
|
-
is unchanged). Instead, actively corrects the browser URL by calling
|
|
386
|
-
`navigateRouter(actor.currentRoute.get())` — keeping the URL in sync with
|
|
387
|
-
actor state even when the user types an invalid path into the address bar
|
|
388
|
-
or pushes one programmatically mid-session. `lastSyncedPath` is set to the
|
|
389
|
-
resolved concrete path before calling `navigateRouter` so the router's own
|
|
390
|
-
callback for that navigation short-circuits the echo-suppression guard and
|
|
391
|
-
sends no spurious event.
|
|
392
|
-
|
|
393
|
-
#### Parameters
|
|
394
|
-
|
|
395
|
-
| Parameter | Type |
|
|
396
|
-
| ---------- | -------- |
|
|
397
|
-
| `pathname` | `string` |
|
|
398
|
-
| `search?` | `string` |
|
|
399
|
-
|
|
400
|
-
#### Returns
|
|
401
|
-
|
|
402
|
-
`void`
|
|
403
|
-
|
|
404
|
-
#### Inherited from
|
|
405
|
-
|
|
406
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
|
|
407
|
-
|
|
408
|
-
---
|
|
409
|
-
|
|
410
|
-
### syncRouterFromActor()
|
|
411
|
-
|
|
412
|
-
```ts
|
|
413
|
-
protected syncRouterFromActor(route): void;
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
Defined in: [play-router/src/router-bridge-base.ts:289](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-router/src/router-bridge-base.ts#L289)
|
|
417
|
-
|
|
418
|
-
Sync router location when actor route signal changes.
|
|
419
|
-
|
|
420
|
-
Calls navigateRouter() for framework-specific navigation.
|
|
421
|
-
|
|
422
|
-
Echo suppression — preventing the router's own callback from re-driving the
|
|
423
|
-
actor — is handled entirely by `lastSyncedPath`: it is set to `route` before
|
|
424
|
-
`navigateRouter()` is called, so any `syncActorFromRouter` invocation for the
|
|
425
|
-
same path short-circuits at the `sanitized === lastSyncedPath` check and sends
|
|
426
|
-
no event regardless of whether the callback fires synchronously or asynchronously.
|
|
427
|
-
|
|
428
|
-
`isProcessingNavigation` is NOT set here — it is only used inside
|
|
429
|
-
`syncActorFromRouter` to guard against re-entrant guard-redirect loops.
|
|
430
|
-
|
|
431
|
-
#### Parameters
|
|
432
|
-
|
|
433
|
-
| Parameter | Type |
|
|
434
|
-
| --------- | --------- |
|
|
435
|
-
| `route` | `unknown` |
|
|
436
|
-
|
|
437
|
-
#### Returns
|
|
438
|
-
|
|
439
|
-
`void`
|
|
440
|
-
|
|
441
|
-
#### Inherited from
|
|
442
|
-
|
|
443
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
|
|
444
|
-
|
|
445
|
-
---
|
|
446
|
-
|
|
447
|
-
### unwatchRouterChanges()
|
|
448
|
-
|
|
449
|
-
```ts
|
|
450
|
-
protected unwatchRouterChanges(): void;
|
|
451
|
-
```
|
|
452
|
-
|
|
453
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue-router/src/vue-router-bridge.ts#L161)
|
|
454
|
-
|
|
455
|
-
Stop watching for router location changes.
|
|
456
|
-
|
|
457
|
-
Called by disconnect(). Should clean up the framework-specific subscription.
|
|
458
|
-
|
|
459
|
-
#### Returns
|
|
460
|
-
|
|
461
|
-
`void`
|
|
462
|
-
|
|
463
|
-
#### Overrides
|
|
464
|
-
|
|
465
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
|
|
466
|
-
|
|
467
|
-
---
|
|
468
|
-
|
|
469
|
-
### watchRouterChanges()
|
|
470
|
-
|
|
471
|
-
```ts
|
|
472
|
-
protected watchRouterChanges(): void;
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.53/packages/play-vue-router/src/vue-router-bridge.ts#L111)
|
|
476
|
-
|
|
477
|
-
Subscribe to Vue Router changes using `watch` from `@vue/reactivity`.
|
|
478
|
-
|
|
479
|
-
`router.currentRoute` is a Vue `ShallowRef<RouteLocationNormalizedLoaded>` that is
|
|
480
|
-
updated once per navigation, only when the route actually changes. This fires with
|
|
481
|
-
exactly-once semantics — unlike `afterEach`, it does not fire for actor→router
|
|
482
|
-
programmatic pushes that land on the same URL, eliminating the GAP-12 double-fire.
|
|
483
|
-
|
|
484
|
-
Uses Vue's native `to.params` / `to.query` for accurate param extraction
|
|
485
|
-
instead of URLPattern-based re-parsing.
|
|
486
|
-
|
|
487
|
-
`watch` is imported from `@vue/reactivity` (not `vue`/`@vue/runtime-core`) so
|
|
488
|
-
that errors thrown from the callback propagate through the reactivity scheduler's
|
|
489
|
-
`endBatch` path (`if (error) throw error`) rather than through
|
|
490
|
-
`callWithErrorHandling`, which would swallow the error into Vue's global error
|
|
491
|
-
handler and emit a spurious "Unhandled error during execution of watcher callback"
|
|
492
|
-
warning. `flush: "sync"` ensures the callback runs in the same synchronous frame
|
|
493
|
-
as the ref mutation.
|
|
494
|
-
|
|
495
|
-
#### Returns
|
|
496
|
-
|
|
497
|
-
`void`
|
|
498
|
-
|
|
499
|
-
#### Overrides
|
|
500
|
-
|
|
501
|
-
[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function createRouteMap(machine, options?): RouteMap;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L45)
|
|
10
10
|
|
|
11
11
|
Create a `RouteMap` from an XState state machine.
|
|
12
12
|
|