deno.land / x / xstate@xstate@4.33.6 / src / types.ts
نووسراو ببینە
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908import { Clock, Interpreter } from './interpreter';import { Model } from './model.types';import { State } from './State';import { StateNode } from './StateNode';import { MarkAllImplementationsAsProvided, TypegenDisabled, ResolveTypegenMeta, TypegenConstraint, AreAllImplementationsAssumedToBeProvided, TypegenEnabled} from './typegenTypes';
export type AnyFunction = (...args: any[]) => any;type ReturnTypeOrValue<T> = T extends AnyFunction ? ReturnType<T> : T;
// https://github.com/microsoft/TypeScript/issues/23182#issuecomment-379091887export type IsNever<T> = [T] extends [never] ? true : false;
export type Compute<A extends any> = { [K in keyof A]: A[K] } & unknown;export type Prop<T, K> = K extends keyof T ? T[K] : never;export type Values<T> = T[keyof T];export type Merge<M, N> = Omit<M, keyof N> & N;// TODO: replace in v5 with:// export type IndexByType<T extends { type: string }> = { [E in T as E['type']]: E; };export type IndexByType<T extends { type: string }> = { [K in T['type']]: T extends any ? (K extends T['type'] ? T : never) : never;};
export type Equals<A1 extends any, A2 extends any> = (<A>() => A extends A2 ? true : false) extends <A>() => A extends A1 ? true : false ? true : false;export type IsAny<T> = Equals<T, any>;export type Cast<A, B> = A extends B ? A : B;export type NoInfer<T> = [T][T extends any ? 0 : any];export type LowInfer<T> = T & {};
export type EventType = string;export type ActionType = string;export type MetaObject = Record<string, any>;
/** * The full definition of an event, with a string `type`. */export interface EventObject { /** * The type of event that is sent. */ type: string;}
export interface AnyEventObject extends EventObject { [key: string]: any;}
export interface BaseActionObject { /** * The type of action that is executed. */ type: string; [other: string]: any;}
/** * The full definition of an action, with a string `type` and an * `exec` implementation function. */export interface ActionObject<TContext, TEvent extends EventObject> extends BaseActionObject { /** * The implementation for executing the action. */ exec?: ActionFunction<TContext, TEvent> | undefined;}
export type DefaultContext = Record<string, any> | undefined;
export type EventData = Record<string, any> & { type?: never };
/** * The specified string event types or the specified event objects. */export type Event<TEvent extends EventObject> = TEvent['type'] | TEvent;
export interface ActionMeta< TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> extends StateMeta<TContext, TEvent> { action: TAction; _event: SCXML.Event<TEvent>;}
export interface AssignMeta<TContext, TEvent extends EventObject> { state?: State<TContext, TEvent>; action: AssignAction<TContext, TEvent>; _event: SCXML.Event<TEvent>;}
export type ActionFunction< TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> = { bivarianceHack( context: TContext, event: TEvent, meta: ActionMeta<TContext, TEvent, TAction> ): void;}['bivarianceHack'];
export interface ChooseCondition<TContext, TEvent extends EventObject> { cond?: Condition<TContext, TEvent>; actions: Actions<TContext, TEvent>;}
export type Action<TContext, TEvent extends EventObject> = | ActionType | ActionObject<TContext, TEvent> | ActionFunction<TContext, TEvent>;
/** * Extracts action objects that have no extra properties. */type SimpleActionsOf<T extends BaseActionObject> = ActionObject< any, any> extends T ? T // If actions are unspecified, all action types are allowed (unsafe) : ExtractWithSimpleSupport<T>;
/** * Events that do not require payload */export type SimpleEventsOf< TEvent extends EventObject> = ExtractWithSimpleSupport<TEvent>;
export type BaseAction< TContext, TEvent extends EventObject, TAction extends BaseActionObject> = | SimpleActionsOf<TAction>['type'] | TAction | RaiseAction<any> | SendAction<TContext, TEvent, any> | AssignAction<TContext, TEvent> | LogAction<TContext, TEvent> | CancelAction | StopAction<TContext, TEvent> | ChooseAction<TContext, TEvent> | ActionFunction<TContext, TEvent>;
export type BaseActions< TContext, TEvent extends EventObject, TAction extends BaseActionObject> = SingleOrArray<BaseAction<TContext, TEvent, TAction>>;
export type Actions<TContext, TEvent extends EventObject> = SingleOrArray< Action<TContext, TEvent>>;
export type StateKey = string | AnyState;
export interface StateValueMap { [key: string]: StateValue;}
/** * The string or object representing the state value relative to the parent state node. * * - For a child atomic state node, this is a string, e.g., `"pending"`. * - For complex state nodes, this is an object, e.g., `{ success: "someChildState" }`. */export type StateValue = string | StateValueMap;
export interface HistoryValue { states: Record<string, HistoryValue | undefined>; current: StateValue | undefined;}
export type ConditionPredicate<TContext, TEvent extends EventObject> = ( context: TContext, event: TEvent, meta: GuardMeta<TContext, TEvent>) => boolean;
export type DefaultGuardType = 'xstate.guard';
export interface GuardPredicate<TContext, TEvent extends EventObject> { type: DefaultGuardType; name: string | undefined; predicate: ConditionPredicate<TContext, TEvent>;}
export type Guard<TContext, TEvent extends EventObject> = | GuardPredicate<TContext, TEvent> | (Record<string, any> & { type: string; });
export interface GuardMeta<TContext, TEvent extends EventObject> extends StateMeta<TContext, TEvent> { cond: Guard<TContext, TEvent>;}
export type Condition<TContext, TEvent extends EventObject> = | string | ConditionPredicate<TContext, TEvent> | Guard<TContext, TEvent>;
export type TransitionTarget< TContext, TEvent extends EventObject> = SingleOrArray<string | StateNode<TContext, any, TEvent>>;
export type TransitionTargets<TContext> = Array< string | StateNode<TContext, any>>;
export interface TransitionConfig<TContext, TEvent extends EventObject> { cond?: Condition<TContext, TEvent>; actions?: Actions<TContext, TEvent>; in?: StateValue; internal?: boolean; target?: TransitionTarget<TContext, TEvent> | undefined; meta?: Record<string, any>; description?: string;}
export interface TargetTransitionConfig<TContext, TEvent extends EventObject> extends TransitionConfig<TContext, TEvent> { target: TransitionTarget<TContext, TEvent>; // TODO: just make this non-optional}
export type ConditionalTransitionConfig< TContext, TEvent extends EventObject = EventObject> = Array<TransitionConfig<TContext, TEvent>>;
export type Transition<TContext, TEvent extends EventObject = EventObject> = | string | TransitionConfig<TContext, TEvent> | ConditionalTransitionConfig<TContext, TEvent>;
export type DisposeActivityFunction = () => void;
export type ActivityConfig<TContext, TEvent extends EventObject> = ( ctx: TContext, activity: ActivityDefinition<TContext, TEvent>) => DisposeActivityFunction | void;
export type Activity<TContext, TEvent extends EventObject> = | string | ActivityDefinition<TContext, TEvent>;
export interface ActivityDefinition<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { id: string; type: string;}
export type Sender<TEvent extends EventObject> = (event: Event<TEvent>) => void;
type ExcludeType<A> = { [K in Exclude<keyof A, 'type'>]: A[K] };
type ExtractExtraParameters<A, T> = A extends { type: T } ? ExcludeType<A> : never;
type ExtractWithSimpleSupport<T extends { type: string }> = T extends any ? { type: T['type'] } extends T ? T : never : never;
type NeverIfEmpty<T> = {} extends T ? never : T;
export interface PayloadSender<TEvent extends EventObject> { /** * Send an event object or just the event type, if the event has no other payload */ (event: TEvent | ExtractWithSimpleSupport<TEvent>['type']): void; /** * Send an event type and its payload */ <K extends TEvent['type']>( eventType: K, payload: NeverIfEmpty<ExtractExtraParameters<TEvent, K>> ): void;}
export type Receiver<TEvent extends EventObject> = ( listener: { bivarianceHack(event: TEvent): void; }['bivarianceHack']) => void;
export type InvokeCallback< TEvent extends EventObject = AnyEventObject, TSentEvent extends EventObject = AnyEventObject> = ( callback: Sender<TSentEvent>, onReceive: Receiver<TEvent>) => (() => void) | Promise<any> | void;
export interface InvokeMeta { data: any; src: InvokeSourceDefinition; meta?: MetaObject;}
/** * Returns either a Promises or a callback handler (for streams of events) given the * machine's current `context` and `event` that invoked the service. * * For Promises, the only events emitted to the parent will be: * - `done.invoke.<id>` with the `data` containing the resolved payload when the promise resolves, or: * - `error.platform.<id>` with the `data` containing the caught error, and `src` containing the service `id`. * * For callback handlers, the `callback` will be provided, which will send events to the parent service. * * @param context The current machine `context` * @param event The event that invoked the service */export type InvokeCreator< TContext, TSourceEvent extends EventObject, TFinalContext = any, // those two are named from the perspective of the created invoke TInputEvent extends EventObject = any, // keeping a slot for it here, but it's actually not used right now to ensure that the communication contract between actors is satisfied TOutputEvent extends EventObject = TSourceEvent // this default doesn't make a lot of sense, it's used like this just to be compatible with the previous version of this signature,> = ( context: TContext, event: TSourceEvent, meta: InvokeMeta) => | PromiseLike<TFinalContext> | StateMachine<TFinalContext, any, any, any, any, any, any> | Subscribable<EventObject> | InvokeCallback<TInputEvent, TOutputEvent> | Behavior<any>;
export interface InvokeDefinition<TContext, TEvent extends EventObject> extends ActivityDefinition<TContext, TEvent> { /** * The source of the machine to be invoked, or the machine itself. */ src: string | InvokeSourceDefinition; // TODO: deprecate string (breaking change for V4) /** * If `true`, events sent to the parent service will be forwarded to the invoked service. * * Default: `false` */ autoForward?: boolean; /** * @deprecated * * Use `autoForward` property instead of `forward`. Support for `forward` will get removed in the future. */ forward?: boolean; /** * Data from the parent machine's context to set as the (partial or full) context * for the invoked child machine. * * Data should be mapped to match the child machine's context shape. */ data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>; meta?: MetaObject;}
export interface Delay { id: string; /** * The time to delay the event, in milliseconds. */ delay: number;}
export type DelayedTransitions<TContext, TEvent extends EventObject> = | Record< string | number, string | SingleOrArray<TransitionConfig<TContext, TEvent>> > | Array< TransitionConfig<TContext, TEvent> & { delay: number | string | Expr<TContext, TEvent, number>; } >;
export type StateTypes = | 'atomic' | 'compound' | 'parallel' | 'final' | 'history' | string; // TODO: remove once TS fixes this type-widening issue
export type SingleOrArray<T> = T[] | T;
export type StateNodesConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject> = { [K in keyof TStateSchema['states']]: StateNode< TContext, TStateSchema['states'][K] & {}, TEvent >;};
export type StatesConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> = { [K in keyof TStateSchema['states']]: StateNodeConfig< TContext, TStateSchema['states'][K] & {}, TEvent, TAction >;};
export type StatesDefinition< TContext, TStateSchema extends StateSchema, TEvent extends EventObject> = { [K in keyof TStateSchema['states']]: StateNodeDefinition< TContext, TStateSchema['states'][K] & {}, TEvent >;};
export type TransitionConfigTarget<TContext, TEvent extends EventObject> = | string | undefined | StateNode<TContext, any, TEvent>;
export type TransitionConfigOrTarget< TContext, TEvent extends EventObject> = SingleOrArray< TransitionConfigTarget<TContext, TEvent> | TransitionConfig<TContext, TEvent>>;
export type TransitionsConfigMap<TContext, TEvent extends EventObject> = { [K in TEvent['type'] | '' | '*']?: K extends '' | '*' ? TransitionConfigOrTarget<TContext, TEvent> : TransitionConfigOrTarget<TContext, ExtractEvent<TEvent, K>>;};
type TransitionsConfigArray<TContext, TEvent extends EventObject> = Array< // distribute the union | (TEvent extends EventObject ? TransitionConfig<TContext, TEvent> & { event: TEvent['type'] } : never) | (TransitionConfig<TContext, TEvent> & { event: '' }) | (TransitionConfig<TContext, TEvent> & { event: '*' })>;
export type TransitionsConfig<TContext, TEvent extends EventObject> = | TransitionsConfigMap<TContext, TEvent> | TransitionsConfigArray<TContext, TEvent>;
export interface InvokeSourceDefinition { [key: string]: any; type: string;}
export interface InvokeConfig<TContext, TEvent extends EventObject> { /** * The unique identifier for the invoked machine. If not specified, this * will be the machine's own `id`, or the URL (from `src`). */ id?: string; /** * The source of the machine to be invoked, or the machine itself. */ src: | string | InvokeSourceDefinition | AnyStateMachine | InvokeCreator<TContext, TEvent, any>; /** * If `true`, events sent to the parent service will be forwarded to the invoked service. * * Default: `false` */ autoForward?: boolean; /** * @deprecated * * Use `autoForward` property instead of `forward`. Support for `forward` will get removed in the future. */ forward?: boolean; /** * Data from the parent machine's context to set as the (partial or full) context * for the invoked child machine. * * Data should be mapped to match the child machine's context shape. */ data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>; /** * The transition to take upon the invoked child machine reaching its final top-level state. */ onDone?: | string | SingleOrArray<TransitionConfig<TContext, DoneInvokeEvent<any>>>; /** * The transition to take upon the invoked child machine sending an error event. */ onError?: | string | SingleOrArray<TransitionConfig<TContext, DoneInvokeEvent<any>>>; /** * Meta data related to this invocation */ meta?: MetaObject;}
export interface StateNodeConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> { /** * The relative key of the state node, which represents its location in the overall state value. * This is automatically determined by the configuration shape via the key where it was defined. */ key?: string; /** * The initial state node key. */ initial?: keyof TStateSchema['states'] | undefined; /** * @deprecated */ parallel?: boolean | undefined; /** * The type of this state node: * * - `'atomic'` - no child state nodes * - `'compound'` - nested child state nodes (XOR) * - `'parallel'` - orthogonal nested child state nodes (AND) * - `'history'` - history state node * - `'final'` - final state node */ type?: 'atomic' | 'compound' | 'parallel' | 'final' | 'history'; /** * Indicates whether the state node is a history state node, and what * type of history: * shallow, deep, true (shallow), false (none), undefined (none) */ history?: 'shallow' | 'deep' | boolean | undefined; /** * The mapping of state node keys to their state node configurations (recursive). */ states?: StatesConfig<TContext, TStateSchema, TEvent, TAction> | undefined; /** * The services to invoke upon entering this state node. These services will be stopped upon exiting this state node. */ invoke?: SingleOrArray<InvokeConfig<TContext, TEvent> | AnyStateMachine>; /** * The mapping of event types to their potential transition(s). */ on?: TransitionsConfig<TContext, TEvent>; /** * The action(s) to be executed upon entering the state node. * * @deprecated Use `entry` instead. */ onEntry?: Actions<TContext, TEvent>; // TODO: deprecate /** * The action(s) to be executed upon entering the state node. */ entry?: BaseActions<TContext, TEvent, TAction>; /** * The action(s) to be executed upon exiting the state node. * * @deprecated Use `exit` instead. */ onExit?: Actions<TContext, TEvent>; // TODO: deprecate /** * The action(s) to be executed upon exiting the state node. */ exit?: BaseActions<TContext, TEvent, TAction>; /** * The potential transition(s) to be taken upon reaching a final child state node. * * This is equivalent to defining a `[done(id)]` transition on this state node's `on` property. */ onDone?: | string | SingleOrArray<TransitionConfig<TContext, DoneEventObject>> | undefined; /** * The mapping (or array) of delays (in milliseconds) to their potential transition(s). * The delayed transitions are taken after the specified delay in an interpreter. */ after?: DelayedTransitions<TContext, TEvent>;
/** * An eventless transition that is always taken when this state node is active. * Equivalent to a transition specified as an empty `''`' string in the `on` property. */ always?: TransitionConfigOrTarget<TContext, TEvent>; /** * The activities to be started upon entering the state node, * and stopped upon exiting the state node. * * @deprecated Use `invoke` instead. */ activities?: SingleOrArray<Activity<TContext, TEvent>>; /** * @private */ parent?: StateNode<TContext, any, TEvent>; strict?: boolean | undefined; /** * The meta data associated with this state node, which will be returned in State instances. */ meta?: TStateSchema extends { meta: infer D } ? D : any; /** * The data sent with the "done.state._id_" event if this is a final state node. * * The data will be evaluated with the current `context` and placed on the `.data` property * of the event. */ data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>; /** * The unique ID of the state node, which can be referenced as a transition target via the * `#id` syntax. */ id?: string | undefined; /** * The string delimiter for serializing the path to a string. The default is "." */ delimiter?: string; /** * The order this state node appears. Corresponds to the implicit SCXML document order. */ order?: number;
/** * The tags for this state node, which are accumulated into the `state.tags` property. */ tags?: SingleOrArray<string>; /** * Whether actions should be called in order. * When `false` (default), `assign(...)` actions are prioritized before other actions. * * @default false */ preserveActionOrder?: boolean; /** * Whether XState calls actions with the event directly responsible for the related transition. * * @default false */ predictableActionArguments?: boolean; /** * A text description of the state node */ description?: string;}
export interface StateNodeDefinition< TContext, TStateSchema extends StateSchema, TEvent extends EventObject> { id: string; version: string | undefined; key: string; context: TContext; type: 'atomic' | 'compound' | 'parallel' | 'final' | 'history'; initial: StateNodeConfig<TContext, TStateSchema, TEvent>['initial']; history: boolean | 'shallow' | 'deep' | undefined; states: StatesDefinition<TContext, TStateSchema, TEvent>; on: TransitionDefinitionMap<TContext, TEvent>; transitions: Array<TransitionDefinition<TContext, TEvent>>; entry: Array<ActionObject<TContext, TEvent>>; exit: Array<ActionObject<TContext, TEvent>>; /** * @deprecated */ activities: Array<ActivityDefinition<TContext, TEvent>>; meta: any; order: number; data?: FinalStateNodeConfig<TContext, TEvent>['data']; invoke: Array<InvokeDefinition<TContext, TEvent>>; description?: string; tags: string[];}
export type AnyStateNodeDefinition = StateNodeDefinition<any, any, any>;
export type AnyState = State<any, any, any, any, any>;
export type AnyStateMachine = StateMachine<any, any, any, any, any, any, any>;
export interface AtomicStateNodeConfig<TContext, TEvent extends EventObject> extends StateNodeConfig<TContext, StateSchema, TEvent> { initial?: undefined; parallel?: false | undefined; states?: undefined; onDone?: undefined;}
export interface HistoryStateNodeConfig<TContext, TEvent extends EventObject> extends AtomicStateNodeConfig<TContext, TEvent> { history: 'shallow' | 'deep' | true; target: StateValue | undefined;}
export interface FinalStateNodeConfig<TContext, TEvent extends EventObject> extends AtomicStateNodeConfig<TContext, TEvent> { type: 'final'; /** * The data to be sent with the "done.state.<id>" event. The data can be * static or dynamic (based on assigners). */ data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>;}
export type SimpleOrStateNodeConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject> = | AtomicStateNodeConfig<TContext, TEvent> | StateNodeConfig<TContext, TStateSchema, TEvent>;
export type ActionFunctionMap< TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> = { [K in TAction['type']]?: | ActionObject<TContext, TEvent> | ActionFunction< TContext, TEvent, TAction extends { type: K } ? TAction : never >;};
export type DelayFunctionMap<TContext, TEvent extends EventObject> = Record< string, DelayConfig<TContext, TEvent>>;
export type ServiceConfig< TContext, TEvent extends EventObject = AnyEventObject> = string | AnyStateMachine | InvokeCreator<TContext, TEvent>;
export type DelayConfig<TContext, TEvent extends EventObject> = | number | DelayExpr<TContext, TEvent>;
type MachineOptionsActions< TContext, TResolvedTypesMeta, TEventsCausingActions = Prop< Prop<TResolvedTypesMeta, 'resolved'>, 'eventsCausingActions' >, TIndexedEvents = Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'indexedEvents'>, TIndexedActions = Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'indexedActions'>> = { [K in keyof TEventsCausingActions]?: | ActionObject< TContext, Cast<Prop<TIndexedEvents, TEventsCausingActions[K]>, EventObject> > | ActionFunction< TContext, Cast<Prop<TIndexedEvents, TEventsCausingActions[K]>, EventObject>, Cast<Prop<TIndexedActions, K>, BaseActionObject> >;};
type MachineOptionsDelays< TContext, TResolvedTypesMeta, TEventsCausingDelays = Prop< Prop<TResolvedTypesMeta, 'resolved'>, 'eventsCausingDelays' >, TIndexedEvents = Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'indexedEvents'>> = { [K in keyof TEventsCausingDelays]?: DelayConfig< TContext, Cast<Prop<TIndexedEvents, TEventsCausingDelays[K]>, EventObject> >;};
type MachineOptionsGuards< TContext, TResolvedTypesMeta, TEventsCausingGuards = Prop< Prop<TResolvedTypesMeta, 'resolved'>, 'eventsCausingGuards' >, TIndexedEvents = Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'indexedEvents'>> = { [K in keyof TEventsCausingGuards]?: ConditionPredicate< TContext, Cast<Prop<TIndexedEvents, TEventsCausingGuards[K]>, EventObject> >;};
type MachineOptionsServices< TContext, TResolvedTypesMeta, TEventsCausingServices = Prop< Prop<TResolvedTypesMeta, 'resolved'>, 'eventsCausingServices' >, TIndexedEvents = Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'indexedEvents'>, TInvokeSrcNameMap = Prop< Prop<TResolvedTypesMeta, 'resolved'>, 'invokeSrcNameMap' >> = { [K in keyof TEventsCausingServices]?: | AnyStateMachine | InvokeCreator< TContext, Cast<Prop<TIndexedEvents, TEventsCausingServices[K]>, EventObject>, Prop<Prop<TIndexedEvents, Prop<TInvokeSrcNameMap, K>>, 'data'>, EventObject, Cast<TIndexedEvents[keyof TIndexedEvents], EventObject> // it would make sense to pass `TEvent` around to use it here directly >;};
type MakeKeysRequired<T extends string> = { [K in T]: unknown };
type MaybeMakeMissingImplementationsRequired< TImplementationType, TMissingImplementationsForType, TRequireMissingImplementations> = TRequireMissingImplementations extends true ? IsNever<TMissingImplementationsForType> extends true ? {} : { [K in Cast<TImplementationType, string>]: MakeKeysRequired< Cast<TMissingImplementationsForType, string> >; } : {};
type GenerateActionsConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired< 'actions', Prop<TMissingImplementations, 'actions'>, TRequireMissingImplementations> & { actions?: MachineOptionsActions<TContext, TResolvedTypesMeta>;};
type GenerateDelaysConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired< 'delays', Prop<TMissingImplementations, 'delays'>, TRequireMissingImplementations> & { delays?: MachineOptionsDelays<TContext, TResolvedTypesMeta>;};
type GenerateGuardsConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired< 'guards', Prop<TMissingImplementations, 'guards'>, TRequireMissingImplementations> & { guards?: MachineOptionsGuards<TContext, TResolvedTypesMeta>;};
type GenerateServicesConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired< 'services', Prop<TMissingImplementations, 'services'>, TRequireMissingImplementations> & { services?: MachineOptionsServices<TContext, TResolvedTypesMeta>;};
export type InternalMachineOptions< TContext, TEvent extends EventObject, TResolvedTypesMeta, TRequireMissingImplementations extends boolean = false, TMissingImplementations = Prop< Prop<TResolvedTypesMeta, 'resolved'>, 'missingImplementations' >> = GenerateActionsConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateDelaysConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations > & GenerateGuardsConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations > & GenerateServicesConfigPart< TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations > & { /** * @deprecated Use `services` instead. */ activities?: Record<string, ActivityConfig<TContext, TEvent>>; };
export type MachineOptions< TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TTypesMeta extends TypegenConstraint = TypegenDisabled> = InternalMachineOptions< TContext, TEvent, ResolveTypegenMeta<TTypesMeta, TEvent, TAction, TServiceMap>>;
export interface MachineConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TTypesMeta = TypegenDisabled> extends StateNodeConfig< NoInfer<TContext>, TStateSchema, NoInfer<TEvent>, TAction > { /** * The initial context (extended state) */ context?: LowInfer<TContext | (() => TContext)>; /** * The machine's own version. */ version?: string; schema?: MachineSchema<TContext, TEvent, TServiceMap>; tsTypes?: TTypesMeta;}
export type ServiceMap = Record<string, { data: any }>;export interface MachineSchema< TContext, TEvent extends EventObject, TServiceMap extends ServiceMap = ServiceMap> { context?: TContext; events?: TEvent; actions?: { type: string; [key: string]: any }; guards?: { type: string; [key: string]: any }; services?: TServiceMap;}
export interface StandardMachineConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject> extends StateNodeConfig<TContext, TStateSchema, TEvent> {}
export interface ParallelMachineConfig< TContext, TStateSchema extends StateSchema, TEvent extends EventObject> extends StateNodeConfig<TContext, TStateSchema, TEvent> { initial?: undefined; type?: 'parallel';}
export interface EntryExitEffectMap<TContext, TEvent extends EventObject> { entry: Array<ActionObject<TContext, TEvent>>; exit: Array<ActionObject<TContext, TEvent>>;}
export interface HistoryStateNode<TContext> extends StateNode<TContext> { history: 'shallow' | 'deep'; target: StateValue | undefined;}
/** @ts-ignore TS complains about withConfig & withContext not being compatible here when extending StateNode */export interface StateMachine< TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TTypestate extends Typestate<TContext> = { value: any; context: TContext }, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TResolvedTypesMeta = ResolveTypegenMeta< TypegenDisabled, NoInfer<TEvent>, TAction, TServiceMap >> extends StateNode< TContext, TStateSchema, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta > { id: string; states: StateNode< TContext, TStateSchema, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta >['states'];
withConfig( options: InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, true>, context?: TContext | (() => TContext) ): StateMachine< TContext, TStateSchema, TEvent, TTypestate, TAction, TServiceMap, AreAllImplementationsAssumedToBeProvided<TResolvedTypesMeta> extends false ? MarkAllImplementationsAsProvided<TResolvedTypesMeta> : TResolvedTypesMeta >;
withContext( context: TContext | (() => TContext) ): StateMachine< TContext, TStateSchema, TEvent, TTypestate, TAction, TServiceMap, TResolvedTypesMeta >;
/** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TContext: TContext; /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TStateSchema: TStateSchema; /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TEvent: TEvent; /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TTypestate: TTypestate; /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TAction: TAction; /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TServiceMap: TServiceMap; /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */ __TResolvedTypesMeta: TResolvedTypesMeta;}
export type StateFrom< T extends AnyStateMachine | ((...args: any[]) => AnyStateMachine)> = T extends AnyStateMachine ? ReturnType<T['transition']> : T extends (...args: any[]) => AnyStateMachine ? ReturnType<ReturnType<T>['transition']> : never;
export interface ActionMap<TContext, TEvent extends EventObject> { onEntry: Array<Action<TContext, TEvent>>; actions: Array<Action<TContext, TEvent>>; onExit: Array<Action<TContext, TEvent>>;}
export interface EntryExitStates<TContext> { entry: Set<StateNode<TContext>>; exit: Set<StateNode<TContext>>;}
export interface EntryExitStateArrays<TContext> { entry: Array<StateNode<TContext>>; exit: Array<StateNode<TContext>>;}
export interface ActivityMap { [activityKey: string]: ActivityDefinition<any, any> | false;}
// tslint:disable-next-line:class-nameexport interface StateTransition<TContext, TEvent extends EventObject> { transitions: Array<TransitionDefinition<TContext, TEvent>>; configuration: Array<StateNode<TContext, any, TEvent, any, any, any>>; entrySet: Array<StateNode<TContext, any, TEvent, any, any, any>>; exitSet: Array<StateNode<TContext, any, TEvent, any, any, any>>; /** * The source state that preceded the transition. */ source: State<TContext, any, any, any, any> | undefined; actions: Array<ActionObject<TContext, TEvent>>;}
export interface TransitionData<TContext, TEvent extends EventObject> { value: StateValue | undefined; actions: ActionMap<TContext, TEvent>; activities?: ActivityMap;}
export enum ActionTypes { Start = 'xstate.start', Stop = 'xstate.stop', Raise = 'xstate.raise', Send = 'xstate.send', Cancel = 'xstate.cancel', NullEvent = '', Assign = 'xstate.assign', After = 'xstate.after', DoneState = 'done.state', DoneInvoke = 'done.invoke', Log = 'xstate.log', Init = 'xstate.init', Invoke = 'xstate.invoke', ErrorExecution = 'error.execution', ErrorCommunication = 'error.communication', ErrorPlatform = 'error.platform', ErrorCustom = 'xstate.error', Update = 'xstate.update', Pure = 'xstate.pure', Choose = 'xstate.choose'}
export interface RaiseAction<TEvent extends EventObject> { type: ActionTypes.Raise; event: TEvent['type'];}
export interface RaiseActionObject<TEvent extends EventObject> { type: ActionTypes.Raise; _event: SCXML.Event<TEvent>;}
export interface DoneInvokeEvent<TData> extends EventObject { data: TData;}
export interface ErrorExecutionEvent extends EventObject { src: string; type: ActionTypes.ErrorExecution; data: any;}
export interface ErrorPlatformEvent extends EventObject { data: any;}
export interface DoneEventObject extends EventObject { data?: any; toString(): string;}
export interface UpdateObject extends EventObject { id: string | number; state: AnyState;}
export type DoneEvent = DoneEventObject & string;
export interface NullEvent { type: ActionTypes.NullEvent;}
export interface ActivityActionObject<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { type: ActionTypes.Start | ActionTypes.Stop; activity: ActivityDefinition<TContext, TEvent> | undefined; exec: ActionFunction<TContext, TEvent> | undefined;}
export interface InvokeActionObject<TContext, TEvent extends EventObject> extends ActivityActionObject<TContext, TEvent> { activity: InvokeDefinition<TContext, TEvent>;}
export type DelayExpr<TContext, TEvent extends EventObject> = ExprWithMeta< TContext, TEvent, number>;
export type LogExpr<TContext, TEvent extends EventObject> = ExprWithMeta< TContext, TEvent, any>;
export interface LogAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { label: string | undefined; expr: string | LogExpr<TContext, TEvent>;}
export interface LogActionObject<TContext, TEvent extends EventObject> extends LogAction<TContext, TEvent> { value: any;}
export interface SendAction< TContext, TEvent extends EventObject, TSentEvent extends EventObject> extends ActionObject<TContext, TEvent> { to: | string | number | ActorRef<any> | ExprWithMeta<TContext, TEvent, string | number | ActorRef<any>> | undefined; event: TSentEvent | SendExpr<TContext, TEvent, TSentEvent>; delay?: number | string | DelayExpr<TContext, TEvent>; id: string | number;}
export interface SendActionObject< TContext, TEvent extends EventObject, TSentEvent extends EventObject = AnyEventObject> extends SendAction<TContext, TEvent, TSentEvent> { to: string | number | ActorRef<any> | undefined; _event: SCXML.Event<TSentEvent>; event: TSentEvent; delay?: number; id: string | number;}
export interface StopAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { type: ActionTypes.Stop; activity: | string | { id: string } | Expr<TContext, TEvent, string | { id: string }>;}
export interface StopActionObject { type: ActionTypes.Stop; activity: { id: string };}
export type Expr<TContext, TEvent extends EventObject, T> = ( context: TContext, event: TEvent) => T;
export type ExprWithMeta<TContext, TEvent extends EventObject, T> = ( context: TContext, event: TEvent, meta: SCXMLEventMeta<TEvent>) => T;
export type SendExpr< TContext, TEvent extends EventObject, TSentEvent extends EventObject = AnyEventObject> = ExprWithMeta<TContext, TEvent, TSentEvent>;
export enum SpecialTargets { Parent = '#_parent', Internal = '#_internal'}
export interface SendActionOptions<TContext, TEvent extends EventObject> { id?: string | number; delay?: number | string | DelayExpr<TContext, TEvent>; to?: | string | ActorRef<any> | ExprWithMeta<TContext, TEvent, string | ActorRef<any>>;}
export interface CancelAction extends ActionObject<any, any> { sendId: string | number;}
export type Assigner<TContext, TEvent extends EventObject> = ( context: TContext, event: TEvent, meta: AssignMeta<TContext, TEvent>) => Partial<TContext>;
export type PartialAssigner< TContext, TEvent extends EventObject, TKey extends keyof TContext> = ( context: TContext, event: TEvent, meta: AssignMeta<TContext, TEvent>) => TContext[TKey];
export type PropertyAssigner<TContext, TEvent extends EventObject> = { [K in keyof TContext]?: PartialAssigner<TContext, TEvent, K> | TContext[K];};
export type Mapper<TContext, TEvent extends EventObject, TParams extends {}> = ( context: TContext, event: TEvent) => TParams;
export type PropertyMapper< TContext, TEvent extends EventObject, TParams extends {}> = { [K in keyof TParams]?: | ((context: TContext, event: TEvent) => TParams[K]) | TParams[K];};
export interface AnyAssignAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { type: ActionTypes.Assign; assignment: any;}
export interface AssignAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { type: ActionTypes.Assign; assignment: Assigner<TContext, TEvent> | PropertyAssigner<TContext, TEvent>;}
export interface PureAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { type: ActionTypes.Pure; get: ( context: TContext, event: TEvent ) => SingleOrArray<ActionObject<TContext, TEvent>> | undefined;}
export interface ChooseAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> { type: ActionTypes.Choose; conds: Array<ChooseCondition<TContext, TEvent>>;}
export interface TransitionDefinition<TContext, TEvent extends EventObject> extends TransitionConfig<TContext, TEvent> { target: Array<StateNode<TContext, any, TEvent>> | undefined; source: StateNode<TContext, any, TEvent>; actions: Array<ActionObject<TContext, TEvent>>; cond?: Guard<TContext, TEvent>; eventType: TEvent['type'] | NullEvent['type'] | '*'; toJSON: () => { target: string[] | undefined; source: string; actions: Array<ActionObject<TContext, TEvent>>; cond?: Guard<TContext, TEvent>; eventType: TEvent['type'] | NullEvent['type'] | '*'; meta?: Record<string, any>; };}
export type TransitionDefinitionMap<TContext, TEvent extends EventObject> = { [K in TEvent['type'] | NullEvent['type'] | '*']: Array< TransitionDefinition< TContext, K extends TEvent['type'] ? Extract<TEvent, { type: K }> : EventObject > >;};
export interface DelayedTransitionDefinition< TContext, TEvent extends EventObject> extends TransitionDefinition<TContext, TEvent> { delay: number | string | DelayExpr<TContext, TEvent>;}
export interface Edge< TContext, TEvent extends EventObject, TEventType extends TEvent['type'] = string> { event: TEventType; source: StateNode<TContext, any, TEvent>; target: StateNode<TContext, any, TEvent>; cond?: Condition<TContext, TEvent & { type: TEventType }>; actions: Array<Action<TContext, TEvent>>; meta?: MetaObject; transition: TransitionDefinition<TContext, TEvent>;}export interface NodesAndEdges<TContext, TEvent extends EventObject> { nodes: StateNode[]; edges: Array<Edge<TContext, TEvent, TEvent['type']>>;}
export interface Segment<TContext, TEvent extends EventObject> { /** * From state. */ state: State<TContext, TEvent>; /** * Event from state. */ event: TEvent;}
export interface PathItem<TContext, TEvent extends EventObject> { state: State<TContext, TEvent>; path: Array<Segment<TContext, TEvent>>; weight?: number;}
export interface PathMap<TContext, TEvent extends EventObject> { [key: string]: PathItem<TContext, TEvent>;}
export interface PathsItem<TContext, TEvent extends EventObject> { state: State<TContext, TEvent>; paths: Array<Array<Segment<TContext, TEvent>>>;}
export interface PathsMap<TContext, TEvent extends EventObject> { [key: string]: PathsItem<TContext, TEvent>;}
export interface TransitionMap { state: StateValue | undefined;}
export interface AdjacencyMap { [stateId: string]: Record<string, TransitionMap>;}
export interface ValueAdjacencyMap<TContext, TEvent extends EventObject> { [stateId: string]: Record<string, State<TContext, TEvent>>;}
export interface SCXMLEventMeta<TEvent extends EventObject> { _event: SCXML.Event<TEvent>;}
export interface StateMeta<TContext, TEvent extends EventObject> { state: State<TContext, TEvent, any, any, any>; _event: SCXML.Event<TEvent>;}
export interface Typestate<TContext> { value: StateValue; context: TContext;}
export interface StateLike<TContext> { value: StateValue; context: TContext; event: EventObject; _event: SCXML.Event<EventObject>;}
export interface StateConfig<TContext, TEvent extends EventObject> { value: StateValue; context: TContext; _event: SCXML.Event<TEvent>; _sessionid: string | null; historyValue?: HistoryValue | undefined; history?: State<TContext, TEvent, any, any, any>; actions?: Array<ActionObject<TContext, TEvent>>; /** * @deprecated */ activities?: ActivityMap; meta?: any; /** * @deprecated */ events?: TEvent[]; configuration: Array<StateNode<TContext, any, TEvent>>; transitions: Array<TransitionDefinition<TContext, TEvent>>; children: Record<string, ActorRef<any>>; done?: boolean; tags?: Set<string>; machine?: StateMachine<TContext, any, TEvent, any, any, any, any>;}
export type AnyStateConfig = StateConfig<any, AnyEventObject>;
export interface StateSchema<TC = any> { meta?: any; context?: Partial<TC>; states?: { [key: string]: StateSchema<TC>; };}
export interface InterpreterOptions { /** * Whether state actions should be executed immediately upon transition. Defaults to `true`. */ execute?: boolean; clock?: Clock; logger?: (...args: any[]) => void; parent?: AnyInterpreter; /** * If `true`, defers processing of sent events until the service * is initialized (`.start()`). Otherwise, an error will be thrown * for events sent to an uninitialized service. * * Default: `true` */ deferEvents?: boolean; /** * The custom `id` for referencing this service. */ id?: string; /** * If `true`, states and events will be logged to Redux DevTools. * * Default: `false` */ devTools?: boolean | object; // TODO: add enhancer options}
export namespace SCXML { // tslint:disable-next-line:no-shadowed-variable export interface Event<TEvent extends EventObject> { /** * This is a character string giving the name of the event. * The SCXML Processor must set the name field to the name of this event. * It is what is matched against the 'event' attribute of <transition>. * Note that transitions can do additional tests by using the value of this field * inside boolean expressions in the 'cond' attribute. */ name: string; /** * This field describes the event type. * The SCXML Processor must set it to: "platform" (for events raised by the platform itself, such as error events), * "internal" (for events raised by <raise> and <send> with target '_internal') * or "external" (for all other events). */ type: 'platform' | 'internal' | 'external'; /** * If the sending entity has specified a value for this, the Processor must set this field to that value * (see C Event I/O Processors for details). * Otherwise, in the case of error events triggered by a failed attempt to send an event, * the Processor must set this field to the send id of the triggering <send> element. * Otherwise it must leave it blank. */ sendid?: string; /** * This is a URI, equivalent to the 'target' attribute on the <send> element. * For external events, the SCXML Processor should set this field to a value which, * when used as the value of 'target', will allow the receiver of the event to <send> * a response back to the originating entity via the Event I/O Processor specified in 'origintype'. * For internal and platform events, the Processor must leave this field blank. */ origin?: string; /** * This is equivalent to the 'type' field on the <send> element. * For external events, the SCXML Processor should set this field to a value which, * when used as the value of 'type', will allow the receiver of the event to <send> * a response back to the originating entity at the URI specified by 'origin'. * For internal and platform events, the Processor must leave this field blank. */ origintype?: string; /** * If this event is generated from an invoked child process, the SCXML Processor * must set this field to the invoke id of the invocation that triggered the child process. * Otherwise it must leave it blank. */ invokeid?: string; /** * This field contains whatever data the sending entity chose to include in this event. * The receiving SCXML Processor should reformat this data to match its data model, * but must not otherwise modify it. * * If the conversion is not possible, the Processor must leave the field blank * and must place an error 'error.execution' in the internal event queue. */ data: TEvent; /** * @private */ $$type: 'scxml'; }}
// Taken from RxJSexport interface Observer<T> { next: (value: T) => void; error: (err: any) => void; complete: () => void;}
export interface Subscription { unsubscribe(): void;}
export interface InteropObservable<T> { [Symbol.observable]: () => InteropSubscribable<T>;}
export interface InteropSubscribable<T> { subscribe(observer: Observer<T>): Subscription;}
export interface Subscribable<T> extends InteropSubscribable<T> { subscribe(observer: Observer<T>): Subscription; subscribe( next: (value: T) => void, error?: (error: any) => void, complete?: () => void ): Subscription;}
export type Spawnable = | AnyStateMachine | PromiseLike<any> | InvokeCallback | InteropObservable<any> | Subscribable<any> | Behavior<any>;
export type ExtractEvent< TEvent extends EventObject, TEventType extends TEvent['type']> = TEvent extends any ? TEventType extends TEvent['type'] ? TEvent : never : never;
export interface BaseActorRef<TEvent extends EventObject> { send: (event: TEvent) => void;}
export interface ActorRef<TEvent extends EventObject, TEmitted = any> extends Subscribable<TEmitted>, InteropObservable<TEmitted> { send: Sender<TEvent>; // TODO: this should just be TEvent id: string; getSnapshot: () => TEmitted | undefined; stop?: () => void; toJSON?: () => any;}
export type AnyActorRef = ActorRef<any, any>;
/** * @deprecated Use `ActorRef` instead. */export type SpawnedActorRef< TEvent extends EventObject, TEmitted = any> = ActorRef<TEvent, TEmitted>;
export type ActorRefWithDeprecatedState< TContext, TEvent extends EventObject, TTypestate extends Typestate<TContext>, TResolvedTypesMeta = TypegenDisabled> = ActorRef< TEvent, State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>> & { /** * @deprecated Use `.getSnapshot()` instead. */ state: State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>;};
export type ActorRefFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine< infer TContext, any, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta > ? ActorRefWithDeprecatedState< TContext, TEvent, TTypestate, AreAllImplementationsAssumedToBeProvided<TResolvedTypesMeta> extends false ? MarkAllImplementationsAsProvided<TResolvedTypesMeta> : TResolvedTypesMeta > : R extends Promise<infer U> ? ActorRef<never, U> : R extends Behavior<infer TEvent, infer TEmitted> ? ActorRef<TEvent, TEmitted> : never : never;
export type AnyInterpreter = Interpreter<any, any, any, any, any>;
export type InterpreterFrom< T extends AnyStateMachine | ((...args: any[]) => AnyStateMachine)> = ReturnTypeOrValue<T> extends StateMachine< infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? Interpreter< TContext, TStateSchema, TEvent, TTypestate, AreAllImplementationsAssumedToBeProvided<TResolvedTypesMeta> extends false ? MarkAllImplementationsAsProvided<TResolvedTypesMeta> : TResolvedTypesMeta > : never;
export type MachineOptionsFrom< T extends AnyStateMachine | ((...args: any[]) => AnyStateMachine), TRequireMissingImplementations extends boolean = false> = ReturnTypeOrValue<T> extends StateMachine< infer TContext, any, infer TEvent, any, any, any, infer TResolvedTypesMeta> ? InternalMachineOptions< TContext, TEvent, TResolvedTypesMeta, TRequireMissingImplementations > : never;
// only meant to be used internally for debugging purposesexport type __ResolvedTypesMetaFrom<T> = T extends StateMachine< any, any, any, any, any, any, infer TResolvedTypesMeta> ? TResolvedTypesMeta : never;
export interface ActorContext<TEvent extends EventObject, TEmitted> { parent?: ActorRef<any, any>; self: ActorRef<TEvent, TEmitted>; id: string; observers: Set<Observer<TEmitted>>;}
export interface Behavior<TEvent extends EventObject, TEmitted = any> { transition: ( state: TEmitted, event: TEvent, actorCtx: ActorContext<TEvent, TEmitted> ) => TEmitted; initialState: TEmitted; start?: (actorCtx: ActorContext<TEvent, TEmitted>) => TEmitted;}
export type EmittedFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends Interpreter<infer _, infer __, infer ___, infer ____, infer _____> ? R['initialState'] : R extends ActorRef<infer _, infer TEmitted> ? TEmitted : R extends Behavior<infer _, infer TEmitted> ? TEmitted : R extends ActorContext<infer _, infer TEmitted> ? TEmitted : never : never;
type ResolveEventType<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine< infer _, infer __, infer TEvent, infer ___, infer ____, infer _____, infer ______ > ? TEvent : R extends Model<infer _, infer TEvent, infer __, infer ___> ? TEvent : R extends State<infer _, infer TEvent, infer __, infer ___, infer ____> ? TEvent : // TODO: the special case for Interpreter shouldn't be needed here as it implements ActorRef // however to drop it we'd have to remove ` | SCXML.Event<TEvent>` from its `send`'s accepted parameter R extends Interpreter< infer _, infer __, infer TEvent, infer ___, infer ____ > ? TEvent : R extends ActorRef<infer TEvent, infer _> ? TEvent : never : never;
export type EventFrom< T, K extends Prop<TEvent, 'type'> = never, TEvent extends EventObject = ResolveEventType<T>> = IsNever<K> extends true ? TEvent : ExtractEvent<TEvent, K>;
export type ContextFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine< infer TContext, infer _, infer __, infer ___, infer ____, infer _____, infer ______ > ? TContext : R extends Model<infer TContext, infer _, infer __, infer ___> ? TContext : R extends State<infer TContext, infer _, infer __, infer ___, infer ____> ? TContext : R extends Interpreter< infer TContext, infer _, infer __, infer ___, infer ____ > ? TContext : never : never;
type Matches<TypegenEnabledArg, TypegenDisabledArg> = { (stateValue: TypegenEnabledArg): any; (stateValue: TypegenDisabledArg): any;};
export type StateValueFrom< TMachine extends AnyStateMachine> = StateFrom<TMachine>['matches'] extends Matches< infer TypegenEnabledArg, infer TypegenDisabledArg> ? TMachine['__TResolvedTypesMeta'] extends TypegenEnabled ? TypegenEnabledArg : TypegenDisabledArg : never;
export type PredictableActionArgumentsExec = ( action: ActionObject<unknown, EventObject>, context: unknown, _event: SCXML.Event<EventObject>) => void;
xstate
Version Info
2 years ago
