xstate 4.25.0 → 4.27.0-pr2674-2021926101023

package/es/types.d.ts

@@ -1,9 +1,25 @@
-import { StateNode } from './StateNode';
-import { State } from './State';
-import { Interpreter, Clock } from './interpreter';
+import { Clock, Interpreter } from './interpreter';
 import { Model } from './model.types';
-declare type AnyFunction = (...args: any[]) => any;
+import { State } from './State';
+import { StateNode } from './StateNode';
+import { MarkAllImplementationsAsProvided, TypegenDisabled, ResolveTypegenMeta, TypegenConstraint } from './typegenTypes';
+export declare type AnyFunction = (...args: any[]) => any;
 declare type ReturnTypeOrValue<T> = T extends AnyFunction ? ReturnType<T> : T;
+export declare type IsNever<T> = [T] extends [never] ? true : false;
+export declare type Cast<T extends any, TCastType extends any> = T extends TCastType ? T : TCastType;
+export declare type Compute<A extends any> = {
+    [K in keyof A]: A[K];
+} & unknown;
+export declare type Prop<T, K> = K extends keyof T ? T[K] : never;
+export declare type Values<T> = T[keyof T];
+export declare type Merge<M, N> = Omit<M, keyof N> & N;
+export declare type IndexByType<T extends {
+    type: string;
+}> = {
+    [K in T['type']]: Extract<T, {
+        type: K;
+    }>;
+};
 export declare type EventType = string;
 export declare type ActionType = string;
 export declare type MetaObject = Record<string, any>;
@@ -44,7 +60,7 @@ export declare type EventData = Record<string, any> & {
  * The specified string event types or the specified event objects.
  */
 export declare type Event<TEvent extends EventObject> = TEvent['type'] | TEvent;
-export interface ActionMeta<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> extends StateMeta<TContext, TEvent> {
+export interface ActionMeta<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> extends StateMeta<TContext, TEvent> {
     action: TAction;
     _event: SCXML.Event<TEvent>;
 }
@@ -53,8 +69,10 @@ export interface AssignMeta<TContext, TEvent extends EventObject> {
     action: AssignAction<TContext, TEvent>;
     _event: SCXML.Event<TEvent>;
 }
-export declare type ActionFunction<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> = (context: TContext, event: TEvent, meta: ActionMeta<TContext, TEvent, TAction>) => void;
-export interface ChooseConditon<TContext, TEvent extends EventObject> {
+export declare 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>;
 }
@@ -116,6 +134,7 @@ export interface TransitionConfig<TContext, TEvent extends EventObject> {
     internal?: boolean;
     target?: TransitionTarget<TContext, TEvent>;
     meta?: Record<string, any>;
+    description?: string;
 }
 export interface TargetTransitionConfig<TContext, TEvent extends EventObject> extends TransitionConfig<TContext, TEvent> {
     target: TransitionTarget<TContext, TEvent>;
@@ -157,6 +176,7 @@ export declare type InvokeCallback<TEvent extends EventObject = AnyEventObject,
 export interface InvokeMeta {
     data: any;
     src: InvokeSourceDefinition;
+    meta?: MetaObject;
 }
 /**
  * Returns either a Promises or a callback handler (for streams of events) given the
@@ -196,6 +216,7 @@ export interface InvokeDefinition<TContext, TEvent extends EventObject> extends
      * 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;
@@ -278,6 +299,10 @@ export interface InvokeConfig<TContext, TEvent extends EventObject> {
      * 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> {
     /**
@@ -406,6 +431,10 @@ export interface StateNodeConfig<TContext, TStateSchema extends StateSchema, TEv
      * @default false
      */
     preserveActionOrder?: boolean;
+    /**
+     * A text description of the state node
+     */
+    description?: string;
 }
 export interface StateNodeDefinition<TContext, TStateSchema extends StateSchema, TEvent extends EventObject> {
     id: string;
@@ -428,6 +457,8 @@ export interface StateNodeDefinition<TContext, TStateSchema extends StateSchema,
     order: number;
     data?: FinalStateNodeConfig<TContext, TEvent>['data'];
     invoke: Array<InvokeDefinition<TContext, TEvent>>;
+    description?: string;
+    tags: string[];
 }
 export declare type AnyStateNodeDefinition = StateNodeDefinition<any, any, any>;
 export interface AtomicStateNodeConfig<TContext, TEvent extends EventObject> extends StateNodeConfig<TContext, StateSchema, TEvent> {
@@ -449,7 +480,7 @@ export interface FinalStateNodeConfig<TContext, TEvent extends EventObject> exte
     data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>;
 }
 export declare type SimpleOrStateNodeConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject> = AtomicStateNodeConfig<TContext, TEvent> | StateNodeConfig<TContext, TStateSchema, TEvent>;
-export declare type ActionFunctionMap<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> = {
+export declare 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>;
@@ -457,25 +488,44 @@ export declare type ActionFunctionMap<TContext, TEvent extends EventObject, TAct
 export declare type DelayFunctionMap<TContext, TEvent extends EventObject> = Record<string, DelayConfig<TContext, TEvent>>;
 export declare type ServiceConfig<TContext, TEvent extends EventObject = AnyEventObject> = string | StateMachine<any, any, any> | InvokeCreator<TContext, TEvent>;
 export declare type DelayConfig<TContext, TEvent extends EventObject> = number | DelayExpr<TContext, TEvent>;
-export interface MachineOptions<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> {
-    guards: Record<string, ConditionPredicate<TContext, TEvent>>;
-    actions: ActionFunctionMap<TContext, TEvent, TAction>;
+declare type MachineOptionsActions<TContext, TResolvedTypesMeta, TEventsCausingActions = Prop<TResolvedTypesMeta, 'eventsCausingActions'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TIndexedActions = Prop<TResolvedTypesMeta, '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>>;
+};
+declare type MachineOptionsDelays<TContext, TResolvedTypesMeta, TEventsCausingDelays = Prop<TResolvedTypesMeta, 'eventsCausingDelays'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>> = {
+    [K in keyof TEventsCausingDelays]?: DelayConfig<TContext, Cast<Prop<TIndexedEvents, TEventsCausingDelays[K]>, EventObject>>;
+};
+declare type MachineOptionsGuards<TContext, TResolvedTypesMeta, TEventsCausingGuards = Prop<TResolvedTypesMeta, 'eventsCausingGuards'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>> = {
+    [K in keyof TEventsCausingGuards]?: ConditionPredicate<TContext, Cast<Prop<TIndexedEvents, TEventsCausingGuards[K]>, EventObject>>;
+};
+declare type MachineOptionsServices<TContext, TResolvedTypesMeta, TEventsCausingServices = Prop<TResolvedTypesMeta, 'eventsCausingServices'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TInvokeSrcNameMap = Prop<TResolvedTypesMeta, 'invokeSrcNameMap'>> = {
+    [K in keyof TEventsCausingServices]?: StateMachine<any, any, any> | InvokeCreator<TContext, Cast<Prop<TIndexedEvents, TEventsCausingServices[K]>, EventObject>, Prop<Prop<TIndexedEvents, Prop<TInvokeSrcNameMap, K>>, 'data'>>;
+};
+declare type MakeKeysRequired<T extends string> = {
+    [K in T]: unknown;
+};
+declare type MaybeMakeMissingImplementationsRequired<TImplementationType, TMissingImplementationsForType, TRequireMissingImplementations> = TRequireMissingImplementations extends true ? IsNever<TMissingImplementationsForType> extends true ? {} : {
+    [K in Cast<TImplementationType, string>]: MakeKeysRequired<Cast<TMissingImplementationsForType, string>>;
+} : {};
+declare type GenerateActionsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'actions', Prop<TMissingImplementations, 'actions'>, TRequireMissingImplementations> & {
+    actions?: MachineOptionsActions<TContext, TResolvedTypesMeta>;
+};
+declare type GenerateDelaysConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'delays', Prop<TMissingImplementations, 'delays'>, TRequireMissingImplementations> & {
+    delays?: MachineOptionsDelays<TContext, TResolvedTypesMeta>;
+};
+declare type GenerateGuardsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'guards', Prop<TMissingImplementations, 'guards'>, TRequireMissingImplementations> & {
+    guards?: MachineOptionsGuards<TContext, TResolvedTypesMeta>;
+};
+declare type GenerateServicesConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'services', Prop<TMissingImplementations, 'services'>, TRequireMissingImplementations> & {
+    services?: MachineOptionsServices<TContext, TResolvedTypesMeta>;
+};
+export declare type InternalMachineOptions<TContext, TEvent extends EventObject, TResolvedTypesMeta, TRequireMissingImplementations extends boolean = false, TMissingImplementations = Prop<TResolvedTypesMeta, '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>>;
-    services: Record<string, ServiceConfig<TContext, TEvent>>;
-    delays: DelayFunctionMap<TContext, TEvent>;
-    /**
-     * @private
-     */
-    _parent?: StateNode<TContext, any, TEvent, any>;
-    /**
-     * @private
-     */
-    _key?: string;
-}
-export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = ActionObject<TContext, TEvent>> extends StateNodeConfig<TContext, TStateSchema, TEvent, TAction> {
+    activities?: Record<string, ActivityConfig<TContext, TEvent>>;
+};
+export declare type MachineOptions<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TTypesMeta extends TypegenConstraint = TypegenDisabled> = InternalMachineOptions<TContext, TEvent, ResolveTypegenMeta<TTypesMeta, TEvent, TAction>>;
+export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TTypesMeta = TypegenDisabled> extends StateNodeConfig<TContext, TStateSchema, TEvent, TAction> {
     /**
      * The initial context (extended state)
      */
@@ -485,6 +535,7 @@ export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEven
      */
     version?: string;
     schema?: MachineSchema<TContext, TEvent>;
+    tsTypes?: TTypesMeta | true;
 }
 export interface MachineSchema<TContext, TEvent extends EventObject> {
     context?: TContext;
@@ -519,13 +570,19 @@ export interface HistoryStateNode<TContext> extends StateNode<TContext> {
 export interface StateMachine<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TTypestate extends Typestate<TContext> = {
     value: any;
     context: TContext;
-}, _TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> extends StateNode<TContext, TStateSchema, TEvent, TTypestate> {
+}, TAction extends BaseActionObject = BaseActionObject, TResolvedTypesMeta = TypegenDisabled> extends StateNode<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> {
     id: string;
-    states: StateNode<TContext, TStateSchema, TEvent>['states'];
-    withConfig(options: Partial<MachineOptions<TContext, TEvent>>, context?: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate>;
-    withContext(context: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate>;
-}
-export declare type StateFrom<T extends StateMachine<any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any>)> = T extends StateMachine<any, any, any> ? ReturnType<T['transition']> : T extends (...args: any[]) => StateMachine<any, any, any> ? ReturnType<ReturnType<T>['transition']> : never;
+    states: StateNode<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta>['states'];
+    withConfig(options: InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, true>, context?: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate, TAction, MarkAllImplementationsAsProvided<TResolvedTypesMeta>>;
+    withContext(context: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate, any, TResolvedTypesMeta>;
+    __TContext: TContext;
+    __TStateSchema: TStateSchema;
+    __TEvent: TEvent;
+    __TTypestate: TTypestate;
+    __TAction: TAction;
+    __TResolvedTypesMeta: TResolvedTypesMeta;
+}
+export declare type StateFrom<T extends StateMachine<any, any, any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any, any, any>)> = T extends StateMachine<any, any, any, any, any, any> ? ReturnType<T['transition']> : T extends (...args: any[]) => StateMachine<any, any, any, any, any, any> ? ReturnType<ReturnType<T>['transition']> : never;
 export interface ActionMap<TContext, TEvent extends EventObject> {
     onEntry: Array<Action<TContext, TEvent>>;
     actions: Array<Action<TContext, TEvent>>;
@@ -544,13 +601,13 @@ export interface ActivityMap {
 }
 export interface StateTransition<TContext, TEvent extends EventObject> {
     transitions: Array<TransitionDefinition<TContext, TEvent>>;
-    configuration: Array<StateNode<TContext, any, TEvent, any>>;
-    entrySet: Array<StateNode<TContext, any, TEvent, any>>;
-    exitSet: Array<StateNode<TContext, any, TEvent, any>>;
+    configuration: Array<StateNode<TContext, any, TEvent, any, any>>;
+    entrySet: Array<StateNode<TContext, any, TEvent, any, any>>;
+    exitSet: Array<StateNode<TContext, any, TEvent, any, any>>;
     /**
      * The source state that preceded the transition.
      */
-    source: State<TContext, any, any, any> | undefined;
+    source: State<TContext, any, any, any, any> | undefined;
     actions: Array<ActionObject<TContext, TEvent>>;
 }
 export interface TransitionData<TContext, TEvent extends EventObject> {
@@ -693,7 +750,7 @@ export interface PureAction<TContext, TEvent extends EventObject> extends Action
 }
 export interface ChooseAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> {
     type: ActionTypes.Choose;
-    conds: Array<ChooseConditon<TContext, TEvent>>;
+    conds: Array<ChooseCondition<TContext, TEvent>>;
 }
 export interface TransitionDefinition<TContext, TEvent extends EventObject> extends TransitionConfig<TContext, TEvent> {
     target: Array<StateNode<TContext, any, TEvent>> | undefined;
@@ -771,7 +828,7 @@ export interface SCXMLEventMeta<TEvent extends EventObject> {
     _event: SCXML.Event<TEvent>;
 }
 export interface StateMeta<TContext, TEvent extends EventObject> {
-    state: State<TContext, TEvent, any, any>;
+    state: State<TContext, TEvent, any, any, any>;
     _event: SCXML.Event<TEvent>;
 }
 export interface Typestate<TContext> {
@@ -790,7 +847,7 @@ export interface StateConfig<TContext, TEvent extends EventObject> {
     _event: SCXML.Event<TEvent>;
     _sessionid: string | null;
     historyValue?: HistoryValue | undefined;
-    history?: State<TContext, TEvent>;
+    history?: State<TContext, TEvent, any, any, any>;
     actions?: Array<ActionObject<TContext, TEvent>>;
     /**
      * @deprecated
@@ -803,7 +860,7 @@ export interface StateConfig<TContext, TEvent extends EventObject> {
     children: Record<string, ActorRef<any>>;
     done?: boolean;
     tags?: Set<string>;
-    machine?: StateMachine<TContext, any, TEvent, any>;
+    machine?: StateMachine<TContext, any, TEvent, any, any, any>;
 }
 export interface StateSchema<TC = any> {
     meta?: any;
@@ -816,9 +873,9 @@ export interface InterpreterOptions {
     /**
      * Whether state actions should be executed immediately upon transition. Defaults to `true`.
      */
-    execute: boolean;
-    clock: Clock;
-    logger: (...args: any[]) => void;
+    execute?: boolean;
+    clock?: Clock;
+    logger?: (...args: any[]) => void;
     parent?: AnyInterpreter;
     /**
      * If `true`, defers processing of sent events until the service
@@ -827,7 +884,7 @@ export interface InterpreterOptions {
      *
      * Default: `true`
      */
-    deferEvents: boolean;
+    deferEvents?: boolean;
     /**
      * The custom `id` for referencing this service.
      */
@@ -837,8 +894,7 @@ export interface InterpreterOptions {
      *
      * Default: `false`
      */
-    devTools: boolean | object;
-    [option: string]: any;
+    devTools?: boolean | object;
 }
 export declare namespace SCXML {
     interface Event<TEvent extends EventObject> {
@@ -932,15 +988,17 @@ export interface ActorRef<TEvent extends EventObject, TEmitted = any> extends Su
  * @deprecated Use `ActorRef` instead.
  */
 export declare type SpawnedActorRef<TEvent extends EventObject, TEmitted = any> = ActorRef<TEvent, TEmitted>;
-export declare type ActorRefWithDeprecatedState<TContext, TEvent extends EventObject, TTypestate extends Typestate<TContext>> = ActorRef<TEvent, State<TContext, TEvent, any, TTypestate>> & {
+export declare 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>;
+    state: State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>;
 };
-export declare type ActorRefFrom<T> = T extends StateMachine<infer TContext, any, infer TEvent, infer TTypestate> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate> : T extends (...args: any[]) => StateMachine<infer TContext, any, infer TEvent, infer TTypestate> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate> : T extends Promise<infer U> ? ActorRef<never, U> : T extends Behavior<infer TEvent1, infer TEmitted> ? ActorRef<TEvent1, TEmitted> : T extends (...args: any[]) => Behavior<infer TEvent1, infer TEmitted> ? ActorRef<TEvent1, TEmitted> : never;
-export declare type AnyInterpreter = Interpreter<any, any, any, any>;
-export declare type InterpreterFrom<T extends StateMachine<any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any>)> = T extends StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate> : T extends (...args: any[]) => StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate> : never;
+export declare type ActorRefFrom<T> = T extends StateMachine<infer TContext, any, infer TEvent, infer TTypestate> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate> : T extends (...args: any[]) => StateMachine<infer TContext, any, infer TEvent, infer TTypestate, any, infer TResolvedTypesMeta> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate, TResolvedTypesMeta> : T extends Promise<infer U> ? ActorRef<never, U> : T extends Behavior<infer TEvent1, infer TEmitted> ? ActorRef<TEvent1, TEmitted> : T extends (...args: any[]) => Behavior<infer TEvent1, infer TEmitted> ? ActorRef<TEvent1, TEmitted> : never;
+export declare type AnyInterpreter = Interpreter<any, any, any, any, any>;
+export declare type InterpreterFrom<T extends StateMachine<any, any, any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any, any, any>)> = T extends StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, infer TResolvedTypesMeta> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> : T extends (...args: any[]) => StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, infer TResolvedTypesMeta> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> : never;
+export declare type MachineOptionsFrom<T extends StateMachine<any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any>), TRequireMissingImplementations extends boolean = false> = ReturnTypeOrValue<T> extends StateMachine<infer TContext, any, infer TEvent, any, any, infer TResolvedTypesMeta> ? InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, TRequireMissingImplementations> : never;
+export declare type __ResolvedTypesMetaFrom<T> = T extends StateMachine<any, any, any, any, any, infer TResolvedTypesMeta> ? TResolvedTypesMeta : never;
 export interface ActorContext<TEvent extends EventObject, TEmitted> {
     parent?: ActorRef<any, any>;
     self: ActorRef<TEvent, TEmitted>;
@@ -953,7 +1011,10 @@ export interface Behavior<TEvent extends EventObject, TEmitted = any> {
     start?: (actorCtx: ActorContext<TEvent, TEmitted>) => TEmitted;
 }
 export declare type EmittedFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends ActorRef<infer _, infer TEmitted> ? TEmitted : R extends Behavior<infer _, infer TEmitted> ? TEmitted : R extends ActorContext<infer _, infer TEmitted> ? TEmitted : never : never;
-export declare type EventFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine<infer _, infer __, infer TEvent, infer ____> ? TEvent : R extends Model<infer _, infer TEvent, infer ___, infer ____> ? TEvent : R extends State<infer _, infer TEvent, infer ___, infer ____> ? TEvent : R extends Interpreter<infer _, infer __, infer TEvent, infer ____> ? TEvent : never : never;
+declare type ResolveEventType<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine<infer _, infer __, infer TEvent, infer ____> ? TEvent : R extends Model<infer _, infer TEvent, infer ___, infer ____> ? TEvent : R extends State<infer _, infer TEvent, infer ___, infer ____> ? TEvent : R extends Interpreter<infer _, infer __, infer TEvent, infer ____> ? TEvent : never : never;
+export declare type EventFrom<T, K extends Prop<TEvent, 'type'> = never, TEvent = ResolveEventType<T>> = IsNever<K> extends true ? TEvent : Extract<TEvent, {
+    type: K;
+}>;
 export declare type ContextFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine<infer TContext, infer _, infer __, infer ___> ? TContext : R extends Model<infer TContext, infer _, infer __, infer ___> ? TContext : R extends State<infer TContext, infer _, infer __, infer ___> ? TContext : R extends Interpreter<infer TContext, infer _, infer __, infer ___> ? TContext : never : never;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/es/utils.d.ts

@@ -63,7 +63,7 @@ export declare function toTransitionConfigArray<TContext, TEvent extends EventOb
 }>;
 export declare function normalizeTarget<TContext, TEvent extends EventObject>(target: SingleOrArray<string | StateNode<TContext, any, TEvent>> | undefined): Array<string | StateNode<TContext, any, TEvent>> | undefined;
 export declare function reportUnhandledExceptionOnInvocation(originalError: any, currentError: any, id: string): void;
-export declare function evaluateGuard<TContext, TEvent extends EventObject>(machine: StateNode<TContext, any, TEvent, any>, guard: Guard<TContext, TEvent>, context: TContext, _event: SCXML.Event<TEvent>, state: State<TContext, TEvent>): boolean;
+export declare function evaluateGuard<TContext, TEvent extends EventObject>(machine: StateNode<TContext, any, TEvent, any, any>, guard: Guard<TContext, TEvent>, context: TContext, _event: SCXML.Event<TEvent>, state: State<TContext, TEvent>): boolean;
 export declare function toInvokeSource(src: string | InvokeSourceDefinition): InvokeSourceDefinition;
 export declare function toObserver<T>(nextHandler: Observer<T> | ((value: T) => void), errorHandler?: (error: any) => void, completionHandler?: () => void): Observer<T>;
 //# sourceMappingURL=utils.d.ts.map

package/es/utils.js

@@ -548,7 +548,7 @@ function evaluateGuard(machine, guard, context, _event, state) {
     return ((guards === null || guards === void 0 ? void 0 : guards[guard.name]) || guard.predicate)(context, _event.data, guardMeta);
   }
 
-  var condFn = guards[guard.type];
+  var condFn = guards === null || guards === void 0 ? void 0 : guards[guard.type];
 
   if (!condFn) {
     throw new Error("Guard '" + guard.type + "' is not implemented on machine '" + machine.id + "'.");

package/lib/Actor.d.ts

@@ -1,5 +1,4 @@
-import { EventObject, Subscribable, InvokeDefinition, AnyEventObject, StateMachine, Spawnable, SCXML } from './types';
-import { ActorRef, BaseActorRef } from '.';
+import { EventObject, Subscribable, InvokeDefinition, AnyEventObject, StateMachine, Spawnable, SCXML, ActorRef, BaseActorRef } from './types';
 export interface Actor<TContext = any, TEvent extends EventObject = AnyEventObject> extends Subscribable<TContext> {
     id: string;
     send: (event: TEvent) => any;

package/lib/Machine.d.ts

@@ -1,12 +1,13 @@
 import { Model } from './model.types';
-import { AnyEventObject, DefaultContext, EventObject, MachineConfig, MachineOptions, StateMachine, StateSchema, Typestate } from './types';
+import { AnyEventObject, BaseActionObject, DefaultContext, EventObject, MachineConfig, MachineOptions, InternalMachineOptions, StateMachine, StateSchema, Typestate } from './types';
+import { TypegenConstraint, TypegenDisabled, ResolveTypegenMeta } from './typegenTypes';
 /**
  * @deprecated Use `createMachine(...)` instead.
  */
-export declare function Machine<TContext = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, initialContext?: TContext): StateMachine<TContext, any, TEvent>;
-export declare function Machine<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, TStateSchema, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, initialContext?: TContext): StateMachine<TContext, TStateSchema, TEvent>;
+export declare function Machine<TContext = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, any, TEvent>, options?: MachineOptions<TContext, TEvent>, initialContext?: TContext): StateMachine<TContext, any, TEvent>;
+export declare function Machine<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, TStateSchema, TEvent>, options?: MachineOptions<TContext, TEvent>, initialContext?: TContext): StateMachine<TContext, TStateSchema, TEvent>;
 export declare function createMachine<TContext, TEvent extends EventObject = AnyEventObject, TTypestate extends Typestate<TContext> = {
     value: any;
     context: TContext;
-}>(config: TContext extends Model<any, any, any, any> ? 'Model type no longer supported as generic type. Please use `model.createMachine(...)` instead.' : MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>): StateMachine<TContext, any, TEvent, TTypestate>;
+}, TTypesMeta extends TypegenConstraint = TypegenDisabled>(config: TContext extends Model<any, any, any, any> ? 'Model type no longer supported as generic type. Please use `model.createMachine(...)` instead.' : MachineConfig<TContext, any, TEvent, BaseActionObject, TTypesMeta>, options?: InternalMachineOptions<TContext, TEvent, ResolveTypegenMeta<TTypesMeta, TEvent, BaseActionObject>>): StateMachine<TContext, any, TEvent, any, BaseActionObject, ResolveTypegenMeta<TTypesMeta, TEvent, BaseActionObject>>;
 //# sourceMappingURL=Machine.d.ts.map

package/lib/State.d.ts

@@ -1,19 +1,21 @@
 import { StateValue, ActivityMap, EventObject, HistoryValue, ActionObject, EventType, StateConfig, SCXML, StateSchema, TransitionDefinition, Typestate, ActorRef, StateMachine, SimpleEventsOf } from './types';
 import { StateNode } from './StateNode';
+import { TypegenDisabled, TypegenEnabled } from './typegenTypes';
+import { BaseActionObject, Prop } from './types';
 export declare function stateValuesEqual(a: StateValue | undefined, b: StateValue | undefined): boolean;
 export declare function isState<TContext, TEvent extends EventObject, TStateSchema extends StateSchema<TContext> = any, TTypestate extends Typestate<TContext> = {
     value: any;
     context: TContext;
-}>(state: object | string): state is State<TContext, TEvent, TStateSchema, TTypestate>;
-export declare function bindActionToState<TC, TE extends EventObject>(action: ActionObject<TC, TE>, state: State<TC, TE, any, any>): ActionObject<TC, TE>;
+}, TResolvedTypesMeta = TypegenDisabled>(state: object | string): state is State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
+export declare function bindActionToState<TC, TE extends EventObject>(action: ActionObject<TC, TE>, state: State<TC, TE, any, any, any>): ActionObject<TC, TE>;
 export declare class State<TContext, TEvent extends EventObject = EventObject, TStateSchema extends StateSchema<TContext> = any, TTypestate extends Typestate<TContext> = {
     value: any;
     context: TContext;
-}> {
+}, TResolvedTypesMeta = TypegenDisabled> {
     value: StateValue;
     context: TContext;
     historyValue?: HistoryValue | undefined;
-    history?: State<TContext, TEvent, TStateSchema, TTypestate>;
+    history?: State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
     actions: Array<ActionObject<TContext, TEvent>>;
     activities: ActivityMap;
     meta: any;
@@ -51,13 +53,13 @@ export declare class State<TContext, TEvent extends EventObject = EventObject, T
      */
     children: Record<string, ActorRef<any>>;
     tags: Set<string>;
-    machine: StateMachine<TContext, any, TEvent, TTypestate> | undefined;
+    machine: StateMachine<TContext, any, TEvent, TTypestate, BaseActionObject, TResolvedTypesMeta> | undefined;
     /**
      * Creates a new State instance for the given `stateValue` and `context`.
      * @param stateValue
      * @param context
      */
-    static from<TC, TE extends EventObject = EventObject>(stateValue: State<TC, TE, any, any> | StateValue, context?: TC | undefined): State<TC, TE, any, any>;
+    static from<TC, TE extends EventObject = EventObject>(stateValue: State<TC, TE, any, any, any> | StateValue, context?: TC | undefined): State<TC, TE, any, any, any>;
     /**
      * Creates a new State instance for the given `config`.
      * @param config The state config
@@ -95,17 +97,17 @@ export declare class State<TContext, TEvent extends EventObject = EventObject, T
      * Whether the current state value is a subset of the given parent state value.
      * @param parentStateValue
      */
-    matches<TSV extends TTypestate['value']>(parentStateValue: TSV): this is State<(TTypestate extends any ? {
+    matches<TSV extends TTypestate['value']>(parentStateValue: TResolvedTypesMeta extends TypegenEnabled ? Prop<TResolvedTypesMeta, 'matchesStates'> : TSV): this is State<(TTypestate extends any ? {
         value: TSV;
         context: any;
-    } extends TTypestate ? TTypestate : never : never)['context'], TEvent, TStateSchema, TTypestate> & {
+    } extends TTypestate ? TTypestate : never : never)['context'], TEvent, TStateSchema, TTypestate, TResolvedTypesMeta> & {
         value: TSV;
     };
     /**
      * Whether the current state configuration has a state node with the specified `tag`.
      * @param tag
      */
-    hasTag(tag: string): boolean;
+    hasTag(tag: TResolvedTypesMeta extends TypegenEnabled ? Prop<TResolvedTypesMeta, 'tags'> : string): boolean;
     /**
      * Determines whether sending the `event` will cause a transition.
      * @param event The event to test

package/lib/StateNode.d.ts

@@ -1,9 +1,10 @@
-import { Event, StateValue, MachineOptions, EventObject, HistoryValue, StateNodeDefinition, TransitionDefinition, DelayedTransitionDefinition, ActivityDefinition, StateNodeConfig, StateSchema, StateNodesConfig, InvokeDefinition, ActionObject, Mapper, PropertyMapper, SCXML, Typestate, TransitionDefinitionMap, MachineSchema } from './types';
+import { Event, StateValue, MachineOptions, EventObject, HistoryValue, StateNodeDefinition, TransitionDefinition, DelayedTransitionDefinition, ActivityDefinition, StateNodeConfig, StateSchema, StateNodesConfig, InvokeDefinition, ActionObject, Mapper, PropertyMapper, SCXML, Typestate, TransitionDefinitionMap, MachineSchema, InternalMachineOptions } from './types';
 import { State } from './State';
+import { TypegenDisabled } from './typegenTypes';
 declare class StateNode<TContext = any, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject, TTypestate extends Typestate<TContext> = {
     value: any;
     context: TContext;
-}> {
+}, TResolvedTypesMeta = TypegenDisabled> {
     /**
      * The raw config used to create the machine.
      */
@@ -111,6 +112,7 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
     options: MachineOptions<TContext, TEvent>;
     schema: MachineSchema<TContext, TEvent>;
     __xstatenode: true;
+    description?: string;
     private __cache;
     private idMap;
     tags: string[];
@@ -118,11 +120,15 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
     /**
      * The raw config used to create the machine.
      */
-    config: StateNodeConfig<TContext, TStateSchema, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, 
+    config: StateNodeConfig<TContext, TStateSchema, TEvent>, options?: MachineOptions<TContext, TEvent>, 
     /**
      * The initial extended state
      */
-    _context?: Readonly<TContext> | (() => Readonly<TContext>));
+    _context?: Readonly<TContext> | (() => Readonly<TContext>), // TODO: this is unsafe, but we're removing it in v5 anyway
+    _stateInfo?: {
+        parent: StateNode<any, any, any, any, any>;
+        key: string;
+    });
     private _init;
     /**
      * Clones this state machine with custom options and context.
@@ -130,7 +136,7 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
      * @param options Options (actions, guards, activities, services) to recursively merge with the existing options.
      * @param context Custom context (will override predefined context)
      */
-    withConfig(options: Partial<MachineOptions<TContext, TEvent>>, context?: TContext | (() => TContext)): StateNode<TContext, TStateSchema, TEvent, TTypestate>;
+    withConfig(options: InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, true>, context?: TContext | (() => TContext)): StateNode<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta>;
     /**
      * Clones this state machine with custom context.
      *
@@ -162,7 +168,7 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
      *
      * @param state The state value or State instance
      */
-    getStateNodes(state: StateValue | State<TContext, TEvent, any, TTypestate>): Array<StateNode<TContext, any, TEvent, TTypestate>>;
+    getStateNodes(state: StateValue | State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>): Array<StateNode<TContext, any, TEvent, TTypestate, TResolvedTypesMeta>>;
     /**
      * Returns `true` if this state node explicitly handles the given event.
      *
@@ -176,7 +182,7 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
      *
      * @param state The state to resolve
      */
-    resolveState(state: State<TContext, TEvent, any, any>): State<TContext, TEvent, TStateSchema, TTypestate>;
+    resolveState(state: State<TContext, TEvent, any, any, TResolvedTypesMeta>): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
     private transitionLeafNode;
     private transitionCompoundNode;
     private transitionParallelNode;
@@ -196,25 +202,25 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
      * @param event The event that was sent at the current state
      * @param context The current context (extended state) of the current state
      */
-    transition(state: StateValue | State<TContext, TEvent, any, TTypestate> | undefined, event: Event<TEvent> | SCXML.Event<TEvent>, context?: TContext): State<TContext, TEvent, TStateSchema, TTypestate>;
+    transition(state: StateValue | State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta> | undefined, event: Event<TEvent> | SCXML.Event<TEvent>, context?: TContext): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
     private resolveRaisedTransition;
     private resolveTransition;
     /**
      * Returns the child state node from its relative `stateKey`, or throws.
      */
-    getStateNode(stateKey: string): StateNode<TContext, any, TEvent, TTypestate>;
+    getStateNode(stateKey: string): StateNode<TContext, any, TEvent, TTypestate, TResolvedTypesMeta>;
     /**
      * Returns the state node with the given `stateId`, or throws.
      *
      * @param stateId The state ID. The prefix "#" is removed.
      */
-    getStateNodeById(stateId: string): StateNode<TContext, any, TEvent, any>;
+    getStateNodeById(stateId: string): StateNode<TContext, any, TEvent, any, TResolvedTypesMeta>;
     /**
      * Returns the relative state node from the given `statePath`, or throws.
      *
      * @param statePath The string or string array relative path to the state node.
      */
-    getStateNodeByPath(statePath: string | string[]): StateNode<TContext, any, TEvent, any>;
+    getStateNodeByPath(statePath: string | string[]): StateNode<TContext, any, TEvent, any, any>;
     /**
      * Resolves a partial state value with its full representation in this machine.
      *
@@ -223,12 +229,12 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
     resolve(stateValue: StateValue): StateValue;
     private getResolvedPath;
     private get initialStateValue();
-    getInitialState(stateValue: StateValue, context?: TContext): State<TContext, TEvent, TStateSchema, TTypestate>;
+    getInitialState(stateValue: StateValue, context?: TContext): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
     /**
      * The initial State instance, which includes all actions to be executed from
      * entering the initial state.
      */
-    get initialState(): State<TContext, TEvent, TStateSchema, TTypestate>;
+    get initialState(): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
     /**
      * The target state value of the history state node, if it exists. This represents the
      * default state value to transition to if no history value exists yet.
@@ -242,14 +248,14 @@ declare class StateNode<TContext = any, TStateSchema extends StateSchema = any,
      * @param resolve Whether state nodes should resolve to initial child state nodes
      */
     getRelativeStateNodes(relativeStateId: StateNode<TContext, any, TEvent>, historyValue?: HistoryValue, resolve?: boolean): Array<StateNode<TContext, any, TEvent>>;
-    get initialStateNodes(): Array<StateNode<TContext, any, TEvent, any>>;
+    get initialStateNodes(): Array<StateNode<TContext, any, TEvent, any, any>>;
     /**
      * Retrieves state nodes from a relative path to this state node.
      *
      * @param relativePath The relative path from this state node
      * @param historyValue
      */
-    getFromRelativePath(relativePath: string[]): Array<StateNode<TContext, any, TEvent, any>>;
+    getFromRelativePath(relativePath: string[]): Array<StateNode<TContext, any, TEvent, any, any>>;
     private historyValue;
     /**
      * Resolves to the historical value(s) of the parent state node,