xstate 4.26.0-pr2674-202191175724 → 4.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CHANGELOG.md +29 -10
  2. package/dist/xstate.interpreter.js +1 -1
  3. package/dist/xstate.js +1 -1
  4. package/dist/xstate.web.js +2 -2
  5. package/es/Actor.d.ts +2 -1
  6. package/es/Machine.d.ts +4 -5
  7. package/es/State.d.ts +9 -11
  8. package/es/StateNode.d.ts +14 -15
  9. package/es/StateNode.js +6 -6
  10. package/es/actions.d.ts +5 -4
  11. package/es/behaviors.d.ts +1 -1
  12. package/es/devTools.d.ts +1 -1
  13. package/es/each.d.ts +1 -1
  14. package/es/index.d.ts +0 -1
  15. package/es/interpreter.d.ts +25 -35
  16. package/es/interpreter.js +2 -1
  17. package/es/model.d.ts +2 -2
  18. package/es/model.types.d.ts +9 -8
  19. package/es/scxml.d.ts +2 -2
  20. package/es/stateUtils.d.ts +6 -6
  21. package/es/stateUtils.js +7 -2
  22. package/es/types.d.ts +51 -58
  23. package/es/utils.d.ts +1 -1
  24. package/es/utils.js +1 -1
  25. package/lib/Actor.d.ts +2 -1
  26. package/lib/Machine.d.ts +4 -5
  27. package/lib/State.d.ts +9 -11
  28. package/lib/StateNode.d.ts +14 -15
  29. package/lib/StateNode.js +5 -5
  30. package/lib/actions.d.ts +5 -4
  31. package/lib/behaviors.d.ts +1 -1
  32. package/lib/devTools.d.ts +1 -1
  33. package/lib/each.d.ts +1 -1
  34. package/lib/index.d.ts +0 -1
  35. package/lib/interpreter.d.ts +25 -35
  36. package/lib/interpreter.js +2 -1
  37. package/lib/model.d.ts +2 -2
  38. package/lib/model.types.d.ts +9 -8
  39. package/lib/scxml.d.ts +2 -2
  40. package/lib/stateUtils.d.ts +6 -6
  41. package/lib/stateUtils.js +6 -0
  42. package/lib/types.d.ts +51 -58
  43. package/lib/utils.d.ts +1 -1
  44. package/lib/utils.js +1 -1
  45. package/package.json +2 -6
  46. package/dist/xstate.cjs.d.ts +0 -11
  47. package/dist/xstate.cjs.js +0 -16
  48. package/es/typegenTypes.d.ts +0 -78
  49. package/lib/typegenTypes.d.ts +0 -78
  50. package/lib/typegenTypes.js +0 -2
package/lib/types.d.ts CHANGED
@@ -1,25 +1,9 @@
1
- import { Clock, Interpreter } from './interpreter';
2
- import { Model } from './model.types';
3
- import { State } from './State';
4
1
  import { StateNode } from './StateNode';
5
- import { MarkAllImplementationsAsProvided, MaybeTypegenMachineOptions, TypegenDisabled } from './typegenTypes';
6
- export declare type AnyFunction = (...args: any[]) => any;
2
+ import { State } from './State';
3
+ import { Interpreter, Clock } from './interpreter';
4
+ import { IsNever, Model, Prop } from './model.types';
5
+ declare type AnyFunction = (...args: any[]) => any;
7
6
  declare type ReturnTypeOrValue<T> = T extends AnyFunction ? ReturnType<T> : T;
8
- export declare type IsNever<T> = [T] extends [never] ? true : false;
9
- export declare type Cast<T extends any, TCastType extends any> = T extends TCastType ? T : TCastType;
10
- export declare type Compute<A extends any> = {
11
- [K in keyof A]: A[K];
12
- } & unknown;
13
- export declare type Prop<T, K> = K extends keyof T ? T[K] : never;
14
- export declare type Values<T> = T[keyof T];
15
- export declare type Merge<M, N> = Omit<M, keyof N> & N;
16
- export declare type IndexByType<T extends {
17
- type: string;
18
- }> = {
19
- [K in T['type']]: Extract<T, {
20
- type: K;
21
- }>;
22
- };
23
7
  export declare type EventType = string;
24
8
  export declare type ActionType = string;
25
9
  export declare type MetaObject = Record<string, any>;
@@ -60,7 +44,7 @@ export declare type EventData = Record<string, any> & {
60
44
  * The specified string event types or the specified event objects.
61
45
  */
62
46
  export declare type Event<TEvent extends EventObject> = TEvent['type'] | TEvent;
63
- export interface ActionMeta<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> extends StateMeta<TContext, TEvent> {
47
+ export interface ActionMeta<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> extends StateMeta<TContext, TEvent> {
64
48
  action: TAction;
65
49
  _event: SCXML.Event<TEvent>;
66
50
  }
@@ -69,8 +53,8 @@ export interface AssignMeta<TContext, TEvent extends EventObject> {
69
53
  action: AssignAction<TContext, TEvent>;
70
54
  _event: SCXML.Event<TEvent>;
71
55
  }
72
- export declare type ActionFunction<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> = (context: TContext, event: TEvent, meta: ActionMeta<TContext, TEvent, TAction>) => void;
73
- export interface ChooseConditon<TContext, TEvent extends EventObject> {
56
+ 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;
57
+ export interface ChooseCondition<TContext, TEvent extends EventObject> {
74
58
  cond?: Condition<TContext, TEvent>;
75
59
  actions: Actions<TContext, TEvent>;
76
60
  }
@@ -174,6 +158,7 @@ export declare type InvokeCallback<TEvent extends EventObject = AnyEventObject,
174
158
  export interface InvokeMeta {
175
159
  data: any;
176
160
  src: InvokeSourceDefinition;
161
+ meta?: MetaObject;
177
162
  }
178
163
  /**
179
164
  * Returns either a Promises or a callback handler (for streams of events) given the
@@ -213,6 +198,7 @@ export interface InvokeDefinition<TContext, TEvent extends EventObject> extends
213
198
  * Data should be mapped to match the child machine's context shape.
214
199
  */
215
200
  data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>;
201
+ meta?: MetaObject;
216
202
  }
217
203
  export interface Delay {
218
204
  id: string;
@@ -295,6 +281,10 @@ export interface InvokeConfig<TContext, TEvent extends EventObject> {
295
281
  * The transition to take upon the invoked child machine sending an error event.
296
282
  */
297
283
  onError?: string | SingleOrArray<TransitionConfig<TContext, DoneInvokeEvent<any>>>;
284
+ /**
285
+ * Meta data related to this invocation
286
+ */
287
+ meta?: MetaObject;
298
288
  }
299
289
  export interface StateNodeConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> {
300
290
  /**
@@ -450,6 +440,7 @@ export interface StateNodeDefinition<TContext, TStateSchema extends StateSchema,
450
440
  data?: FinalStateNodeConfig<TContext, TEvent>['data'];
451
441
  invoke: Array<InvokeDefinition<TContext, TEvent>>;
452
442
  description?: string;
443
+ tags: string[];
453
444
  }
454
445
  export declare type AnyStateNodeDefinition = StateNodeDefinition<any, any, any>;
455
446
  export interface AtomicStateNodeConfig<TContext, TEvent extends EventObject> extends StateNodeConfig<TContext, StateSchema, TEvent> {
@@ -471,7 +462,7 @@ export interface FinalStateNodeConfig<TContext, TEvent extends EventObject> exte
471
462
  data?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>;
472
463
  }
473
464
  export declare type SimpleOrStateNodeConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject> = AtomicStateNodeConfig<TContext, TEvent> | StateNodeConfig<TContext, TStateSchema, TEvent>;
474
- export declare type ActionFunctionMap<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> = {
465
+ export declare type ActionFunctionMap<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> = {
475
466
  [K in TAction['type']]?: ActionObject<TContext, TEvent> | ActionFunction<TContext, TEvent, TAction extends {
476
467
  type: K;
477
468
  } ? TAction : never>;
@@ -479,25 +470,25 @@ export declare type ActionFunctionMap<TContext, TEvent extends EventObject, TAct
479
470
  export declare type DelayFunctionMap<TContext, TEvent extends EventObject> = Record<string, DelayConfig<TContext, TEvent>>;
480
471
  export declare type ServiceConfig<TContext, TEvent extends EventObject = AnyEventObject> = string | StateMachine<any, any, any> | InvokeCreator<TContext, TEvent>;
481
472
  export declare type DelayConfig<TContext, TEvent extends EventObject> = number | DelayExpr<TContext, TEvent>;
482
- export interface MachineOptions<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject> {
483
- guards?: Record<string, ConditionPredicate<TContext, TEvent>>;
484
- actions?: ActionFunctionMap<TContext, TEvent, TAction>;
473
+ export interface MachineOptions<TContext, TEvent extends EventObject, TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> {
474
+ guards: Record<string, ConditionPredicate<TContext, TEvent>>;
475
+ actions: ActionFunctionMap<TContext, TEvent, TAction>;
485
476
  /**
486
477
  * @deprecated Use `services` instead.
487
478
  */
488
- activities?: Record<string, ActivityConfig<TContext, TEvent>>;
489
- services?: Record<string, ServiceConfig<TContext, TEvent>>;
490
- delays?: DelayFunctionMap<TContext, TEvent>;
479
+ activities: Record<string, ActivityConfig<TContext, TEvent>>;
480
+ services: Record<string, ServiceConfig<TContext, TEvent>>;
481
+ delays: DelayFunctionMap<TContext, TEvent>;
491
482
  /**
492
483
  * @private
493
484
  */
494
- _parent?: StateNode<TContext, any, TEvent, any, any>;
485
+ _parent?: StateNode<TContext, any, TEvent, any>;
495
486
  /**
496
487
  * @private
497
488
  */
498
489
  _key?: string;
499
490
  }
500
- export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TTypesMeta = TypegenDisabled> extends StateNodeConfig<TContext, TStateSchema, TEvent, TAction> {
491
+ export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = ActionObject<TContext, TEvent>> extends StateNodeConfig<TContext, TStateSchema, TEvent, TAction> {
501
492
  /**
502
493
  * The initial context (extended state)
503
494
  */
@@ -507,7 +498,6 @@ export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEven
507
498
  */
508
499
  version?: string;
509
500
  schema?: MachineSchema<TContext, TEvent>;
510
- tsTypes?: TTypesMeta | true;
511
501
  }
512
502
  export interface MachineSchema<TContext, TEvent extends EventObject> {
513
503
  context?: TContext;
@@ -542,13 +532,13 @@ export interface HistoryStateNode<TContext> extends StateNode<TContext> {
542
532
  export interface StateMachine<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TTypestate extends Typestate<TContext> = {
543
533
  value: any;
544
534
  context: TContext;
545
- }, TAction extends BaseActionObject = BaseActionObject, TResolvedTypesMeta = TypegenDisabled> extends StateNode<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> {
535
+ }, _TAction extends ActionObject<TContext, TEvent> = ActionObject<TContext, TEvent>> extends StateNode<TContext, TStateSchema, TEvent, TTypestate> {
546
536
  id: string;
547
- states: StateNode<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta>['states'];
548
- withConfig(options: MaybeTypegenMachineOptions<TContext, TEvent, TAction, TResolvedTypesMeta, true>, context?: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate, TAction, MarkAllImplementationsAsProvided<TResolvedTypesMeta>>;
549
- withContext(context: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate, any, TResolvedTypesMeta>;
537
+ states: StateNode<TContext, TStateSchema, TEvent>['states'];
538
+ withConfig(options: Partial<MachineOptions<TContext, TEvent>>, context?: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate>;
539
+ withContext(context: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate>;
550
540
  }
551
- 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;
541
+ 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;
552
542
  export interface ActionMap<TContext, TEvent extends EventObject> {
553
543
  onEntry: Array<Action<TContext, TEvent>>;
554
544
  actions: Array<Action<TContext, TEvent>>;
@@ -567,13 +557,13 @@ export interface ActivityMap {
567
557
  }
568
558
  export interface StateTransition<TContext, TEvent extends EventObject> {
569
559
  transitions: Array<TransitionDefinition<TContext, TEvent>>;
570
- configuration: Array<StateNode<TContext, any, TEvent, any, any>>;
571
- entrySet: Array<StateNode<TContext, any, TEvent, any, any>>;
572
- exitSet: Array<StateNode<TContext, any, TEvent, any, any>>;
560
+ configuration: Array<StateNode<TContext, any, TEvent, any>>;
561
+ entrySet: Array<StateNode<TContext, any, TEvent, any>>;
562
+ exitSet: Array<StateNode<TContext, any, TEvent, any>>;
573
563
  /**
574
564
  * The source state that preceded the transition.
575
565
  */
576
- source: State<TContext, any, any, any, any> | undefined;
566
+ source: State<TContext, any, any, any> | undefined;
577
567
  actions: Array<ActionObject<TContext, TEvent>>;
578
568
  }
579
569
  export interface TransitionData<TContext, TEvent extends EventObject> {
@@ -716,7 +706,7 @@ export interface PureAction<TContext, TEvent extends EventObject> extends Action
716
706
  }
717
707
  export interface ChooseAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> {
718
708
  type: ActionTypes.Choose;
719
- conds: Array<ChooseConditon<TContext, TEvent>>;
709
+ conds: Array<ChooseCondition<TContext, TEvent>>;
720
710
  }
721
711
  export interface TransitionDefinition<TContext, TEvent extends EventObject> extends TransitionConfig<TContext, TEvent> {
722
712
  target: Array<StateNode<TContext, any, TEvent>> | undefined;
@@ -794,7 +784,7 @@ export interface SCXMLEventMeta<TEvent extends EventObject> {
794
784
  _event: SCXML.Event<TEvent>;
795
785
  }
796
786
  export interface StateMeta<TContext, TEvent extends EventObject> {
797
- state: State<TContext, TEvent, any, any, any>;
787
+ state: State<TContext, TEvent, any, any>;
798
788
  _event: SCXML.Event<TEvent>;
799
789
  }
800
790
  export interface Typestate<TContext> {
@@ -813,7 +803,7 @@ export interface StateConfig<TContext, TEvent extends EventObject> {
813
803
  _event: SCXML.Event<TEvent>;
814
804
  _sessionid: string | null;
815
805
  historyValue?: HistoryValue | undefined;
816
- history?: State<TContext, TEvent, any, any, any>;
806
+ history?: State<TContext, TEvent>;
817
807
  actions?: Array<ActionObject<TContext, TEvent>>;
818
808
  /**
819
809
  * @deprecated
@@ -826,7 +816,7 @@ export interface StateConfig<TContext, TEvent extends EventObject> {
826
816
  children: Record<string, ActorRef<any>>;
827
817
  done?: boolean;
828
818
  tags?: Set<string>;
829
- machine?: StateMachine<TContext, any, TEvent, any, any, any>;
819
+ machine?: StateMachine<TContext, any, TEvent, any>;
830
820
  }
831
821
  export interface StateSchema<TC = any> {
832
822
  meta?: any;
@@ -839,9 +829,9 @@ export interface InterpreterOptions {
839
829
  /**
840
830
  * Whether state actions should be executed immediately upon transition. Defaults to `true`.
841
831
  */
842
- execute?: boolean;
843
- clock?: Clock;
844
- logger?: (...args: any[]) => void;
832
+ execute: boolean;
833
+ clock: Clock;
834
+ logger: (...args: any[]) => void;
845
835
  parent?: AnyInterpreter;
846
836
  /**
847
837
  * If `true`, defers processing of sent events until the service
@@ -850,7 +840,7 @@ export interface InterpreterOptions {
850
840
  *
851
841
  * Default: `true`
852
842
  */
853
- deferEvents?: boolean;
843
+ deferEvents: boolean;
854
844
  /**
855
845
  * The custom `id` for referencing this service.
856
846
  */
@@ -860,7 +850,8 @@ export interface InterpreterOptions {
860
850
  *
861
851
  * Default: `false`
862
852
  */
863
- devTools?: boolean | object;
853
+ devTools: boolean | object;
854
+ [option: string]: any;
864
855
  }
865
856
  export declare namespace SCXML {
866
857
  interface Event<TEvent extends EventObject> {
@@ -954,16 +945,15 @@ export interface ActorRef<TEvent extends EventObject, TEmitted = any> extends Su
954
945
  * @deprecated Use `ActorRef` instead.
955
946
  */
956
947
  export declare type SpawnedActorRef<TEvent extends EventObject, TEmitted = any> = ActorRef<TEvent, TEmitted>;
957
- export declare type ActorRefWithDeprecatedState<TContext, TEvent extends EventObject, TTypestate extends Typestate<TContext>, TResolvedTypesMeta = TypegenDisabled> = ActorRef<TEvent, State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>> & {
948
+ export declare type ActorRefWithDeprecatedState<TContext, TEvent extends EventObject, TTypestate extends Typestate<TContext>> = ActorRef<TEvent, State<TContext, TEvent, any, TTypestate>> & {
958
949
  /**
959
950
  * @deprecated Use `.getSnapshot()` instead.
960
951
  */
961
- state: State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>;
952
+ state: State<TContext, TEvent, any, TTypestate>;
962
953
  };
963
- 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;
964
- export declare type AnyInterpreter = Interpreter<any, any, any, any, any>;
965
- 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, 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;
966
- export declare type MachineOptionsFrom<T extends StateMachine<any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any>), TRequireMissingImplementations extends boolean = false> = T extends StateMachine<infer TContext, any, infer TEvent, any, any, infer TResolvedTypesMeta> ? MaybeTypegenMachineOptions<TContext, TEvent, any, TResolvedTypesMeta, TRequireMissingImplementations> : T extends (...args: any[]) => StateMachine<infer TContext, any, infer TEvent, any, any, infer TResolvedTypesMeta> ? MaybeTypegenMachineOptions<TContext, TEvent, any, TResolvedTypesMeta, TRequireMissingImplementations> : never;
954
+ 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;
955
+ export declare type AnyInterpreter = Interpreter<any, any, any, any>;
956
+ 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;
967
957
  export interface ActorContext<TEvent extends EventObject, TEmitted> {
968
958
  parent?: ActorRef<any, any>;
969
959
  self: ActorRef<TEvent, TEmitted>;
@@ -976,7 +966,10 @@ export interface Behavior<TEvent extends EventObject, TEmitted = any> {
976
966
  start?: (actorCtx: ActorContext<TEvent, TEmitted>) => TEmitted;
977
967
  }
978
968
  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;
979
- 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;
969
+ 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;
970
+ export declare type EventFrom<T, K extends Prop<TEvent, 'type'> = never, TEvent = ResolveEventType<T>> = IsNever<K> extends true ? TEvent : Extract<TEvent, {
971
+ type: K;
972
+ }>;
980
973
  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;
981
974
  export {};
982
975
  //# sourceMappingURL=types.d.ts.map
package/lib/utils.d.ts CHANGED
@@ -63,7 +63,7 @@ export declare function toTransitionConfigArray<TContext, TEvent extends EventOb
63
63
  }>;
64
64
  export declare function normalizeTarget<TContext, TEvent extends EventObject>(target: SingleOrArray<string | StateNode<TContext, any, TEvent>> | undefined): Array<string | StateNode<TContext, any, TEvent>> | undefined;
65
65
  export declare function reportUnhandledExceptionOnInvocation(originalError: any, currentError: any, id: string): void;
66
- 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;
66
+ 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;
67
67
  export declare function toInvokeSource(src: string | InvokeSourceDefinition): InvokeSourceDefinition;
68
68
  export declare function toObserver<T>(nextHandler: Observer<T> | ((value: T) => void), errorHandler?: (error: any) => void, completionHandler?: () => void): Observer<T>;
69
69
  //# sourceMappingURL=utils.d.ts.map
package/lib/utils.js CHANGED
@@ -552,7 +552,7 @@ function evaluateGuard(machine, guard, context, _event, state) {
552
552
  return ((guards === null || guards === void 0 ? void 0 : guards[guard.name]) || guard.predicate)(context, _event.data, guardMeta);
553
553
  }
554
554
 
555
- var condFn = guards === null || guards === void 0 ? void 0 : guards[guard.type];
555
+ var condFn = guards[guard.type];
556
556
 
557
557
  if (!condFn) {
558
558
  throw new Error("Guard '" + guard.type + "' is not implemented on machine '" + machine.id + "'.");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xstate",
3
- "version": "4.26.0-pr2674-202191175724",
3
+ "version": "4.26.0",
4
4
  "description": "Finite State Machines and Statecharts for the Modern Web.",
5
5
  "main": "lib/index.js",
6
6
  "module": "es/index.js",
@@ -30,11 +30,7 @@
30
30
  "clean": "rm -rf lib es dist tsconfig.tsbuildinfo",
31
31
  "test": "jest",
32
32
  "build": "rollup -c",
33
- "preversion": "npm run test",
34
- "version": "npm run build",
35
- "postversion": "git push --follow-tags",
36
- "prepublishOnly": "npm run build",
37
- "publish:next": "npm version prerelease && npm publish --tag next"
33
+ "prepublishOnly": "npm run build"
38
34
  },
39
35
  "repository": {
40
36
  "type": "git",
@@ -1,11 +0,0 @@
1
- // are you seeing an error that a default export doesn't exist but your source file has a default export?
2
- // you should run `yarn` or `yarn preconstruct dev` if preconstruct dev isn't in your postinstall hook
3
-
4
- // curious why you need to?
5
- // this file exists so that you can import from the entrypoint normally
6
- // except that it points to your source file and you don't need to run build constantly
7
- // which means we need to re-export all of the modules from your source file
8
- // and since export * doesn't include default exports, we need to read your source file
9
- // to check for a default export and re-export it if it exists
10
- // it's not ideal, but it works pretty well ¯\_(ツ)_/¯
11
- export * from "../src/index";
@@ -1,16 +0,0 @@
1
- "use strict";
2
- // this file might look strange and you might be wondering what it's for
3
- // it's lets you import your source files by importing this entrypoint
4
- // as you would import it if it was built with preconstruct build
5
- // this file is slightly different to some others though
6
- // it has a require hook which compiles your code with Babel
7
- // this means that you don't have to set up @babel/register or anything like that
8
- // but you can still require this module and it'll be compiled
9
-
10
- // this bit of code imports the require hook and registers it
11
- let unregister = require("../../../node_modules/@preconstruct/hook").___internalHook(typeof __dirname === 'undefined' ? undefined : __dirname, "../../..", "..");
12
-
13
- // this re-exports the source file
14
- module.exports = require("../src/index.ts");
15
-
16
- unregister();
@@ -1,78 +0,0 @@
1
- import { ActionObject, ActionFunction, Cast, ConditionPredicate, BaseActionObject, DelayConfig, EventObject, InvokeCreator, IndexByType, IsNever, MachineOptions, Prop, Values } from './types';
2
- export interface TypegenDisabled {
3
- '@@xstate/typegen': false;
4
- }
5
- export interface TypegenEnabled {
6
- '@@xstate/typegen': true;
7
- }
8
- export interface TypegenMeta extends TypegenEnabled {
9
- matchesStates: string;
10
- tags: string;
11
- missingImplementations: {
12
- actions: string;
13
- delays: string;
14
- guards: string;
15
- services: string;
16
- };
17
- internalEvents: {};
18
- invokeSrcNameMap: Record<string, string>;
19
- eventsCausingActions: Record<string, string>;
20
- eventsCausingDelays: Record<string, string>;
21
- eventsCausingGuards: Record<string, string>;
22
- eventsCausingServices: Record<string, string>;
23
- }
24
- export interface ResolvedTypegenMeta extends TypegenMeta {
25
- indexedActions: Record<string, BaseActionObject>;
26
- indexedEvents: Record<string, EventObject>;
27
- }
28
- export declare type TypegenConstraint = TypegenEnabled | TypegenDisabled;
29
- export declare type AreAllImplementationsAssumedToBeProvided<TResolvedTypesMeta, TMissingImplementations = Prop<TResolvedTypesMeta, 'missingImplementations'>> = TResolvedTypesMeta extends TypegenEnabled ? IsNever<Values<{
30
- [K in keyof TMissingImplementations]: TMissingImplementations[K];
31
- }>> extends true ? true : false : true;
32
- export declare type MarkAllImplementationsAsProvided<TResolvedTypesMeta> = TResolvedTypesMeta & {
33
- missingImplementations: {
34
- actions: never;
35
- delays: never;
36
- guards: never;
37
- services: never;
38
- };
39
- };
40
- declare type MergeWithInternalEvents<TIndexedEvents, TInternalEvents> = TIndexedEvents & Pick<TInternalEvents, Exclude<keyof TInternalEvents, keyof TIndexedEvents>>;
41
- export declare type ResolveTypegenMeta<TTypesMeta extends TypegenConstraint, TEvent extends EventObject, TAction extends BaseActionObject> = TTypesMeta extends TypegenEnabled ? TTypesMeta & {
42
- indexedActions: IndexByType<TAction>;
43
- indexedEvents: MergeWithInternalEvents<IndexByType<TEvent>, Prop<TTypesMeta, 'internalEvents'>>;
44
- } : TypegenDisabled;
45
- export declare type TypegenMachineOptionsActions<TContext, TResolvedTypesMeta, TEventsCausingActions = Prop<TResolvedTypesMeta, 'eventsCausingActions'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TIndexedActions = Prop<TResolvedTypesMeta, 'indexedActions'>> = {
46
- [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>>;
47
- };
48
- export declare type TypegenMachineOptionsDelays<TContext, TResolvedTypesMeta, TEventsCausingDelays = Prop<TResolvedTypesMeta, 'eventsCausingDelays'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>> = {
49
- [K in keyof TEventsCausingDelays]?: DelayConfig<TContext, Cast<Prop<TIndexedEvents, TEventsCausingDelays[K]>, EventObject>>;
50
- };
51
- export declare type TypegenMachineOptionsGuards<TContext, TResolvedTypesMeta, TEventsCausingGuards = Prop<TResolvedTypesMeta, 'eventsCausingGuards'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>> = {
52
- [K in keyof TEventsCausingGuards]?: ConditionPredicate<TContext, Cast<Prop<TIndexedEvents, TEventsCausingGuards[K]>, EventObject>>;
53
- };
54
- export declare type TypegenMachineOptionsServices<TContext, TResolvedTypesMeta, TEventsCausingServices = Prop<TResolvedTypesMeta, 'eventsCausingServices'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TInvokeSrcNameMap = Prop<TResolvedTypesMeta, 'invokeSrcNameMap'>> = {
55
- [K in keyof TEventsCausingServices]?: InvokeCreator<TContext, Cast<Prop<TIndexedEvents, TEventsCausingServices[K]>, EventObject>, Prop<Prop<TIndexedEvents, Prop<TInvokeSrcNameMap, K>>, 'data'>>;
56
- };
57
- declare type MakeKeysRequired<T extends string> = {
58
- [K in T]: unknown;
59
- };
60
- declare type MaybeMakeMissingImplementationsRequired<TImplementationType, TMissingImplementationsForType, TRequireMissingImplementations> = TRequireMissingImplementations extends true ? IsNever<TMissingImplementationsForType> extends true ? {} : {
61
- [K in Cast<TImplementationType, string>]: MakeKeysRequired<Cast<TMissingImplementationsForType, string>>;
62
- } : {};
63
- declare type GenerateActionsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'actions', Prop<TMissingImplementations, 'actions'>, TRequireMissingImplementations> & {
64
- actions?: TypegenMachineOptionsActions<TContext, TResolvedTypesMeta>;
65
- };
66
- declare type GenerateDelaysConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'delays', Prop<TMissingImplementations, 'delays'>, TRequireMissingImplementations> & {
67
- delays?: TypegenMachineOptionsDelays<TContext, TResolvedTypesMeta>;
68
- };
69
- declare type GenerateGuardsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'guards', Prop<TMissingImplementations, 'guards'>, TRequireMissingImplementations> & {
70
- guards?: TypegenMachineOptionsGuards<TContext, TResolvedTypesMeta>;
71
- };
72
- declare type GenerateServicesConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'services', Prop<TMissingImplementations, 'services'>, TRequireMissingImplementations> & {
73
- services?: TypegenMachineOptionsServices<TContext, TResolvedTypesMeta>;
74
- };
75
- export declare type TypegenMachineOptions<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations = Prop<TResolvedTypesMeta, 'missingImplementations'>> = GenerateActionsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateDelaysConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateGuardsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateServicesConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations>;
76
- export declare type MaybeTypegenMachineOptions<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TResolvedTypesMeta = TypegenDisabled, TRequireMissingImplementations extends boolean = false> = TResolvedTypesMeta extends TypegenEnabled ? TypegenMachineOptions<TContext, TResolvedTypesMeta, TRequireMissingImplementations> : MachineOptions<TContext, TEvent, TAction>;
77
- export {};
78
- //# sourceMappingURL=typegenTypes.d.ts.map
@@ -1,78 +0,0 @@
1
- import { ActionObject, ActionFunction, Cast, ConditionPredicate, BaseActionObject, DelayConfig, EventObject, InvokeCreator, IndexByType, IsNever, MachineOptions, Prop, Values } from './types';
2
- export interface TypegenDisabled {
3
- '@@xstate/typegen': false;
4
- }
5
- export interface TypegenEnabled {
6
- '@@xstate/typegen': true;
7
- }
8
- export interface TypegenMeta extends TypegenEnabled {
9
- matchesStates: string;
10
- tags: string;
11
- missingImplementations: {
12
- actions: string;
13
- delays: string;
14
- guards: string;
15
- services: string;
16
- };
17
- internalEvents: {};
18
- invokeSrcNameMap: Record<string, string>;
19
- eventsCausingActions: Record<string, string>;
20
- eventsCausingDelays: Record<string, string>;
21
- eventsCausingGuards: Record<string, string>;
22
- eventsCausingServices: Record<string, string>;
23
- }
24
- export interface ResolvedTypegenMeta extends TypegenMeta {
25
- indexedActions: Record<string, BaseActionObject>;
26
- indexedEvents: Record<string, EventObject>;
27
- }
28
- export declare type TypegenConstraint = TypegenEnabled | TypegenDisabled;
29
- export declare type AreAllImplementationsAssumedToBeProvided<TResolvedTypesMeta, TMissingImplementations = Prop<TResolvedTypesMeta, 'missingImplementations'>> = TResolvedTypesMeta extends TypegenEnabled ? IsNever<Values<{
30
- [K in keyof TMissingImplementations]: TMissingImplementations[K];
31
- }>> extends true ? true : false : true;
32
- export declare type MarkAllImplementationsAsProvided<TResolvedTypesMeta> = TResolvedTypesMeta & {
33
- missingImplementations: {
34
- actions: never;
35
- delays: never;
36
- guards: never;
37
- services: never;
38
- };
39
- };
40
- declare type MergeWithInternalEvents<TIndexedEvents, TInternalEvents> = TIndexedEvents & Pick<TInternalEvents, Exclude<keyof TInternalEvents, keyof TIndexedEvents>>;
41
- export declare type ResolveTypegenMeta<TTypesMeta extends TypegenConstraint, TEvent extends EventObject, TAction extends BaseActionObject> = TTypesMeta extends TypegenEnabled ? TTypesMeta & {
42
- indexedActions: IndexByType<TAction>;
43
- indexedEvents: MergeWithInternalEvents<IndexByType<TEvent>, Prop<TTypesMeta, 'internalEvents'>>;
44
- } : TypegenDisabled;
45
- export declare type TypegenMachineOptionsActions<TContext, TResolvedTypesMeta, TEventsCausingActions = Prop<TResolvedTypesMeta, 'eventsCausingActions'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TIndexedActions = Prop<TResolvedTypesMeta, 'indexedActions'>> = {
46
- [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>>;
47
- };
48
- export declare type TypegenMachineOptionsDelays<TContext, TResolvedTypesMeta, TEventsCausingDelays = Prop<TResolvedTypesMeta, 'eventsCausingDelays'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>> = {
49
- [K in keyof TEventsCausingDelays]?: DelayConfig<TContext, Cast<Prop<TIndexedEvents, TEventsCausingDelays[K]>, EventObject>>;
50
- };
51
- export declare type TypegenMachineOptionsGuards<TContext, TResolvedTypesMeta, TEventsCausingGuards = Prop<TResolvedTypesMeta, 'eventsCausingGuards'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>> = {
52
- [K in keyof TEventsCausingGuards]?: ConditionPredicate<TContext, Cast<Prop<TIndexedEvents, TEventsCausingGuards[K]>, EventObject>>;
53
- };
54
- export declare type TypegenMachineOptionsServices<TContext, TResolvedTypesMeta, TEventsCausingServices = Prop<TResolvedTypesMeta, 'eventsCausingServices'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TInvokeSrcNameMap = Prop<TResolvedTypesMeta, 'invokeSrcNameMap'>> = {
55
- [K in keyof TEventsCausingServices]?: InvokeCreator<TContext, Cast<Prop<TIndexedEvents, TEventsCausingServices[K]>, EventObject>, Prop<Prop<TIndexedEvents, Prop<TInvokeSrcNameMap, K>>, 'data'>>;
56
- };
57
- declare type MakeKeysRequired<T extends string> = {
58
- [K in T]: unknown;
59
- };
60
- declare type MaybeMakeMissingImplementationsRequired<TImplementationType, TMissingImplementationsForType, TRequireMissingImplementations> = TRequireMissingImplementations extends true ? IsNever<TMissingImplementationsForType> extends true ? {} : {
61
- [K in Cast<TImplementationType, string>]: MakeKeysRequired<Cast<TMissingImplementationsForType, string>>;
62
- } : {};
63
- declare type GenerateActionsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'actions', Prop<TMissingImplementations, 'actions'>, TRequireMissingImplementations> & {
64
- actions?: TypegenMachineOptionsActions<TContext, TResolvedTypesMeta>;
65
- };
66
- declare type GenerateDelaysConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'delays', Prop<TMissingImplementations, 'delays'>, TRequireMissingImplementations> & {
67
- delays?: TypegenMachineOptionsDelays<TContext, TResolvedTypesMeta>;
68
- };
69
- declare type GenerateGuardsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'guards', Prop<TMissingImplementations, 'guards'>, TRequireMissingImplementations> & {
70
- guards?: TypegenMachineOptionsGuards<TContext, TResolvedTypesMeta>;
71
- };
72
- declare type GenerateServicesConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> = MaybeMakeMissingImplementationsRequired<'services', Prop<TMissingImplementations, 'services'>, TRequireMissingImplementations> & {
73
- services?: TypegenMachineOptionsServices<TContext, TResolvedTypesMeta>;
74
- };
75
- export declare type TypegenMachineOptions<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations = Prop<TResolvedTypesMeta, 'missingImplementations'>> = GenerateActionsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateDelaysConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateGuardsConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations> & GenerateServicesConfigPart<TContext, TResolvedTypesMeta, TRequireMissingImplementations, TMissingImplementations>;
76
- export declare type MaybeTypegenMachineOptions<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TResolvedTypesMeta = TypegenDisabled, TRequireMissingImplementations extends boolean = false> = TResolvedTypesMeta extends TypegenEnabled ? TypegenMachineOptions<TContext, TResolvedTypesMeta, TRequireMissingImplementations> : MachineOptions<TContext, TEvent, TAction>;
77
- export {};
78
- //# sourceMappingURL=typegenTypes.d.ts.map
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });