xstate 4.10.0 → 4.14.0

package/es/interpreter.js

@@ -1,12 +1,13 @@
 import { __values, __assign, __spread } from './_virtual/_tslib.js';
 import { IS_PRODUCTION } from './environment.js';
-import { warn, mapContext, isFunction, keys, toSCXMLEvent, isPromiseLike, isObservable, isMachine, reportUnhandledExceptionOnInvocation, symbolObservable, isArray, toEventObject, isString, uniqueId } from './utils.js';
+import { warn, mapContext, isFunction, keys, toSCXMLEvent, toInvokeSource, isPromiseLike, isObservable, isMachine, reportUnhandledExceptionOnInvocation, symbolObservable, isArray, toEventObject, isString, uniqueId } from './utils.js';
 import { ActionTypes, SpecialTargets } from './types.js';
 import { isInFinalState } from './stateUtils.js';
 import { errorPlatform, log, stop, start, cancel, send, update, error as error$1 } from './actionTypes.js';
 import { doneInvoke, initEvent, getActionFunction, error } from './actions.js';
 import { isState, State, bindActionToState } from './State.js';
-import { isActor } from './Actor.js';
+import { provide, consume } from './serviceScope.js';
+import { isActor, createDeferredActor } from './Actor.js';
 import { Scheduler } from './scheduler.js';
 import { registry } from './registry.js';
 import { registerService } from './devTools.js';
@@ -14,23 +15,6 @@ var DEFAULT_SPAWN_OPTIONS = {
   sync: false,
   autoForward: false
 };
-/**
- * Maintains a stack of the current service in scope.
- * This is used to provide the correct service to spawn().
- *
- * @private
- */
-
-var withServiceScope = /*#__PURE__*/function () {
-  var serviceStack = [];
-  return function (service, fn) {
-    service && serviceStack.push(service);
-    var result = fn(service || serviceStack[serviceStack.length - 1]);
-    service && serviceStack.pop();
-    return result;
-  };
-}();
-
 var InterpreterStatus;
 
 (function (InterpreterStatus) {
@@ -71,7 +55,7 @@ function () {
      */
 
     this.initialized = false;
-    this._status = InterpreterStatus.NotStarted;
+    this.status = InterpreterStatus.NotStarted;
     this.children = new Map();
     this.forwardTo = new Set();
     /**
@@ -98,7 +82,7 @@ function () {
 
       var _event = toSCXMLEvent(toEventObject(event, payload));
 
-      if (_this._status === InterpreterStatus.Stopped) {
+      if (_this.status === InterpreterStatus.Stopped) {
         // do nothing
         if (!IS_PRODUCTION) {
           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));
@@ -107,12 +91,7 @@ function () {
         return _this.state;
       }
 
-      if (_this._status === InterpreterStatus.NotStarted && _this.options.deferEvents) {
-        // tslint:disable-next-line:no-console
-        if (!IS_PRODUCTION) {
-          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));
       }
 
@@ -184,23 +163,23 @@ function () {
         return this._initialState;
       }
 
-      return withServiceScope(this, function () {
+      return provide(this, function () {
         _this._initialState = _this.machine.initialState;
         return _this._initialState;
       });
     },
-    enumerable: true,
+    enumerable: false,
     configurable: true
   });
   Object.defineProperty(Interpreter.prototype, "state", {
     get: function () {
       if (!IS_PRODUCTION) {
-        warn(this._status !== InterpreterStatus.NotStarted, "Attempted to read state from uninitialized service '" + this.id + "'. Make sure the service is started first.");
+        warn(this.status !== InterpreterStatus.NotStarted, "Attempted to read state from uninitialized service '" + this.id + "'. Make sure the service is started first.");
       }
 
       return this._state;
     },
-    enumerable: true,
+    enumerable: false,
     configurable: true
   });
   /**
@@ -243,8 +222,12 @@ function () {
 
     if (this.options.execute) {
       this.execute(this.state);
-    } // Dev tools
+    } // Update children
+
 
+    this.children.forEach(function (child) {
+      _this.state.children[child.id] = child;
+    }); // Dev tools
 
     if (this.devTools) {
       this.devTools.send(_event.data, state);
@@ -307,11 +290,33 @@ function () {
     var isDone = isInFinalState(state.configuration || [], this.machine);
 
     if (this.state.configuration && isDone) {
-      // get final child state node
+      // 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.data ? mapContext(finalChildStateNode.data, state.context, _event) : undefined;
+      var doneData = finalChildStateNode && finalChildStateNode.doneData ? mapContext(finalChildStateNode.doneData, state.context, _event) : undefined;
 
       try {
         for (var _l = __values(this.doneListeners), _m = _l.next(); !_m.done; _m = _l.next()) {
@@ -344,15 +349,15 @@ 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;
   };
 
-  Interpreter.prototype.subscribe = function (nextListenerOrObserver, // @ts-ignore
-  errorListener, completeListener) {
+  Interpreter.prototype.subscribe = function (nextListenerOrObserver, _, // TODO: error listener
+  completeListener) {
     var _this = this;
 
     if (!nextListenerOrObserver) {
@@ -375,7 +380,7 @@ function () {
 
     this.listeners.add(listener); // Send current state to listener
 
-    if (this._status === InterpreterStatus.Running) {
+    if (this.status === InterpreterStatus.Running) {
       listener(this.state);
     }
 
@@ -464,15 +469,15 @@ 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.register(this.sessionId, this);
     this.initialized = true;
-    this._status = InterpreterStatus.Running;
-    var resolvedState = initialState === undefined ? this.initialState : withServiceScope(this, function () {
+    this.status = InterpreterStatus.Running;
+    var resolvedState = initialState === undefined ? this.initialState : provide(this, function () {
       return isState(initialState) ? _this.machine.resolveState(initialState) : _this.machine.resolveState(State.from(initialState, _this.machine.context));
     });
 
@@ -493,22 +498,22 @@ function () {
 
 
   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;
+        if (e_7) throw e_7.error;
       }
     }
 
@@ -519,15 +524,15 @@ function () {
         listener();
         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;
+        if (e_8) throw e_8.error;
       }
     }
 
@@ -536,15 +541,15 @@ function () {
         var listener = _l.value;
         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;
+        if (e_9) throw e_9.error;
       }
     }
 
@@ -553,15 +558,15 @@ function () {
         var listener = _o.value;
         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;
+        if (e_10) throw e_10.error;
       }
     } // Stop all children
 
@@ -578,21 +583,21 @@ function () {
         var key = _q.value;
         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;
+        if (e_11) throw e_11.error;
       }
     }
 
     this.scheduler.clear();
     this.initialized = false;
-    this._status = InterpreterStatus.Stopped;
+    this.status = InterpreterStatus.Stopped;
     registry.free(this.sessionId);
     return this;
   };
@@ -600,18 +605,18 @@ function () {
   Interpreter.prototype.batch = function (events) {
     var _this = this;
 
-    if (this._status === InterpreterStatus.NotStarted && this.options.deferEvents) {
+    if (this.status === InterpreterStatus.NotStarted && this.options.deferEvents) {
       // tslint:disable-next-line:no-console
       if (!IS_PRODUCTION) {
         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;
@@ -622,7 +627,7 @@ function () {
 
         _this.forward(_event);
 
-        nextState = withServiceScope(_this, function () {
+        nextState = provide(_this, function () {
           return _this.machine.transition(nextState, _event);
         });
         batchedActions.push.apply(batchedActions, __spread(nextState.actions.map(function (a) {
@@ -637,15 +642,15 @@ 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;
+          if (e_12) throw e_12.error;
         }
       }
 
@@ -685,14 +690,14 @@ function () {
       throw _event.data.data;
     }
 
-    var nextState = withServiceScope(this, function () {
+    var nextState = provide(this, function () {
       return _this.machine.transition(_this.state, _event);
     });
     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()) {
@@ -705,15 +710,15 @@ 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;
+        if (e_13) throw e_13.error;
       }
     }
   };
@@ -797,7 +802,8 @@ function () {
 
 
           if (activity.type === ActionTypes.Invoke) {
-            var serviceCreator = this.machine.options.services ? this.machine.options.services[activity.src] : undefined;
+            var invokeSource = toInvokeSource(activity.src);
+            var serviceCreator = this.machine.options.services ? this.machine.options.services[invokeSource.type] : undefined;
             var id = activity.id,
                 data = activity.data;
 
@@ -817,17 +823,21 @@ function () {
               return;
             }
 
-            var source = isFunction(serviceCreator) ? serviceCreator(context, _event.data) : serviceCreator;
+            var resolvedData = data ? mapContext(data, context, _event) : undefined;
+            var source = isFunction(serviceCreator) ? serviceCreator(context, _event.data, {
+              data: resolvedData,
+              src: invokeSource
+            }) : serviceCreator;
 
             if (isPromiseLike(source)) {
-              this.state.children[id] = this.spawnPromise(Promise.resolve(source), id);
+              this.spawnPromise(Promise.resolve(source), id);
             } else if (isFunction(source)) {
-              this.state.children[id] = this.spawnCallback(source, id);
+              this.spawnCallback(source, id);
             } else if (isObservable(source)) {
-              this.state.children[id] = this.spawnObservable(source, id);
+              this.spawnObservable(source, id);
             } else if (isMachine(source)) {
               // TODO: try/catch here
-              this.state.children[id] = this.spawnMachine(data ? source.withContext(mapContext(data, context, _event)) : source, {
+              this.spawnMachine(resolvedData ? source.withContext(resolvedData) : source, {
                 id: id,
                 autoForward: autoForward
               });
@@ -1243,36 +1253,12 @@ function () {
       logger: global.console.log.bind(console),
       devTools: false
     };
-  }(typeof window === 'undefined' ? global : window);
+  }(typeof self !== 'undefined' ? self : global);
 
   Interpreter.interpret = interpret;
   return Interpreter;
 }();
 
-var createNullActor = function (name) {
-  if (name === void 0) {
-    name = 'null';
-  }
-
-  return {
-    id: name,
-    send: function () {
-      return void 0;
-    },
-    subscribe: function () {
-      // tslint:disable-next-line:no-empty
-      return {
-        unsubscribe: function () {}
-      };
-    },
-    toJSON: function () {
-      return {
-        id: name
-      };
-    }
-  };
-};
-
 var resolveSpawnOptions = function (nameOrOptions) {
   if (isString(nameOrOptions)) {
     return __assign(__assign({}, DEFAULT_SPAWN_OPTIONS), {
@@ -1287,15 +1273,16 @@ var resolveSpawnOptions = function (nameOrOptions) {
 
 function spawn(entity, nameOrOptions) {
   var resolvedOptions = resolveSpawnOptions(nameOrOptions);
-  return withServiceScope(undefined, function (service) {
+  return consume(function (service) {
     if (!IS_PRODUCTION) {
-      warn(!!service, "Attempted to spawn an Actor (ID: \"" + (isMachine(entity) ? entity.id : 'undefined') + "\") outside of a service. This will have no effect.");
+      var isLazyEntity = isMachine(entity) || isFunction(entity);
+      warn(!!service || isLazyEntity, "Attempted to spawn an Actor (ID: \"" + (isMachine(entity) ? entity.id : 'undefined') + "\") outside of a service. This will have no effect.");
     }
 
     if (service) {
       return service.spawn(entity, resolvedOptions.name, resolvedOptions);
     } else {
-      return createNullActor(resolvedOptions.name);
+      return createDeferredActor(entity, resolvedOptions.name);
     }
   });
 }
@@ -1312,4 +1299,4 @@ function interpret(machine, options) {
   return interpreter;
 }
 
-export { Interpreter, interpret, spawn };
+export { Interpreter, InterpreterStatus, interpret, spawn };

package/es/invokeUtils.d.ts

@@ -0,0 +1,7 @@
+import { EventObject, InvokeConfig, InvokeDefinition, InvokeSourceDefinition } from './types';
+export declare function toInvokeSource(src: string | InvokeSourceDefinition): InvokeSourceDefinition;
+export declare function toInvokeDefinition<TContext, TEvent extends EventObject>(invokeConfig: InvokeConfig<TContext, TEvent> & {
+    src: string | InvokeSourceDefinition;
+    id: string;
+}): InvokeDefinition<TContext, TEvent>;
+//# sourceMappingURL=invokeUtils.d.ts.map

package/es/invokeUtils.js

@@ -0,0 +1,39 @@
+import { __assign, __rest } from './_virtual/_tslib.js';
+import { invoke } from './actionTypes.js';
+import './actions.js';
+
+function toInvokeSource(src) {
+  if (typeof src === 'string') {
+    var simpleSrc = {
+      type: src
+    };
+
+    simpleSrc.toString = function () {
+      return src;
+    }; // v4 compat - TODO: remove in v5
+
+
+    return simpleSrc;
+  }
+
+  return src;
+}
+
+function toInvokeDefinition(invokeConfig) {
+  return __assign(__assign({
+    type: invoke
+  }, invokeConfig), {
+    toJSON: function () {
+      var onDone = invokeConfig.onDone,
+          onError = invokeConfig.onError,
+          invokeDef = __rest(invokeConfig, ["onDone", "onError"]);
+
+      return __assign(__assign({}, invokeDef), {
+        type: invoke,
+        src: toInvokeSource(invokeConfig.src)
+      });
+    }
+  });
+}
+
+export { toInvokeDefinition, toInvokeSource };

package/es/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/es/serviceScope.d.ts

@@ -0,0 +1,10 @@
+import { Interpreter } from './interpreter';
+export declare const provide: <T, TService extends Interpreter<any, any, any, {
+    value: any;
+    context: any;
+}>>(service: TService | undefined, fn: (service: TService | undefined) => T) => T;
+export declare const consume: <T, TService extends Interpreter<any, any, any, {
+    value: any;
+    context: any;
+}>>(fn: (service: TService) => T) => T;
+//# sourceMappingURL=serviceScope.d.ts.map

package/es/serviceScope.js

@@ -0,0 +1,18 @@
+/**
+ * Maintains a stack of the current service in scope.
+ * This is used to provide the correct service to spawn().
+ */
+var serviceStack = [];
+
+var provide = function (service, fn) {
+  serviceStack.push(service);
+  var result = fn(service);
+  serviceStack.pop();
+  return result;
+};
+
+var consume = function (fn) {
+  return fn(serviceStack[serviceStack.length - 1]);
+};
+
+export { consume, provide };

package/es/stateUtils.d.ts

@@ -1,7 +1,7 @@
 import { EventObject, StateNode, StateValue } from '.';
 declare type Configuration<TC, TE extends EventObject> = Iterable<StateNode<TC, any, TE>>;
 declare type AdjList<TC, TE extends EventObject> = Map<StateNode<TC, any, TE>, Array<StateNode<TC, any, TE>>>;
-export declare const isLeafNode: (stateNode: StateNode<any, any, any, any>) => boolean;
+export declare const isLeafNode: (stateNode: StateNode<any, any, any>) => boolean;
 export declare function getChildren<TC, TE extends EventObject>(stateNode: StateNode<TC, any, TE>): Array<StateNode<TC, any, TE>>;
 export declare function getAllStateNodes<TC, TE extends EventObject>(stateNode: StateNode<TC, any, TE>): Array<StateNode<TC, any, TE>>;
 export declare function getConfiguration<TC, TE extends EventObject>(prevStateNodes: Iterable<StateNode<TC, any, TE>>, stateNodes: Iterable<StateNode<TC, any, TE>>): Iterable<StateNode<TC, any, TE>>;