@xmachines/docs 7.3.0 → 7.4.1
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/core/cache/functions/createLruCache.md +1 -1
- package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
- package/api/@xmachines/core/errors/classes/BaseError.md +4 -4
- package/api/@xmachines/core/errors/classes/DisposeConflictError.md +4 -4
- package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
- package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
- package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
- package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
- package/api/@xmachines/core/utils/functions/isError.md +1 -1
- package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
- package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
- package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
- package/api/@xmachines/core/utils/functions/safeString.md +1 -1
- package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
- package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
- package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
- package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
- package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
- package/api/@xmachines/play/errors/classes/PlayError.md +4 -4
- package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
- package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
- package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
- package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
- package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
- package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
- package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
- package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
- package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
- package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
- package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
- package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
- package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
- package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
- package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
- package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
- package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
- package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
- package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
- 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/interfaces/CreatePlayUIOptions.md +3 -3
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
- package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
- package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
- package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
- 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 +8 -8
- package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +6 -6
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
- package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
- package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
- package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
- package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
- package/api/@xmachines/play-pattern/interfaces/GroupPart.md +4 -4
- package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
- package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
- package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
- package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
- package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
- package/api/@xmachines/play-pattern/interfaces/PatternParam.md +4 -4
- package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
- package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
- package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
- package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
- package/api/@xmachines/play-react/functions/useActor.md +1 -1
- package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
- package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
- package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
- package/api/@xmachines/play-react/type-aliases/AnyPlayActor.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/classes/ReactRouterBridge.md +7 -7
- package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
- package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
- package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
- package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
- package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
- package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
- package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
- package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
- package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
- package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
- package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
- package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
- package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
- package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
- package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
- package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
- package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
- package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
- package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
- package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
- package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
- package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
- package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
- package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
- package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
- package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
- package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
- package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
- package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
- package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
- package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
- package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
- package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
- package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
- package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
- package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
- package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
- package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
- package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
- package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
- package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
- package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
- package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
- package/api/@xmachines/play-router/index/interfaces/RouteObject.md +5 -5
- package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
- package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +5 -5
- package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +6 -6
- package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
- package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
- package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
- package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
- package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
- package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
- package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
- package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
- package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
- package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
- package/api/@xmachines/play-solid/functions/useActor.md +1 -1
- package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
- package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
- 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/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/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
- package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-svelte/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/DefineRegistryOptions.md +4 -4
- 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/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
- package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +6 -6
- package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
- package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
- package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +9 -9
- package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +6 -6
- package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +6 -6
- package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
- package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.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 +5 -5
- package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
- package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
- package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
- package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
- package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
- package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
- package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
- package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
- package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
- package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
- package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
- package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
- package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
- package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
- package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
- package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
- package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
- package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
- package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
- package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
- package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
- package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +3 -3
- package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
- package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
- package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
- package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
- package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
- package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +2 -2
- package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
- package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
- package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
- package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
- package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
- package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
- package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
- package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
- package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
- package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
- package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
- package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
- package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +6 -6
- package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
- package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +6 -6
- package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
- package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +1 -1
- package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
- package/api/@xmachines/play-view/index/functions/composeViews.md +1 -1
- package/api/@xmachines/play-view/index/functions/createActorProxy.md +1 -1
- package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +1 -1
- package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
- package/api/@xmachines/play-view/index/functions/createViewSession.md +1 -1
- package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
- package/api/@xmachines/play-view/index/functions/forwardRenderError.md +1 -1
- package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
- package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
- package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
- package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
- package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
- package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
- package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
- package/api/@xmachines/play-view/index/interfaces/ComposedView.md +5 -5
- package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +2 -2
- package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +3 -3
- package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
- package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +3 -3
- package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
- package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +2 -2
- package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +3 -3
- package/api/@xmachines/play-view/index/interfaces/ViewSession.md +7 -7
- package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +3 -3
- package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +6 -6
- package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +4 -4
- package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +5 -5
- package/api/@xmachines/play-view/index/interfaces/ViewTree.md +4 -4
- package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +3 -3
- package/api/@xmachines/play-view/index/interfaces/Viewable.md +2 -2
- package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +1 -1
- package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
- package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
- package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-vue/functions/useActor.md +1 -1
- package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
- package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
- 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/ComponentsMap.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
- package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
- package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
- package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
- package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +4 -4
- package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
- package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
- package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
- package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
- package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
- package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
- package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
- package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
- package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -10
- package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
- package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
- package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
- package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
- package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
- package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
- package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
- package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
- package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +5 -5
- package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
- package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
- package/api/@xmachines/runtime-wasi/variables/component.md +1 -1
- package/api/@xmachines/runtime-wasi/variables/schemas.md +1 -1
- package/api/@xmachines/runtime-wasi/variables/wit.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
- 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 +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +1 -1
- package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
- package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
- package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
- package/api/trains.json +52 -0
- package/contributing/configuration.md +3 -1
- package/contributing/deployment.md +6 -8
- package/examples/@xmachines/play-dom-gallery-demo/functions/createConfirmDialog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/functions/createDebugPanel.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/functions/initApp.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/functions/initShell.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
- package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryRuntime.md +3 -3
- package/examples/@xmachines/play-dom-gallery-demo/interfaces/ShellOptions.md +7 -7
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/DonutCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FetchCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FlightCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GalleryActor.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GallerySlug.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/KitCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/Button.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/Field.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/Page.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/Panel.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/Text.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/demoComponents.md +6 -6
- package/examples/@xmachines/play-dom-gallery-demo/variables/donutCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/fetchCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/flightCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/galleryMachines.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/stopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/temperatureCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/ticTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/todoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-dom-gallery-demo/variables/triviaCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/functions/App.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
- package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryRuntime.md +3 -3
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/DonutCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/FetchCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/FlightCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/GalleryActor.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/GallerySlug.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/KitCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/Button.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/DebugPanel.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/Field.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/Page.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/Panel.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/Shell.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/Text.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/demoComponents.md +6 -6
- package/examples/@xmachines/play-react-gallery-demo/variables/donutCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/fetchCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/flightCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/galleryMachines.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/stopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/temperatureCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/ticTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/todoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-react-gallery-demo/variables/triviaCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/functions/App.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
- package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryRuntime.md +3 -3
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/DonutCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FetchCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FlightCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GalleryActor.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GallerySlug.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/KitCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/Button.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/DebugPanel.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/Field.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/Page.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/Panel.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/Shell.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/Text.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/demoComponents.md +6 -6
- package/examples/@xmachines/play-solid-gallery-demo/variables/donutCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/fetchCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/flightCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/galleryMachines.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/stopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/temperatureCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/ticTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/todoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-solid-gallery-demo/variables/triviaCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
- package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryRuntime.md +3 -3
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/DonutCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FetchCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FlightCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GalleryActor.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GallerySlug.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/KitCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/demoComponents.md +6 -6
- package/examples/@xmachines/play-svelte-gallery-demo/variables/donutCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/fetchCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/flightCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/galleryMachines.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/stopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/temperatureCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/ticTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/todoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-gallery-demo/variables/triviaCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
- package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryRuntime.md +3 -3
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/DonutCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FetchCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FlightCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GalleryActor.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GallerySlug.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/KitCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/demoComponents.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/donutCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/fetchCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/flightCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/galleryMachines.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/stopwatchCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/temperatureCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/ticTacToeCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/todoMvcCatalog.md +1 -1
- package/examples/@xmachines/play-vue-gallery-demo/variables/triviaCatalog.md +1 -1
- package/package.json +2 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: RouteObject
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-router/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
5
|
+
Defined in: [packages/play-router/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L33)
|
|
6
6
|
|
|
7
7
|
A route object, with more metadata.
|
|
8
8
|
|
|
@@ -25,7 +25,7 @@ the literal `true` alone turns the reentry on. Give a field of your own another
|
|
|
25
25
|
|
|
26
26
|
| Property | Type | Description | Defined in |
|
|
27
27
|
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
-
| <a id="property-data"></a> `data?` | \| [`RouteData`](../type-aliases/RouteData.md) \| [`RouteDataResolver`](../type-aliases/RouteDataResolver.md) | The extra data that the state threads into its `play.route` event. The shape follows `WithDynamicParams` of XState, which is how XState itself parameterizes an action and a guard: the field holds a literal value, OR a function of `{ context, event }` that returns one. `// The literal form. It survives a serialization of the machine. meta: { route: { path: "/doc/:docId", data: { titleKey: "doc.view" } } } // The function form, for a value that depends on the route. meta: { route: { path: "/doc/:docId", data: ({ event }) => ({ title: `Document ${event.params?.docId}` }), }, }` The generated transition resolves the value and assigns it to the `data` field of the context, beside `params` and `query`. The data of a state does NOT merge with the data of its ancestors: each state declares the whole value that its own route carries. This field and [PlayRouteEvent.data](../../../play-dom-router/interfaces/PlayRouteEvent.md#property-data) are two different things, and they meet in the resolver. This field is what the STATE declares, in its machine. `PlayRouteEvent.data` is what the SENDER of the event supplies, such as a router bridge or the code of an application. A resolver reads `event.data` and returns whatever mix of the two the state needs. CAUTION: the function form holds a function inside `meta`, and a function does not survive `JSON.stringify`. A machine that Stately Studio reads, or that a process sends over a wire, must use the literal form. | [packages/play-router/src/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
29
|
-
| <a id="property-handler"></a> `handler?` | `"root"` \| `"local"` \| `"both"` | Where the generated `play.route` transition sits. `"root"` is the default, and it is what XState does: `formatRouteTransitions` installs every route transition on the ROOT of the machine, and each one targets its state by the ID. A route from any state therefore reaches this state. The cost is that the root is the domain of the transition, so XState re-enters each ancestor on the path to the target, and those ancestors run their `entry` actions again although they stay active. `"local"` installs the transition on the PARENT of this state instead, and it targets this state relatively. XState offers the transitions of the deepest active state node first, so the parent answers the event itself. The parent then runs its `exit` and its `entry` actions again only where the state declares `reenter: true`. `"both"` installs one transition in each place. The local one answers while the parent is active, and the root one answers a route that arrives from outside the parent. Use `"both"` where an ancestor holds an `entry` action that must run one time for each real entry, such as an analytics event or an audit record. CAUTION: `"local"` makes this state reachable by a route ONLY while its parent is active. A `play.route` event that arrives from anywhere else matches no transition and the actor does not move. A browser URL for this state therefore leaves the URL and the actor divergent. Choose `"local"` to SCOPE a route on purpose, for example a step that a person reaches only inside its wizard. Choose `"both"` where the state must stay reachable from everywhere. The field has no effect on a state whose parent IS the root: the root transition of such a state is already local to its parent, so all three values agree. | [packages/play-router/src/types.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
30
|
-
| <a id="property-path"></a> `path` | `string` | The template of the route path, for example `"/user/:id"`. | [packages/play-router/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
31
|
-
| <a id="property-reenter"></a> `reenter?` | `boolean` | The `reenter` flag of the generated `play.route` transition. The default is `false`, which is also the default of XState. The flag spares the DOMAIN of the transition, and not every ancestor that stays active. Under the default placement `handler: "root"` the domain is the root of the machine, so `false` spares the root alone: each ancestor BETWEEN the root and the target still runs its `exit` and its `entry` actions, because XState re-enters every descendant of the domain that lies on the path to the target. A move between two siblings therefore still runs the `entry` action of their shared parent. [RouteObject.handler](#property-handler) is the field that spares those intermediate ancestors: `"local"` and `"both"` move the domain down to the parent of the state, while the parent is active. Use the two fields together where an `entry` action must run one time for each state that the actor really enters. The target itself re-enters under both settings, so a route to the state that the actor already holds runs the `exit` and `entry` actions of that state again. The ROOT of the machine is the one exception: a route to the root has the root as its domain, so the flag decides. Set the field to `true` where the domain must run its `entry` actions again on each route to this state. The flag of a state applies to the routes to that state alone, and not to the routes to its descendants. The flag does not decide the destination. The value of the machine after a route is identical under both settings. A route to a state that has children still enters the `initial` child of that state, because XState enters the initial child of a compound target under both settings. **See** [Play RFC](../../../../../rfc/play.md) | [packages/play-router/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
28
|
+
| <a id="property-data"></a> `data?` | \| [`RouteData`](../type-aliases/RouteData.md) \| [`RouteDataResolver`](../type-aliases/RouteDataResolver.md) | The extra data that the state threads into its `play.route` event. The shape follows `WithDynamicParams` of XState, which is how XState itself parameterizes an action and a guard: the field holds a literal value, OR a function of `{ context, event }` that returns one. `// The literal form. It survives a serialization of the machine. meta: { route: { path: "/doc/:docId", data: { titleKey: "doc.view" } } } // The function form, for a value that depends on the route. meta: { route: { path: "/doc/:docId", data: ({ event }) => ({ title: `Document ${event.params?.docId}` }), }, }` The generated transition resolves the value and assigns it to the `data` field of the context, beside `params` and `query`. The data of a state does NOT merge with the data of its ancestors: each state declares the whole value that its own route carries. This field and [PlayRouteEvent.data](../../../play-dom-router/interfaces/PlayRouteEvent.md#property-data) are two different things, and they meet in the resolver. This field is what the STATE declares, in its machine. `PlayRouteEvent.data` is what the SENDER of the event supplies, such as a router bridge or the code of an application. A resolver reads `event.data` and returns whatever mix of the two the state needs. CAUTION: the function form holds a function inside `meta`, and a function does not survive `JSON.stringify`. A machine that Stately Studio reads, or that a process sends over a wire, must use the literal form. | [packages/play-router/src/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L134) |
|
|
29
|
+
| <a id="property-handler"></a> `handler?` | `"root"` \| `"local"` \| `"both"` | Where the generated `play.route` transition sits. `"root"` is the default, and it is what XState does: `formatRouteTransitions` installs every route transition on the ROOT of the machine, and each one targets its state by the ID. A route from any state therefore reaches this state. The cost is that the root is the domain of the transition, so XState re-enters each ancestor on the path to the target, and those ancestors run their `entry` actions again although they stay active. `"local"` installs the transition on the PARENT of this state instead, and it targets this state relatively. XState offers the transitions of the deepest active state node first, so the parent answers the event itself. The parent then runs its `exit` and its `entry` actions again only where the state declares `reenter: true`. `"both"` installs one transition in each place. The local one answers while the parent is active, and the root one answers a route that arrives from outside the parent. Use `"both"` where an ancestor holds an `entry` action that must run one time for each real entry, such as an analytics event or an audit record. CAUTION: `"local"` makes this state reachable by a route ONLY while its parent is active. A `play.route` event that arrives from anywhere else matches no transition and the actor does not move. A browser URL for this state therefore leaves the URL and the actor divergent. Choose `"local"` to SCOPE a route on purpose, for example a step that a person reaches only inside its wizard. Choose `"both"` where the state must stay reachable from everywhere. The field has no effect on a state whose parent IS the root: the root transition of such a state is already local to its parent, so all three values agree. | [packages/play-router/src/types.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L98) |
|
|
30
|
+
| <a id="property-path"></a> `path` | `string` | The template of the route path, for example `"/user/:id"`. | [packages/play-router/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L35) |
|
|
31
|
+
| <a id="property-reenter"></a> `reenter?` | `boolean` | The `reenter` flag of the generated `play.route` transition. The default is `false`, which is also the default of XState. The flag spares the DOMAIN of the transition, and not every ancestor that stays active. Under the default placement `handler: "root"` the domain is the root of the machine, so `false` spares the root alone: each ancestor BETWEEN the root and the target still runs its `exit` and its `entry` actions, because XState re-enters every descendant of the domain that lies on the path to the target. A move between two siblings therefore still runs the `entry` action of their shared parent. [RouteObject.handler](#property-handler) is the field that spares those intermediate ancestors: `"local"` and `"both"` move the domain down to the parent of the state, while the parent is active. Use the two fields together where an `entry` action must run one time for each state that the actor really enters. The target itself re-enters under both settings, so a route to the state that the actor already holds runs the `exit` and `entry` actions of that state again. The ROOT of the machine is the one exception: a route to the root has the root as its domain, so the flag decides. Set the field to `true` where the domain must run its `entry` actions again on each route to this state. The flag of a state applies to the routes to that state alone, and not to the routes to its descendants. The flag does not decide the destination. The value of the machine after a route is identical under both settings. A route to a state that has children still enters the `initial` child of that state, because XState enters the initial child of a compound target under both settings. **See** [Play RFC](../../../../../rfc/play.md) | [packages/play-router/src/types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L67) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteData = Record<string, unknown>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L15)
|
|
10
10
|
|
|
11
11
|
The resolved extra data of a route. It reaches the consumer on the `data` field of a
|
|
12
12
|
`play.route` event.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteDataResolver = (args) => RouteData;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L28)
|
|
10
10
|
|
|
11
11
|
The function form of [RouteObject.data](../interfaces/RouteObject.md#property-data).
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteMachineConfig = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L177)
|
|
10
10
|
|
|
11
11
|
The minimal structural constraint of a machine config that
|
|
12
12
|
`formatPlayRouteTransitions` accepts.
|
|
@@ -32,7 +32,7 @@ original concrete type through the transform. Therefore
|
|
|
32
32
|
context?: unknown;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
35
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L178)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
|
|
|
42
42
|
on?: Record<string, unknown>;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
45
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L180)
|
|
46
46
|
|
|
47
47
|
---
|
|
48
48
|
|
|
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
|
|
|
52
52
|
states?: Record<string, unknown>;
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
55
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L179)
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
type RouteMetadata = string | RouteObject;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-router/src/types.ts#L151)
|
|
10
10
|
|
|
11
11
|
The route metadata of the `meta.route` field of a state machine.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteStateNode = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
|
|
10
10
|
|
|
11
11
|
The minimal structural shape of one XState state node, as
|
|
12
12
|
`formatPlayRouteTransitions` reads it during its walk over the machine config.
|
|
@@ -29,7 +29,7 @@ signature without a change.
|
|
|
29
29
|
id?: string;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
32
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L34)
|
|
33
33
|
|
|
34
34
|
The optional explicit state ID, for example `"home"` or `"settings"`. It is the `#id` target of a `play.route` event.
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ The optional explicit state ID, for example `"home"` or `"settings"`. It is the
|
|
|
41
41
|
meta?: object;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
44
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L36)
|
|
45
45
|
|
|
46
46
|
The state metadata. A `meta.route` field gives the state a route.
|
|
47
47
|
|
|
@@ -64,7 +64,7 @@ generated transition, and that flag defaults to `false`.
|
|
|
64
64
|
on?: Record<string, unknown>;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
67
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
|
|
68
68
|
|
|
69
69
|
The event handlers of this state. The function reads them where a child asks for a
|
|
70
70
|
local `play.route` handler, so that the transitions of the user survive the merge.
|
|
@@ -77,6 +77,6 @@ local `play.route` handler, so that the transitions of the user survive the merg
|
|
|
77
77
|
states?: Record<string, RouteStateNode>;
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
80
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L46)
|
|
81
81
|
|
|
82
82
|
The nested child states. The function walks them for each further route declaration.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function withView<TMachine>(Base): PlayerConstructor<TMachine, Viewable>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/with-view.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-xstate/src/with-view.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-xstate/src/with-view.ts#L61)
|
|
10
10
|
|
|
11
11
|
Adds the view capability to an actor class.
|
|
12
12
|
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
const component: URL;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [index.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [index.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/runtime-wasi/src/index.ts#L17)
|
|
10
10
|
|
|
11
11
|
The WASI 0.2 component (`wasm32-wasip2`), of the world `xmachines:runtime/runtime`.
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
const schemas: URL;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [index.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [index.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/runtime-wasi/src/index.ts#L26)
|
|
10
10
|
|
|
11
11
|
The folder of the JSON Schemas (draft 2020-12) of the JSON text that the WIT names, with a `/` at its end.
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
const wit: URL;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [index.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [index.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/runtime-wasi/src/index.ts#L23)
|
|
10
10
|
|
|
11
11
|
The WIT package `xmachines:runtime`, of the world that the component exports and imports.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmAliases(importMetaUrl, target?): Record<string, string>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L311)
|
|
10
10
|
|
|
11
11
|
Vite resolve.alias entries for all @xmachines/* workspace packages.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmBuildOutput(importMetaUrl): Plugin;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L407)
|
|
10
10
|
|
|
11
11
|
The Vite plugin of the dist run: it moves each `src/` file of a published package to its
|
|
12
12
|
counterpart in `dist/`.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmBuildOutputFile(packageDir, sourceFile): string;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L378)
|
|
10
10
|
|
|
11
11
|
The file in `dist/` that the build writes for one source file of a package.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmCacheDir(importMetaUrl, name): string;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:514](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:514](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L514)
|
|
10
10
|
|
|
11
11
|
Returns the shared Vite `cacheDir` for this workspace package.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmOptimizeDeps(include?): DepOptimizationOptions;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L467)
|
|
10
10
|
|
|
11
11
|
Returns the standard Vite `optimizeDeps` config for browser test projects.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmResolve(importMetaUrl, extra?): ResolveOptions & object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L352)
|
|
10
10
|
|
|
11
11
|
Full Vite `resolve` config for @xmachines/* workspace packages.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmSvelteRunes(): object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L493)
|
|
10
10
|
|
|
11
11
|
Svelte plugin options that enforce runes mode for workspace sources only.
|
|
12
12
|
|
|
@@ -35,4 +35,4 @@ one and change the other.
|
|
|
35
35
|
|
|
36
36
|
| Name | Type | Defined in |
|
|
37
37
|
| ------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
38
|
-
| `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:494](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
38
|
+
| `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:494](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L494) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function xmTestTarget(env?): XmTestTarget;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L25)
|
|
10
10
|
|
|
11
11
|
Reads the test target from the `XM_TEST_TARGET` environment variable.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type XmTestTarget = "source" | "dist";
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vite-aliases.ts#L13)
|
|
10
10
|
|
|
11
11
|
The code that a test run loads for each published `@xmachines/*` package.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function defineXmBrowserConfig(importMetaUrl, overrides, options?): UserConfig;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vitest.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vitest.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vitest.ts#L230)
|
|
10
10
|
|
|
11
11
|
Create a Vitest browser-mode config with XMachines workspace defaults.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function defineXmVitestConfig(importMetaUrl, overrides): UserConfig;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vitest.ts#L76)
|
|
10
10
|
|
|
11
11
|
Create a Vitest config with XMachines workspace defaults.
|
|
12
12
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: XmBrowserConfigOptions
|
|
4
4
|
|
|
5
|
-
Defined in: [vitest.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
5
|
+
Defined in: [vitest.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vitest.ts#L180)
|
|
6
6
|
|
|
7
7
|
Options for [defineXmBrowserConfig](../functions/defineXmBrowserConfig.md) that live outside the plain
|
|
8
8
|
Vitest config overrides.
|
|
@@ -11,6 +11,6 @@ Vitest config overrides.
|
|
|
11
11
|
|
|
12
12
|
| Property | Type | Description | Defined in |
|
|
13
13
|
| -------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
14
|
-
| <a id="property-base"></a> `base?` | `UserConfig` | Base Vite config to layer the browser test config on top of (typically a demo's `vite.config.ts`). When set, the base is expected to provide its own `resolve`/`plugins`, so the `cacheDir` and `resolve` defaults are not applied — mirroring the previous `mergeConfig(viteConfig, ...)` pattern in demo browser configs. | [vitest.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
15
|
-
| <a id="property-optimizedeps"></a> `optimizeDeps?` | `string`[] | Extra package specifiers to pre-bundle via `xmOptimizeDeps` (e.g. `["@xmachines/json-render-vue", "@xmachines/json-render-vue/schema"]`). Ignored when `overrides.optimizeDeps` is set, which then replaces the default `xmOptimizeDeps()` wholesale. | [vitest.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
16
|
-
| <a id="property-resolve"></a> `resolve?` | `Partial`\<`ResolveOptions` & `object`\> | Extra resolve options forwarded to `xmResolve` (e.g. `conditions` or additional `alias` entries). Not applied when `base` is set — the base config owns `resolve` in that layout. | [vitest.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
14
|
+
| <a id="property-base"></a> `base?` | `UserConfig` | Base Vite config to layer the browser test config on top of (typically a demo's `vite.config.ts`). When set, the base is expected to provide its own `resolve`/`plugins`, so the `cacheDir` and `resolve` defaults are not applied — mirroring the previous `mergeConfig(viteConfig, ...)` pattern in demo browser configs. | [vitest.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vitest.ts#L188) |
|
|
15
|
+
| <a id="property-optimizedeps"></a> `optimizeDeps?` | `string`[] | Extra package specifiers to pre-bundle via `xmOptimizeDeps` (e.g. `["@xmachines/json-render-vue", "@xmachines/json-render-vue/schema"]`). Ignored when `overrides.optimizeDeps` is set, which then replaces the default `xmOptimizeDeps()` wholesale. | [vitest.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vitest.ts#L195) |
|
|
16
|
+
| <a id="property-resolve"></a> `resolve?` | `Partial`\<`ResolveOptions` & `object`\> | Extra resolve options forwarded to `xmResolve` (e.g. `conditions` or additional `alias` entries). Not applied when `base` is set — the base config owns `resolve` in that layout. | [vitest.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/shared/config/vitest.ts#L201) |
|
package/api/trains.json
CHANGED
|
@@ -27,5 +27,57 @@
|
|
|
27
27
|
],
|
|
28
28
|
"runtime": ["@xmachines/runtime-wasi"],
|
|
29
29
|
"docs": ["@xmachines/docs"]
|
|
30
|
+
},
|
|
31
|
+
"examples": {
|
|
32
|
+
"core": [],
|
|
33
|
+
"play": [
|
|
34
|
+
"@xmachines/play-dom-gallery-demo",
|
|
35
|
+
"@xmachines/play-dom-router-demo",
|
|
36
|
+
"@xmachines/play-dom-router-donut-demo",
|
|
37
|
+
"@xmachines/play-dom-router-flight-demo",
|
|
38
|
+
"@xmachines/play-dom-router-todomvc-demo",
|
|
39
|
+
"@xmachines/play-dom-router-trivia-demo",
|
|
40
|
+
"@xmachines/play-react-gallery-demo",
|
|
41
|
+
"@xmachines/play-react-router-demo",
|
|
42
|
+
"@xmachines/play-react-router-donut-demo",
|
|
43
|
+
"@xmachines/play-react-router-flight-demo",
|
|
44
|
+
"@xmachines/play-react-router-todomvc-demo",
|
|
45
|
+
"@xmachines/play-react-router-trivia-demo",
|
|
46
|
+
"@xmachines/play-solid-gallery-demo",
|
|
47
|
+
"@xmachines/play-solid-router-demo",
|
|
48
|
+
"@xmachines/play-solid-router-donut-demo",
|
|
49
|
+
"@xmachines/play-solid-router-flight-demo",
|
|
50
|
+
"@xmachines/play-solid-router-todomvc-demo",
|
|
51
|
+
"@xmachines/play-solid-router-trivia-demo",
|
|
52
|
+
"@xmachines/play-svelte-gallery-demo",
|
|
53
|
+
"@xmachines/play-svelte-spa-router-demo",
|
|
54
|
+
"@xmachines/play-svelte-spa-router-donut-demo",
|
|
55
|
+
"@xmachines/play-svelte-spa-router-flight-demo",
|
|
56
|
+
"@xmachines/play-svelte-spa-router-todomvc-demo",
|
|
57
|
+
"@xmachines/play-svelte-spa-router-trivia-demo",
|
|
58
|
+
"@xmachines/play-sveltekit-router-demo",
|
|
59
|
+
"@xmachines/play-sveltekit-router-donut-demo",
|
|
60
|
+
"@xmachines/play-sveltekit-router-flight-demo",
|
|
61
|
+
"@xmachines/play-sveltekit-router-todomvc-demo",
|
|
62
|
+
"@xmachines/play-sveltekit-router-trivia-demo",
|
|
63
|
+
"@xmachines/play-tanstack-react-router-demo",
|
|
64
|
+
"@xmachines/play-tanstack-react-router-donut-demo",
|
|
65
|
+
"@xmachines/play-tanstack-react-router-flight-demo",
|
|
66
|
+
"@xmachines/play-tanstack-react-router-todomvc-demo",
|
|
67
|
+
"@xmachines/play-tanstack-react-router-trivia-demo",
|
|
68
|
+
"@xmachines/play-tanstack-solid-router-demo",
|
|
69
|
+
"@xmachines/play-tanstack-solid-router-donut-demo",
|
|
70
|
+
"@xmachines/play-tanstack-solid-router-flight-demo",
|
|
71
|
+
"@xmachines/play-tanstack-solid-router-todomvc-demo",
|
|
72
|
+
"@xmachines/play-tanstack-solid-router-trivia-demo",
|
|
73
|
+
"@xmachines/play-vue-gallery-demo",
|
|
74
|
+
"@xmachines/play-vue-router-demo",
|
|
75
|
+
"@xmachines/play-vue-router-donut-demo",
|
|
76
|
+
"@xmachines/play-vue-router-flight-demo",
|
|
77
|
+
"@xmachines/play-vue-router-todomvc-demo",
|
|
78
|
+
"@xmachines/play-vue-router-trivia-demo"
|
|
79
|
+
],
|
|
80
|
+
"runtime": [],
|
|
81
|
+
"docs": []
|
|
30
82
|
}
|
|
31
83
|
}
|
|
@@ -419,6 +419,8 @@ Defines the trains, the release branches, and the plugins of each run: the run o
|
|
|
419
419
|
|
|
420
420
|
**Trains:** `core` (`packages/core`), `play` (`packages/play`, `packages/play-*`), `runtime` (`packages/runtime-wasi`) and `docs` (`packages/docs`, with every file of `core`, `play` and `runtime` counting for it too). The build files of the root and `packages/shared` count for every train.
|
|
421
421
|
|
|
422
|
+
**Ecosystems:** `@wtf/semantic-release-npm/ecosystem`, the ecosystem of npm, by which the trains read the packages of each `package.json` git tracks: which train holds each, and what each depends on. It is the `./ecosystem` of the npm plugin, which the trains plugin finds beside the plugin in the global install of semantic-release, so `semrel-required-plugins.txt` names the plugin alone.
|
|
423
|
+
|
|
422
424
|
**Tag format:** `<train>-v${version}`, as `play-v7.1.0`.
|
|
423
425
|
|
|
424
426
|
**Plugin order of a branch's run:**
|
|
@@ -437,7 +439,7 @@ Defines the trains, the release branches, and the plugins of each run: the run o
|
|
|
437
439
|
|
|
438
440
|
5. `@semantic-release/git` — commits the changelog, the READMEs of the train, and of `docs` the generated docs (`api/`, `examples/@xmachines/` and the demo lists of `examples/README.md`), then pushes the commit and the tag
|
|
439
441
|
|
|
440
|
-
**Plugin order of a tag's run:** the notes generator on the train; `@wtf/semantic-release-
|
|
442
|
+
**Plugin order of a tag's run:** the notes generator on the train; `@wtf/semantic-release-npm`, which packs, smoke-tests and publishes the train's packages and packs its demos; `@semantic-release/gitlab`, the GitLab release with the tarballs. [deployment.md](deployment.md) states the whole sequence and the reason.
|
|
441
443
|
|
|
442
444
|
---
|
|
443
445
|
|
|
@@ -137,10 +137,10 @@ The `release-pack-smoke` job runs automatically on `main` and in a merge train,
|
|
|
137
137
|
|
|
138
138
|
```bash
|
|
139
139
|
pnpm run build
|
|
140
|
-
semantic-release-
|
|
140
|
+
semantic-release-npm-smoke
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
`semantic-release-
|
|
143
|
+
`semantic-release-npm-smoke`, of `@wtf/semantic-release-npm`, reads the trains of `release.config.mjs` and:
|
|
144
144
|
|
|
145
145
|
1. Packs every package of every train, and each private package of its `pack` globs, as the release packs it: each `workspace:` range resolved, the `source` export condition stripped. The globs name the demos, and the shared package of the demos, which each demo depends on and which no registry holds.
|
|
146
146
|
2. Checks each tarball: every entry of its `files` present, no `source` condition left, and no file a `forbid` glob names, as a typecheck build.
|
|
@@ -194,7 +194,7 @@ Release the trains in order: `core`, then `play`, then `runtime`, then `docs`. `
|
|
|
194
194
|
|
|
195
195
|
The job of a train runs these plugins, in this order:
|
|
196
196
|
|
|
197
|
-
1. **The analyzer and the notes generator**, each wrapped by an entry of `@wtf/semantic-release-trains` (`wrap`), which gives it the train's commits alone. Each entry of the trains plugin also checks the trains
|
|
197
|
+
1. **The analyzer and the notes generator**, each wrapped by an entry of `@wtf/semantic-release-trains` (`wrap`), which gives it the train's commits alone. Each entry of the trains plugin also checks the trains, of the packages that the ecosystem of npm, `@wtf/semantic-release-npm/ecosystem` of the config's `ecosystems`, reads of each `package.json`: no file on two of them, and the trains the train depends on released. `type!:` is a breaking change, by `parserOpts` at the root of the config.
|
|
198
198
|
2. **`@semantic-release/changelog`** writes the train's changelog, the `CHANGELOG.md` of its first path: `packages/core/CHANGELOG.md`, `packages/play/CHANGELOG.md`, `packages/runtime-wasi/CHANGELOG.md`, `packages/docs/CHANGELOG.md`. The root `CHANGELOG.md` holds the history up to 7.0.0.
|
|
199
199
|
3. **`@wtf/semantic-release-replace`** writes the version into the badge of each README of the train, by the `badge` template at the root of the config: a RegExp of the badge of shields.io, its version written as `shields` escapes it. `tests/readme-badges.test.ts` holds the template to every badge of the READMEs.
|
|
200
200
|
4. **Of `docs` alone**, the reference: `corepack enable`, `pnpm install --frozen-lockfile`, `pnpm run build`, TypeDoc at the revision `docs-v${nextRelease.version}`, and `oxfmt` of the docs package, each a `@semantic-release/exec` step. Then an entry of `@wtf/semantic-release-trains` of `generated: true` stages the trees TypeDoc writes, deletions too: the git plugin stages what `git ls-files -m -o` reports, which never reports a deletion, so a page of an export that was renamed or removed would stay in git for ever.
|
|
@@ -215,7 +215,7 @@ The job of a train runs these plugins, in this order:
|
|
|
215
215
|
The tag's pipeline builds the tagged commit, and its `publish-release` job runs `semantic-release-trains-tag`, of `@wtf/semantic-release-trains`. It runs semantic-release's own config, plugins and branches for the tag, with its version and its channel, and the plugins of the tag's run of `release.config.mjs`:
|
|
216
216
|
|
|
217
217
|
1. **The notes generator**, on the train, writes the notes again of the same commits.
|
|
218
|
-
2. **`@wtf/semantic-release-
|
|
218
|
+
2. **`@wtf/semantic-release-npm`** packs each package of the train into `dist/releases/`, the demos too, with each `workspace:` range resolved (a package of the same train to the release's version, one of another train to that train's last release) and the `source` export condition stripped; runs the smoke test of the tarballs; and publishes each package that is not private, in the order of their dependencies, under the dist-tag of the channel, with provenance. `NPM_DIST_TAG` overrides the dist-tag for a one-off.
|
|
219
219
|
3. **`@semantic-release/gitlab`** creates the GitLab release of the tag, its notes those of the release, its assets every tarball of `dist/releases/` — after the publish succeeded, so a release entry never advertises a tarball that npm refused.
|
|
220
220
|
|
|
221
221
|
The tag pipeline is what makes the provenance attestation meaningful. npm records the commit of the pipeline in the attestation. On a tag pipeline that commit IS the commit that the tag names. A publish from the branch pipeline attests the PARENT of the release commit instead: a revision that the tag does not name.
|
|
@@ -375,9 +375,7 @@ Then, for EACH package:
|
|
|
375
375
|
To preview what the release of a train would do, without a tag and without a publish:
|
|
376
376
|
|
|
377
377
|
```bash
|
|
378
|
-
npm install --global semantic-release@25
|
|
379
|
-
@semantic-release/git @semantic-release/gitlab @wtf/semantic-release-trains \
|
|
380
|
-
@wtf/semantic-release-replace @wtf/semantic-release-trains-publish
|
|
378
|
+
npm install --global semantic-release@25 $(cat semrel-required-plugins.txt)
|
|
381
379
|
RELEASE_TRAIN=play semantic-release --dry-run --no-ci
|
|
382
380
|
```
|
|
383
381
|
|
|
@@ -385,7 +383,7 @@ To test the packaging locally (the same check run by `release-pack-smoke` in CI)
|
|
|
385
383
|
|
|
386
384
|
```bash
|
|
387
385
|
pnpm run build
|
|
388
|
-
semantic-release-
|
|
386
|
+
semantic-release-npm-smoke
|
|
389
387
|
```
|
|
390
388
|
|
|
391
389
|
**Do not run `npm publish` manually.** All publishing must go through the release in CI to keep the changelogs, git tags, and npm versions in sync. [Bootstrapping a New Package](#bootstrapping-a-new-package) is the ONE exception, and it publishes a version that holds no code.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function createConfirmDialog(confirm): Promise<boolean>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-dom/examples/gallery/src/components/ConfirmDialog.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-dom/examples/gallery/src/components/ConfirmDialog.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/components/ConfirmDialog.ts#L18)
|
|
10
10
|
|
|
11
11
|
ConfirmDialog — the gallery's `onConfirm` implementation.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function createDebugPanel(actor, container, inspector): () => void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-dom/examples/gallery/src/components/DebugPanel.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-dom/examples/gallery/src/components/DebugPanel.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/components/DebugPanel.ts#L17)
|
|
10
10
|
|
|
11
11
|
DebugPanel — live debug footer factory. Appends the footer to `container`,
|
|
12
12
|
shows the current state value, renders the button that opens the Stately
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function initApp(container): () => void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-dom/examples/gallery/src/App.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-dom/examples/gallery/src/App.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/App.ts#L33)
|
|
10
10
|
|
|
11
11
|
Mount the gallery into `container` and return a cleanup function that stops
|
|
12
12
|
whatever actor is live and empties the container.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function initShell(container, options): () => void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-dom/examples/gallery/src/components/Shell.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
9
|
+
Defined in: [packages/play-dom/examples/gallery/src/components/Shell.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/components/Shell.ts#L35)
|
|
10
10
|
|
|
11
11
|
Shell — DOM shell layout factory.
|
|
12
12
|
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: GalleryMachineEntry
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-dom/examples/gallery/src/machines.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
5
|
+
Defined in: [packages/play-dom/examples/gallery/src/machines.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L85)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
9
9
|
| Property | Type | Description | Defined in |
|
|
10
10
|
| --------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11
|
-
| <a id="property-createruntime"></a> `createRuntime` | (`inspect`) => [`GalleryRuntime`](GalleryRuntime.md) | Create a fresh, STARTED actor and its registry for one selection. The caller owns the runtime and must stop the actor when done with it. | [packages/play-dom/examples/gallery/src/machines.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
12
|
-
| <a id="property-label"></a> `label` | `string` | Picker button label and machine-view title. | [packages/play-dom/examples/gallery/src/machines.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
13
|
-
| <a id="property-slug"></a> `slug` | [`GallerySlug`](../type-aliases/GallerySlug.md) | - | [packages/play-dom/examples/gallery/src/machines.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
11
|
+
| <a id="property-createruntime"></a> `createRuntime` | (`inspect`) => [`GalleryRuntime`](GalleryRuntime.md) | Create a fresh, STARTED actor and its registry for one selection. The caller owns the runtime and must stop the actor when done with it. | [packages/play-dom/examples/gallery/src/machines.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L93) |
|
|
12
|
+
| <a id="property-label"></a> `label` | `string` | Picker button label and machine-view title. | [packages/play-dom/examples/gallery/src/machines.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L88) |
|
|
13
|
+
| <a id="property-slug"></a> `slug` | [`GallerySlug`](../type-aliases/GallerySlug.md) | - | [packages/play-dom/examples/gallery/src/machines.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L86) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: GalleryRuntime
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-dom/examples/gallery/src/machines.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
5
|
+
Defined in: [packages/play-dom/examples/gallery/src/machines.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L80)
|
|
6
6
|
|
|
7
7
|
One live selection: the started actor plus its registry.
|
|
8
8
|
|
|
@@ -10,5 +10,5 @@ One live selection: the started actor plus its registry.
|
|
|
10
10
|
|
|
11
11
|
| Property | Type | Defined in |
|
|
12
12
|
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
-
| <a id="property-actor"></a> `actor` | [`GalleryActor`](../type-aliases/GalleryActor.md) | [packages/play-dom/examples/gallery/src/machines.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
14
|
-
| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](../../../../api/@xmachines/play-dom/interfaces/DefineRegistryResult.md) | [packages/play-dom/examples/gallery/src/machines.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.
|
|
13
|
+
| <a id="property-actor"></a> `actor` | [`GalleryActor`](../type-aliases/GalleryActor.md) | [packages/play-dom/examples/gallery/src/machines.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L81) |
|
|
14
|
+
| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](../../../../api/@xmachines/play-dom/interfaces/DefineRegistryResult.md) | [packages/play-dom/examples/gallery/src/machines.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-dom/examples/gallery/src/machines.ts#L82) |
|