xstate 4.7.7 → 4.9.1

package/lib/types.d.ts

@@ -50,7 +50,11 @@ export interface AssignMeta<TContext, TEvent extends EventObject> {
     _event: SCXML.Event<TEvent>;
 }
 export declare type ActionFunction<TContext, TEvent extends EventObject> = (context: TContext, event: TEvent, meta: ActionMeta<TContext, TEvent>) => any | void;
-export declare type Action<TContext, TEvent extends EventObject> = ActionType | ActionObject<TContext, TEvent> | ActionFunction<TContext, TEvent> | AssignAction<Required<TContext>, TEvent> | SendAction<TContext, TEvent> | RaiseAction<AnyEventObject>;
+export interface ChooseConditon<TContext, TEvent extends EventObject> {
+    cond?: Condition<TContext, TEvent>;
+    actions: Actions<TContext, TEvent>;
+}
+export declare type Action<TContext, TEvent extends EventObject> = ActionType | ActionObject<TContext, TEvent> | ActionFunction<TContext, TEvent> | AssignAction<Required<TContext>, TEvent> | SendAction<TContext, AnyEventObject> | RaiseAction<AnyEventObject> | ChooseAction<TContext, TEvent>;
 export declare type Actions<TContext, TEvent extends EventObject> = SingleOrArray<Action<TContext, TEvent>>;
 export declare type StateKey = string | State<any>;
 export interface StateValueMap {
@@ -124,7 +128,7 @@ export declare type InvokeCallback = (callback: Sender<any>, onReceive: Receiver
  * @param context The current machine `context`
  * @param event The event that invoked the service
  */
-export declare type InvokeCreator<TContext, TFinalContext = any> = (context: TContext, event: AnyEventObject) => PromiseLike<TFinalContext> | StateMachine<TFinalContext, any, any> | Subscribable<any> | InvokeCallback;
+export declare type InvokeCreator<TContext, TEvent = AnyEventObject, TFinalContext = any> = (context: TContext, event: TEvent) => PromiseLike<TFinalContext> | StateMachine<TFinalContext, any, any> | Subscribable<any> | InvokeCallback;
 export interface InvokeDefinition<TContext, TEvent extends EventObject> extends ActivityDefinition<TContext, TEvent> {
     /**
      * The source of the machine to be invoked, or the machine itself.
@@ -171,21 +175,28 @@ export declare type StatesConfig<TContext, TStateSchema extends StateSchema, TEv
 export declare type StatesDefinition<TContext, TStateSchema extends StateSchema, TEvent extends EventObject> = {
     [K in keyof TStateSchema['states']]: StateNodeDefinition<TContext, TStateSchema['states'][K], TEvent>;
 };
-export declare type TransitionConfigTargetShortcut<TContext, TEvent extends EventObject> = string | undefined | StateNode<TContext, any, TEvent>;
+export declare type TransitionConfigTarget<TContext, TEvent extends EventObject> = string | undefined | StateNode<TContext, any, TEvent>;
+export declare type TransitionConfigOrTarget<TContext, TEvent extends EventObject> = SingleOrArray<TransitionConfigTarget<TContext, TEvent> | TransitionConfig<TContext, TEvent>>;
 declare type TransitionsConfigMap<TContext, TEvent extends EventObject> = {
-    [K in TEvent['type'] | NullEvent['type'] | '*']?: SingleOrArray<TransitionConfigTargetShortcut<TContext, TEvent> | (TransitionConfig<TContext, K extends TEvent['type'] ? Extract<TEvent, {
+    [K in TEvent['type']]?: TransitionConfigOrTarget<TContext, TEvent extends {
         type: K;
-    }> : EventObject> & {
-        event?: undefined;
-    })>;
+    } ? TEvent : never>;
+} & {
+    ''?: TransitionConfigOrTarget<TContext, TEvent>;
+} & {
+    '*'?: TransitionConfigOrTarget<TContext, TEvent>;
 };
 declare type TransitionsConfigArray<TContext, TEvent extends EventObject> = Array<{
-    [K in TEvent['type'] | NullEvent['type'] | '*']: TransitionConfig<TContext, K extends TEvent['type'] ? Extract<TEvent, {
+    [K in TEvent['type']]: TransitionConfig<TContext, TEvent extends {
         type: K;
-    }> : EventObject> & {
+    } ? TEvent : never> & {
         event: K;
     };
-}[TEvent['type'] | NullEvent['type'] | '*']>;
+}[TEvent['type']] | (TransitionConfig<TContext, TEvent> & {
+    event: '';
+}) | (TransitionConfig<TContext, TEvent> & {
+    event: '*';
+})>;
 export declare type TransitionsConfig<TContext, TEvent extends EventObject> = TransitionsConfigMap<TContext, TEvent> | TransitionsConfigArray<TContext, TEvent>;
 export declare type InvokeConfig<TContext, TEvent extends EventObject> = {
     /**
@@ -196,7 +207,7 @@ export declare type InvokeConfig<TContext, TEvent extends EventObject> = {
     /**
      * The source of the machine to be invoked, or the machine itself.
      */
-    src: string | StateMachine<any, any, any> | InvokeCreator<any, any>;
+    src: string | StateMachine<any, any, any> | InvokeCreator<TContext, TEvent, any>;
     /**
      * If `true`, events sent to the parent service will be forwarded to the invoked service.
      *
@@ -345,14 +356,15 @@ export interface StateNodeDefinition<TContext, TStateSchema extends StateSchema,
     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>>;
-    onEntry: Array<ActionObject<TContext, TEvent>>;
-    onExit: Array<ActionObject<TContext, TEvent>>;
+    entry: Array<ActionObject<TContext, TEvent>>;
+    exit: Array<ActionObject<TContext, TEvent>>;
     activities: Array<ActivityDefinition<TContext, TEvent>>;
     meta: any;
     order: number;
@@ -478,7 +490,8 @@ export declare enum ActionTypes {
     ErrorPlatform = "error.platform",
     ErrorCustom = "xstate.error",
     Update = "xstate.update",
-    Pure = "xstate.pure"
+    Pure = "xstate.pure",
+    Choose = "xstate.choose"
 }
 export interface RaiseAction<TEvent extends EventObject> {
     type: ActionTypes.Raise;
@@ -576,6 +589,10 @@ export interface PureAction<TContext, TEvent extends EventObject> extends Action
     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<ChooseConditon<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>;

package/lib/types.js

@@ -21,6 +21,7 @@ var ActionTypes;
     ActionTypes["ErrorCustom"] = "xstate.error";
     ActionTypes["Update"] = "xstate.update";
     ActionTypes["Pure"] = "xstate.pure";
+    ActionTypes["Choose"] = "xstate.choose";
 })(ActionTypes = exports.ActionTypes || (exports.ActionTypes = {}));
 var SpecialTargets;
 (function (SpecialTargets) {

package/lib/utils.d.ts

@@ -1,4 +1,4 @@
-import { Event, StateValue, ActionType, Action, EventObject, PropertyMapper, Mapper, EventType, HistoryValue, AssignAction, Condition, Guard, Subscribable, StateMachine, ConditionPredicate, SCXML, StateLike, EventData, TransitionConfig, TransitionConfigTargetShortcut, NullEvent, SingleOrArray } from './types';
+import { Event, StateValue, ActionType, Action, EventObject, PropertyMapper, Mapper, EventType, HistoryValue, AssignAction, Condition, Subscribable, StateMachine, ConditionPredicate, SCXML, StateLike, EventData, TransitionConfig, TransitionConfigTarget, NullEvent, SingleOrArray, Guard } from './types';
 import { StateNode } from './StateNode';
 import { State } from '.';
 import { Actor } from './Actor';
@@ -59,9 +59,10 @@ export declare function isActor(value: any): value is Actor;
 export declare const uniqueId: () => string;
 export declare function toEventObject<TEvent extends EventObject>(event: Event<TEvent>, payload?: EventData): TEvent;
 export declare function toSCXMLEvent<TEvent extends EventObject>(event: Event<TEvent> | SCXML.Event<TEvent>, scxmlEvent?: Partial<SCXML.Event<TEvent>>): SCXML.Event<TEvent>;
-export declare function toTransitionConfigArray<TContext, TEvent extends EventObject>(event: TEvent['type'] | NullEvent['type'] | '*', configLike: SingleOrArray<TransitionConfig<TContext, TEvent> | TransitionConfigTargetShortcut<TContext, TEvent>>): Array<TransitionConfig<TContext, TEvent> & {
+export declare function toTransitionConfigArray<TContext, TEvent extends EventObject>(event: TEvent['type'] | NullEvent['type'] | '*', configLike: SingleOrArray<TransitionConfig<TContext, TEvent> | TransitionConfigTarget<TContext, TEvent>>): Array<TransitionConfig<TContext, TEvent> & {
     event: TEvent['type'] | NullEvent['type'] | '*';
 }>;
 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>, guard: Guard<TContext, TEvent>, context: TContext, _event: SCXML.Event<TEvent>, state: State<TContext, TEvent>): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.js

@@ -108,10 +108,10 @@ function toStatePath(stateId, delimiter) {
 exports.toStatePath = toStatePath;
 function isStateLike(state) {
     return (typeof state === 'object' &&
-        ('value' in state &&
-            'context' in state &&
-            'event' in state &&
-            '_event' in state));
+        'value' in state &&
+        'context' in state &&
+        'event' in state &&
+        '_event' in state);
 }
 exports.isStateLike = isStateLike;
 function toStateValue(stateValue, delimiter) {
@@ -584,3 +584,21 @@ function reportUnhandledExceptionOnInvocation(originalError, currentError, id) {
     }
 }
 exports.reportUnhandledExceptionOnInvocation = reportUnhandledExceptionOnInvocation;
+function evaluateGuard(machine, guard, context, _event, state) {
+    var guards = machine.options.guards;
+    var guardMeta = {
+        state: state,
+        cond: guard,
+        _event: _event
+    };
+    // TODO: do not hardcode!
+    if (guard.type === constants_1.DEFAULT_GUARD_TYPE) {
+        return guard.predicate(context, _event.data, guardMeta);
+    }
+    var condFn = guards[guard.type];
+    if (!condFn) {
+        throw new Error("Guard '" + guard.type + "' is not implemented on machine '" + machine.id + "'.");
+    }
+    return condFn(context, _event.data, guardMeta);
+}
+exports.evaluateGuard = evaluateGuard;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xstate",
-  "version": "4.7.7",
+  "version": "4.9.1",
   "description": "Finite State Machines and Statecharts for the Modern Web.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -66,7 +66,7 @@
     "rxjs": "^6.5.1",
     "ts-jest": "^24.1.9",
     "tslib": "^1.10.0",
-    "typescript": "^3.7.2",
+    "typescript": "^3.8.3",
     "xml-js": "^1.6.11"
   }
 }