xstate 4.13.0 → 4.14.0

package/lib/interpreter.js

@@ -42,7 +42,7 @@ var __spread = (this && this.__spread) || function () {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.interpret = exports.spawn = exports.Interpreter = void 0;
+exports.interpret = exports.spawn = exports.Interpreter = exports.InterpreterStatus = void 0;
 var types_1 = require("./types");
 var State_1 = require("./State");
 var actionTypes = require("./actionTypes");
@@ -61,7 +61,7 @@ var InterpreterStatus;
     InterpreterStatus[InterpreterStatus["NotStarted"] = 0] = "NotStarted";
     InterpreterStatus[InterpreterStatus["Running"] = 1] = "Running";
     InterpreterStatus[InterpreterStatus["Stopped"] = 2] = "Stopped";
-})(InterpreterStatus || (InterpreterStatus = {}));
+})(InterpreterStatus = exports.InterpreterStatus || (exports.InterpreterStatus = {}));
 var Interpreter = /** @class */ (function () {
     /**
      * Creates a new Interpreter instance (i.e., service) for the given machine with the provided options, if any.
@@ -85,7 +85,7 @@ var Interpreter = /** @class */ (function () {
          * Whether the service is started.
          */
         this.initialized = false;
-        this._status = InterpreterStatus.NotStarted;
+        this.status = InterpreterStatus.NotStarted;
         this.children = new Map();
         this.forwardTo = new Set();
         /**
@@ -107,21 +107,15 @@ var Interpreter = /** @class */ (function () {
                 return _this.state;
             }
             var _event = utils_1.toSCXMLEvent(utils_1.toEventObject(event, payload));
-            if (_this._status === InterpreterStatus.Stopped) {
+            if (_this.status === InterpreterStatus.Stopped) {
                 // do nothing
                 if (!environment_1.IS_PRODUCTION) {
                     utils_1.warn(false, "Event \"" + _event.name + "\" was sent to stopped service \"" + _this.machine.id + "\". This service has already reached its final state, and will not transition.\nEvent: " + JSON.stringify(_event.data));
                 }
                 return _this.state;
             }
-            if (_this._status === InterpreterStatus.NotStarted &&
-                _this.options.deferEvents) {
-                // tslint:disable-next-line:no-console
-                if (!environment_1.IS_PRODUCTION) {
-                    utils_1.warn(false, "Event \"" + _event.name + "\" was sent to uninitialized service \"" + _this.machine.id + "\" and is deferred. Make sure .start() is called for this service.\nEvent: " + JSON.stringify(_event.data));
-                }
-            }
-            else if (_this._status !== InterpreterStatus.Running) {
+            if (_this.status !== InterpreterStatus.Running &&
+                !_this.options.deferEvents) {
                 throw new Error("Event \"" + _event.name + "\" was sent to uninitialized service \"" + _this.machine.id + "\". Make sure .start() is called for this service, or set { deferEvents: true } in the service options.\nEvent: " + JSON.stringify(_event.data));
             }
             _this.scheduler.schedule(function () {
@@ -189,7 +183,7 @@ var Interpreter = /** @class */ (function () {
     Object.defineProperty(Interpreter.prototype, "state", {
         get: function () {
             if (!environment_1.IS_PRODUCTION) {
-                utils_1.warn(this._status !== InterpreterStatus.NotStarted, "Attempted to read state from uninitialized service '" + this.id + "'. Make sure the service is started first.");
+                utils_1.warn(this.status !== InterpreterStatus.NotStarted, "Attempted to read state from uninitialized service '" + this.id + "'. Make sure the service is started first.");
             }
             return this._state;
         },
@@ -229,6 +223,10 @@ var Interpreter = /** @class */ (function () {
         if (this.options.execute) {
             this.execute(this.state);
         }
+        // Update children
+        this.children.forEach(function (child) {
+            _this.state.children[child.id] = child;
+        });
         // Dev tools
         if (this.devTools) {
             this.devTools.send(_event.data, state);
@@ -277,6 +275,23 @@ var Interpreter = /** @class */ (function () {
         }
         var isDone = stateUtils_1.isInFinalState(state.configuration || [], this.machine);
         if (this.state.configuration && isDone) {
+            // exit interpreter procedure: https://www.w3.org/TR/scxml/#exitInterpreter
+            this.state.configuration.forEach(function (stateNode) {
+                var e_6, _a;
+                try {
+                    for (var _b = __values(stateNode.definition.exit), _c = _b.next(); !_c.done; _c = _b.next()) {
+                        var action = _c.value;
+                        _this.exec(action, state);
+                    }
+                }
+                catch (e_6_1) { e_6 = { error: e_6_1 }; }
+                finally {
+                    try {
+                        if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                    }
+                    finally { if (e_6) throw e_6.error; }
+                }
+            });
             // get final child state node
             var finalChildStateNode = state.configuration.find(function (sn) { return sn.type === 'final' && sn.parent === _this.machine; });
             var doneData = finalChildStateNode && finalChildStateNode.doneData
@@ -307,7 +322,7 @@ var Interpreter = /** @class */ (function () {
     Interpreter.prototype.onTransition = function (listener) {
         this.listeners.add(listener);
         // Send current state to listener
-        if (this._status === InterpreterStatus.Running) {
+        if (this.status === InterpreterStatus.Running) {
             listener(this.state, this.state.event);
         }
         return this;
@@ -329,7 +344,7 @@ var Interpreter = /** @class */ (function () {
         }
         this.listeners.add(listener);
         // Send current state to listener
-        if (this._status === InterpreterStatus.Running) {
+        if (this.status === InterpreterStatus.Running) {
             listener(this.state);
         }
         if (resolvedCompleteListener) {
@@ -402,13 +417,13 @@ var Interpreter = /** @class */ (function () {
      */
     Interpreter.prototype.start = function (initialState) {
         var _this = this;
-        if (this._status === InterpreterStatus.Running) {
+        if (this.status === InterpreterStatus.Running) {
             // Do not restart the service if it is already started
             return this;
         }
         registry_1.registry.register(this.sessionId, this);
         this.initialized = true;
-        this._status = InterpreterStatus.Running;
+        this.status = InterpreterStatus.Running;
         var resolvedState = initialState === undefined
             ? this.initialState
             : serviceScope.provide(this, function () {
@@ -430,19 +445,19 @@ var Interpreter = /** @class */ (function () {
      * This will also notify the `onStop` listeners.
      */
     Interpreter.prototype.stop = function () {
-        var e_6, _a, e_7, _b, e_8, _c, e_9, _d, e_10, _e;
+        var e_7, _a, e_8, _b, e_9, _c, e_10, _d, e_11, _e;
         try {
             for (var _f = __values(this.listeners), _g = _f.next(); !_g.done; _g = _f.next()) {
                 var listener = _g.value;
                 this.listeners.delete(listener);
             }
         }
-        catch (e_6_1) { e_6 = { error: e_6_1 }; }
+        catch (e_7_1) { e_7 = { error: e_7_1 }; }
         finally {
             try {
                 if (_g && !_g.done && (_a = _f.return)) _a.call(_f);
             }
-            finally { if (e_6) throw e_6.error; }
+            finally { if (e_7) throw e_7.error; }
         }
         try {
             for (var _h = __values(this.stopListeners), _j = _h.next(); !_j.done; _j = _h.next()) {
@@ -452,12 +467,12 @@ var Interpreter = /** @class */ (function () {
                 this.stopListeners.delete(listener);
             }
         }
-        catch (e_7_1) { e_7 = { error: e_7_1 }; }
+        catch (e_8_1) { e_8 = { error: e_8_1 }; }
         finally {
             try {
                 if (_j && !_j.done && (_b = _h.return)) _b.call(_h);
             }
-            finally { if (e_7) throw e_7.error; }
+            finally { if (e_8) throw e_8.error; }
         }
         try {
             for (var _k = __values(this.contextListeners), _l = _k.next(); !_l.done; _l = _k.next()) {
@@ -465,12 +480,12 @@ var Interpreter = /** @class */ (function () {
                 this.contextListeners.delete(listener);
             }
         }
-        catch (e_8_1) { e_8 = { error: e_8_1 }; }
+        catch (e_9_1) { e_9 = { error: e_9_1 }; }
         finally {
             try {
                 if (_l && !_l.done && (_c = _k.return)) _c.call(_k);
             }
-            finally { if (e_8) throw e_8.error; }
+            finally { if (e_9) throw e_9.error; }
         }
         try {
             for (var _m = __values(this.doneListeners), _o = _m.next(); !_o.done; _o = _m.next()) {
@@ -478,12 +493,12 @@ var Interpreter = /** @class */ (function () {
                 this.doneListeners.delete(listener);
             }
         }
-        catch (e_9_1) { e_9 = { error: e_9_1 }; }
+        catch (e_10_1) { e_10 = { error: e_10_1 }; }
         finally {
             try {
                 if (_o && !_o.done && (_d = _m.return)) _d.call(_m);
             }
-            finally { if (e_9) throw e_9.error; }
+            finally { if (e_10) throw e_10.error; }
         }
         // Stop all children
         this.children.forEach(function (child) {
@@ -498,35 +513,35 @@ var Interpreter = /** @class */ (function () {
                 this.clock.clearTimeout(this.delayedEventsMap[key]);
             }
         }
-        catch (e_10_1) { e_10 = { error: e_10_1 }; }
+        catch (e_11_1) { e_11 = { error: e_11_1 }; }
         finally {
             try {
                 if (_q && !_q.done && (_e = _p.return)) _e.call(_p);
             }
-            finally { if (e_10) throw e_10.error; }
+            finally { if (e_11) throw e_11.error; }
         }
         this.scheduler.clear();
         this.initialized = false;
-        this._status = InterpreterStatus.Stopped;
+        this.status = InterpreterStatus.Stopped;
         registry_1.registry.free(this.sessionId);
         return this;
     };
     Interpreter.prototype.batch = function (events) {
         var _this = this;
-        if (this._status === InterpreterStatus.NotStarted &&
+        if (this.status === InterpreterStatus.NotStarted &&
             this.options.deferEvents) {
             // tslint:disable-next-line:no-console
             if (!environment_1.IS_PRODUCTION) {
                 utils_1.warn(false, events.length + " event(s) were sent to uninitialized service \"" + this.machine.id + "\" and are deferred. Make sure .start() is called for this service.\nEvent: " + JSON.stringify(event));
             }
         }
-        else if (this._status !== InterpreterStatus.Running) {
+        else if (this.status !== InterpreterStatus.Running) {
             throw new Error(
             // tslint:disable-next-line:max-line-length
             events.length + " event(s) were sent to uninitialized service \"" + this.machine.id + "\". Make sure .start() is called for this service, or set { deferEvents: true } in the service options.");
         }
         this.scheduler.schedule(function () {
-            var e_11, _a;
+            var e_12, _a;
             var nextState = _this.state;
             var batchChanged = false;
             var batchedActions = [];
@@ -547,12 +562,12 @@ var Interpreter = /** @class */ (function () {
                     _loop_1(event_1);
                 }
             }
-            catch (e_11_1) { e_11 = { error: e_11_1 }; }
+            catch (e_12_1) { e_12 = { error: e_12_1 }; }
             finally {
                 try {
                     if (events_1_1 && !events_1_1.done && (_a = events_1.return)) _a.call(events_1);
                 }
-                finally { if (e_11) throw e_11.error; }
+                finally { if (e_12) throw e_12.error; }
             }
             nextState.changed = batchChanged;
             nextState.actions = batchedActions;
@@ -587,7 +602,7 @@ var Interpreter = /** @class */ (function () {
         return nextState;
     };
     Interpreter.prototype.forward = function (event) {
-        var e_12, _a;
+        var e_13, _a;
         try {
             for (var _b = __values(this.forwardTo), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var id = _c.value;
@@ -598,12 +613,12 @@ var Interpreter = /** @class */ (function () {
                 child.send(event);
             }
         }
-        catch (e_12_1) { e_12 = { error: e_12_1 }; }
+        catch (e_13_1) { e_13 = { error: e_13_1 }; }
         finally {
             try {
                 if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
             }
-            finally { if (e_12) throw e_12.error; }
+            finally { if (e_13) throw e_13.error; }
         }
     };
     Interpreter.prototype.defer = function (sendAction) {
@@ -710,17 +725,17 @@ var Interpreter = /** @class */ (function () {
                         })
                         : serviceCreator;
                     if (utils_1.isPromiseLike(source)) {
-                        this.state.children[id] = this.spawnPromise(Promise.resolve(source), id);
+                        this.spawnPromise(Promise.resolve(source), id);
                     }
                     else if (utils_1.isFunction(source)) {
-                        this.state.children[id] = this.spawnCallback(source, id);
+                        this.spawnCallback(source, id);
                     }
                     else if (utils_1.isObservable(source)) {
-                        this.state.children[id] = this.spawnObservable(source, id);
+                        this.spawnObservable(source, id);
                     }
                     else if (utils_1.isMachine(source)) {
                         // TODO: try/catch here
-                        this.state.children[id] = this.spawnMachine(resolvedData ? source.withContext(resolvedData) : source, {
+                        this.spawnMachine(resolvedData ? source.withContext(resolvedData) : source, {
                             id: id,
                             autoForward: autoForward
                         });

package/lib/match.d.ts

@@ -1,6 +1,9 @@
 import { State } from './State';
 import { StateValue, EventObject } from './types';
 export declare type ValueFromStateGetter<T, TContext, TEvent extends EventObject> = (state: State<TContext, TEvent>) => T;
-export declare type StatePatternTuple<T, TContext, TEvent extends EventObject> = [StateValue, ValueFromStateGetter<T, TContext, TEvent>];
+export declare type StatePatternTuple<T, TContext, TEvent extends EventObject> = [
+    StateValue,
+    ValueFromStateGetter<T, TContext, TEvent>
+];
 export declare function matchState<T, TContext, TEvent extends EventObject>(state: State<TContext, TEvent> | StateValue, patterns: Array<StatePatternTuple<T, TContext, TEvent>>, defaultValue: ValueFromStateGetter<T, TContext, TEvent>): T;
 //# sourceMappingURL=match.d.ts.map

package/lib/types.d.ts

@@ -116,6 +116,24 @@ export interface ActivityDefinition<TContext, TEvent extends EventObject> extend
     type: string;
 }
 export declare type Sender<TEvent extends EventObject> = (event: Event<TEvent>) => void;
+declare type ExcludeType<A> = {
+    [K in Exclude<keyof A, 'type'>]: A[K];
+};
+declare type ExtractExtraParameters<A, T> = A extends {
+    type: T;
+} ? ExcludeType<A> : never;
+declare type ExtractSimple<A> = A extends any ? {} extends ExcludeType<A> ? A : never : never;
+declare type NeverIfEmpty<T> = {} extends T ? never : T;
+export interface PayloadSender<TEvent extends EventObject> {
+    /**
+     * Send an event object or just the event type, if the event has no other payload
+     */
+    (event: TEvent | ExtractSimple<TEvent>['type']): void;
+    /**
+     * Send an event type and its payload
+     */
+    <K extends TEvent['type']>(eventType: K, payload: NeverIfEmpty<ExtractExtraParameters<TEvent, K>>): void;
+}
 export declare type Receiver<TEvent extends EventObject> = (listener: (event: TEvent) => void) => void;
 export declare type InvokeCallback = (callback: Sender<any>, onReceive: Receiver<EventObject>) => any;
 export interface InvokeMeta {
@@ -541,7 +559,7 @@ export interface NullEvent {
 }
 export interface ActivityActionObject<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> {
     type: ActionTypes.Start | ActionTypes.Stop;
-    activity: ActivityDefinition<TContext, TEvent>;
+    activity: ActivityDefinition<TContext, TEvent> | undefined;
     exec: ActionFunction<TContext, TEvent> | undefined;
 }
 export interface InvokeActionObject<TContext, TEvent extends EventObject> extends ActivityActionObject<TContext, TEvent> {
@@ -569,6 +587,20 @@ export interface SendActionObject<TContext, TEvent extends EventObject, TSentEve
     delay?: number;
     id: string | number;
 }
+export interface StopAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> {
+    type: ActionTypes.Stop;
+    activity: string | {
+        id: string;
+    } | Expr<TContext, TEvent, string | {
+        id: string;
+    }>;
+}
+export interface StopActionObject {
+    type: ActionTypes.Stop;
+    activity: {
+        id: string;
+    };
+}
 export declare type Expr<TContext, TEvent extends EventObject, T> = (context: TContext, event: TEvent) => T;
 export declare type ExprWithMeta<TContext, TEvent extends EventObject, T> = (context: TContext, event: TEvent, meta: SCXMLEventMeta<TEvent>) => T;
 export declare type SendExpr<TContext, TEvent extends EventObject, TSentEvent extends EventObject = AnyEventObject> = ExprWithMeta<TContext, TEvent, TSentEvent>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xstate",
-  "version": "4.13.0",
+  "version": "4.14.0",
   "description": "Finite State Machines and Statecharts for the Modern Web.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -52,7 +52,7 @@
     "@babel/core": "^7.10.5",
     "@scion-scxml/test-framework": "^2.0.15",
     "babel-plugin-annotate-pure-calls": "^0.4.0",
-    "jest": "^24.8.0",
+    "jest": "^26.4.2",
     "jsdom": "^14.0.0",
     "jsdom-global": "^3.0.2",
     "lerna-alias": "3.0.3-0",
@@ -64,9 +64,9 @@
     "rollup-plugin-typescript2": "^0.25.2",
     "rollup-plugin-uglify": "^6.0.2",
     "rxjs": "^6.5.1",
-    "ts-jest": "^24.1.9",
+    "ts-jest": "^26.4.0",
     "tslib": "^1.10.0",
-    "typescript": "^3.9.7",
+    "typescript": "^4.0.3",
     "xml-js": "^1.6.11"
   }
 }