xstate 5.0.0-alpha.5 → 5.0.0-beta.10

package/dist/xstate.esm.js

@@ -1,28 +1,7 @@
-import { c as createDynamicAction, p as pure$1, t as toArray, a as toActionObjects, _ as _createClass, f as formatTransitions, b as toTransitionConfigArray, N as NULL_EVENT, d as formatTransition, m as mapValues, e as memo, g as _createForOfIteratorHelper, h as evaluateGuard, i as _toConsumableArray, j as flatten, k as _classCallCheck, l as _defineProperty, n as createInvokeId, o as toInvokeConfig, q as _objectSpread2, r as invoke, s as _objectWithoutProperties, u as getDelayedTransitions, v as formatInitialTransition, w as getCandidates, x as isString, y as createSpawner, z as createInitEvent, A as getConfiguration, B as getStateNodes, C as resolveStateValue, D as isInFinalState, S as State, E as toSCXMLEvent, F as isSCXMLErrorEvent, G as macrostep, H as transitionNode, I as _slicedToArray, J as getInitialConfiguration, K as resolveActionsAndContext, L as microstep, M as error, O as isStateId, P as getPersistedState, Q as resolveReferencedActor, R as interpret, T as STATE_DELIMITER, U as initEvent, V as matchesState, W as raise, X as send, Y as sendParent, Z as sendTo, $ as log, a0 as cancel, a1 as stop, a2 as assign, a3 as after, a4 as done, a5 as respond, a6 as forwardTo, a7 as escalate, a8 as choose } from './actions-7678b87b.esm.js';
-export { ae as ActionTypes, a9 as Interpreter, aa as InterpreterStatus, af as SpecialTargets, S as State, a2 as assign, ab as doneInvoke, a6 as forwardTo, B as getStateNodes, R as interpret, V as matchesState, ac as pathToStateValue, X as send, Y as sendParent, Z as sendTo, ad as toObserver, E as toSCXMLEvent } from './actions-7678b87b.esm.js';
+import { _ as _createClass, f as formatTransitions, t as toTransitionConfigArray, N as NULL_EVENT, a as formatTransition, m as mapValues, b as memo, c as _createForOfIteratorHelper, e as evaluateGuard, d as _toConsumableArray, g as flatten, h as _classCallCheck, i as _defineProperty, j as toActionObjects, k as toArray, l as createInvokeId, n as toInvokeConfig, o as _objectSpread2, p as invoke, q as _objectWithoutProperties, r as getDelayedTransitions, s as formatInitialTransition, u as getCandidates, v as isString, w as createSpawner, x as getConfiguration, y as getStateNodes, z as resolveStateValue, A as isInFinalState, S as State, B as isErrorEvent, C as macrostep, D as transitionNode, E as _slicedToArray, F as getInitialConfiguration, G as createInitEvent, H as resolveActionsAndContext, I as microstep, J as error, K as isStateId, L as getStateNodeByPath, M as getPersistedState, O as resolveReferencedActor, P as interpret, Q as STATE_DELIMITER, R as initEvent, T as matchesState } from './actions-67f1d04e.esm.js';
+export { ah as ActionTypes, X as Interpreter, Y as InterpreterStatus, ai as SpecialTargets, S as State, af as and, $ as assign, a0 as cancel, a1 as choose, Z as doneInvoke, W as forwardTo, aa as fromCallback, ab as fromEventObservable, a9 as fromObservable, a8 as fromPromise, ac as fromTransition, y as getStateNodes, P as interpret, a2 as log, T as matchesState, ae as not, ag as or, a6 as pathToStateValue, a3 as pure, a4 as raise, V as sendParent, U as sendTo, ad as stateIn, a5 as stop, a7 as toObserver } from './actions-67f1d04e.esm.js';
 import './index-50bd0aff.esm.js';
 
-function pure(getActions) {
-  return createDynamicAction({
-    type: pure$1,
-    params: {
-      get: getActions
-    }
-  }, function (_event, _ref) {
-    var _toArray;
-    var state = _ref.state;
-    return [state, {
-      type: pure$1,
-      params: {
-        actions: (_toArray = toArray(toActionObjects(getActions({
-          context: state.context,
-          event: _event.data
-        })))) !== null && _toArray !== void 0 ? _toArray : []
-      }
-    }];
-  });
-}
-
 var _excluded = ["onDone", "onError"];
 var EMPTY_OBJECT = {};
 var StateNode = /*#__PURE__*/function () {
@@ -80,11 +59,11 @@ var StateNode = /*#__PURE__*/function () {
    */
 
   /**
-   * The data sent with the "done.state._id_" event if this is a final state node.
+   * The output data sent with the "done.state._id_" event if this is a final state node.
    */
 
   /**
-   * The order this state node appears. Corresponds to the implicit SCXML document order.
+   * The order this state node appears. Corresponds to the implicit document order.
    */
 
   function StateNode(
@@ -106,7 +85,7 @@ var StateNode = /*#__PURE__*/function () {
     _defineProperty(this, "parent", void 0);
     _defineProperty(this, "machine", void 0);
     _defineProperty(this, "meta", void 0);
-    _defineProperty(this, "doneData", void 0);
+    _defineProperty(this, "output", void 0);
     _defineProperty(this, "order", -1);
     _defineProperty(this, "description", void 0);
     _defineProperty(this, "tags", []);
@@ -138,7 +117,7 @@ var StateNode = /*#__PURE__*/function () {
     this.entry = toActionObjects(this.config.entry);
     this.exit = toActionObjects(this.config.exit);
     this.meta = this.config.meta;
-    this.doneData = this.type === 'final' ? this.config.data : undefined;
+    this.output = this.type === 'final' ? this.config.output : undefined;
     this.tags = toArray(config.tags);
   }
   _createClass(StateNode, [{
@@ -173,7 +152,7 @@ var StateNode = /*#__PURE__*/function () {
           source: this,
           actions: this.initial.actions,
           eventType: null,
-          external: false,
+          reenter: false,
           toJSON: function toJSON() {
             return {
               target: _this3.initial.target.map(function (t) {
@@ -195,7 +174,7 @@ var StateNode = /*#__PURE__*/function () {
         exit: this.exit,
         meta: this.meta,
         order: this.order || -1,
-        data: this.doneData,
+        output: this.output,
         invoke: this.invoke,
         description: this.description,
         tags: this.tags
@@ -232,9 +211,9 @@ var StateNode = /*#__PURE__*/function () {
             id: resolvedId,
             systemId: systemId,
             toJSON: function toJSON() {
-              var onDone = invokeConfig.onDone,
-                onError = invokeConfig.onError,
-                invokeDefValues = _objectWithoutProperties(invokeConfig, _excluded);
+              invokeConfig.onDone;
+                invokeConfig.onError;
+                var invokeDefValues = _objectWithoutProperties(invokeConfig, _excluded);
               return _objectSpread2(_objectSpread2({}, invokeDefValues), {}, {
                 type: invoke,
                 src: resolvedSrc,
@@ -278,27 +257,15 @@ var StateNode = /*#__PURE__*/function () {
         return formatInitialTransition(_this7, _this7.config.initial || []);
       });
     }
-
-    /**
-     * Returns `true` if this state node explicitly handles the given event.
-     *
-     * @param event The event in question
-     */
-  }, {
-    key: "handles",
-    value: function handles(event) {
-      return this.events.includes(event.type);
-    }
   }, {
     key: "next",
-    value: function next(state, _event) {
+    value: function next(state, event) {
       var _this8 = this;
-      var eventName = _event.name;
+      var eventType = event.type;
       var actions = [];
       var selectedTransition;
-      var candidates = memo(this, "candidates-".concat(eventName.toString()), function () {
-        return getCandidates(_this8, eventName, _this8.machine.config.scxml // Whether token matching should be used
-        );
+      var candidates = memo(this, "candidates-".concat(eventType), function () {
+        return getCandidates(_this8, eventType);
       });
       var _iterator = _createForOfIteratorHelper(candidates),
         _step;
@@ -309,9 +276,9 @@ var StateNode = /*#__PURE__*/function () {
           var resolvedContext = state.context;
           var guardPassed = false;
           try {
-            guardPassed = !guard || evaluateGuard(guard, resolvedContext, _event, state);
+            guardPassed = !guard || evaluateGuard(guard, resolvedContext, event, state);
           } catch (err) {
-            throw new Error("Unable to evaluate guard '".concat(guard.type, "' in transition for event '").concat(eventName, "' in state node '").concat(this.id, "':\n").concat(err.message));
+            throw new Error("Unable to evaluate guard '".concat(guard.type, "' in transition for event '").concat(eventType, "' in state node '").concat(this.id, "':\n").concat(err.message));
           }
           if (guardPassed) {
             actions.push.apply(actions, _toConsumableArray(candidate.actions));
@@ -397,7 +364,7 @@ var StateNode = /*#__PURE__*/function () {
     key: "ownEvents",
     get: function get() {
       var events = new Set(this.transitions.filter(function (transition) {
-        return !(!transition.target && !transition.actions.length && !transition.external);
+        return !(!transition.target && !transition.actions.length && !transition.reenter);
       }).map(function (transition) {
         return transition.eventType;
       }));
@@ -423,13 +390,13 @@ var StateMachine = /*#__PURE__*/function () {
    * The raw config used to create the machine.
    */
   config, options) {
-    var _this$config$schema;
+    var _this$config$types;
     _classCallCheck(this, StateMachine);
     this.config = config;
     _defineProperty(this, "version", void 0);
     _defineProperty(this, "delimiter", void 0);
     _defineProperty(this, "options", void 0);
-    _defineProperty(this, "schema", void 0);
+    _defineProperty(this, "types", void 0);
     _defineProperty(this, "__xstatenode", true);
     _defineProperty(this, "idMap", new Map());
     _defineProperty(this, "root", void 0);
@@ -445,7 +412,7 @@ var StateMachine = /*#__PURE__*/function () {
     this.options = Object.assign(createDefaultOptions(), options);
     this.delimiter = this.config.delimiter || STATE_DELIMITER;
     this.version = this.config.version;
-    this.schema = (_this$config$schema = this.config.schema) !== null && _this$config$schema !== void 0 ? _this$config$schema : {};
+    this.types = (_this$config$types = this.config.types) !== null && _this$config$types !== void 0 ? _this$config$types : {};
     this.transition = this.transition.bind(this);
     this.root = new StateNode(config, {
       _key: this.id,
@@ -545,13 +512,12 @@ var StateMachine = /*#__PURE__*/function () {
       var actorCtx = arguments.length > 2 ? arguments[2] : undefined;
       var currentState = state instanceof State ? state : this.resolveStateValue(state);
       // TODO: handle error events in a better way
-      var scxmlEvent = toSCXMLEvent(event);
-      if (isSCXMLErrorEvent(scxmlEvent) && !currentState.nextEvents.some(function (nextEvent) {
-        return nextEvent === scxmlEvent.name;
+      if (isErrorEvent(event) && !currentState.nextEvents.some(function (nextEvent) {
+        return nextEvent === event.type;
       })) {
-        throw scxmlEvent.data.data;
+        throw event.data;
       }
-      var _macrostep = macrostep(currentState, scxmlEvent, actorCtx),
+      var _macrostep = macrostep(currentState, event, actorCtx),
         nextState = _macrostep.state;
       return nextState;
     }
@@ -569,15 +535,12 @@ var StateMachine = /*#__PURE__*/function () {
       var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.initialState;
       var event = arguments.length > 1 ? arguments[1] : undefined;
       var actorCtx = arguments.length > 2 ? arguments[2] : undefined;
-      var scxmlEvent = toSCXMLEvent(event);
-      var _macrostep2 = macrostep(state, scxmlEvent, actorCtx),
-        microstates = _macrostep2.microstates;
-      return microstates;
+      return macrostep(state, event, actorCtx).microstates;
     }
   }, {
     key: "getTransitionData",
-    value: function getTransitionData(state, _event) {
-      return transitionNode(this.root, state.value, state, _event) || [];
+    value: function getTransitionData(state, event) {
+      return transitionNode(this.root, state.value, state, event) || [];
     }
 
     /**
@@ -597,7 +560,7 @@ var StateMachine = /*#__PURE__*/function () {
         value: {},
         // TODO: this is computed in state constructor
         context: context,
-        _event: createInitEvent({}),
+        event: createInitEvent({}),
         actions: [],
         meta: undefined,
         configuration: config,
@@ -637,8 +600,8 @@ var StateMachine = /*#__PURE__*/function () {
       var preInitialState = this.getPreInitialState(actorCtx, input);
       var nextState = microstep([], preInitialState, actorCtx, initEvent);
       (_nextState$actions = nextState.actions).unshift.apply(_nextState$actions, _toConsumableArray(preInitialState.actions));
-      var _macrostep3 = macrostep(nextState, initEvent, actorCtx),
-        macroState = _macrostep3.state;
+      var _macrostep2 = macrostep(nextState, initEvent, actorCtx),
+        macroState = _macrostep2.state;
       return macroState;
     }
   }, {
@@ -663,12 +626,14 @@ var StateMachine = /*#__PURE__*/function () {
   }, {
     key: "getStateNodeById",
     value: function getStateNodeById(stateId) {
-      var resolvedStateId = isStateId(stateId) ? stateId.slice(STATE_IDENTIFIER.length) : stateId;
+      var fullPath = stateId.split(this.delimiter);
+      var relativePath = fullPath.slice(1);
+      var resolvedStateId = isStateId(fullPath[0]) ? fullPath[0].slice(STATE_IDENTIFIER.length) : fullPath[0];
       var stateNode = this.idMap.get(resolvedStateId);
       if (!stateNode) {
         throw new Error("Child state node '#".concat(resolvedStateId, "' does not exist on machine '").concat(this.id, "'"));
       }
-      return stateNode;
+      return getStateNodeByPath(stateNode, relativePath);
     }
   }, {
     key: "definition",
@@ -691,7 +656,7 @@ var StateMachine = /*#__PURE__*/function () {
     key: "createState",
     value: function createState(stateConfig) {
       var state = stateConfig instanceof State ? stateConfig : new State(stateConfig, this);
-      var _resolveActionsAndCon2 = resolveActionsAndContext(state.actions, state._event, state, undefined),
+      var _resolveActionsAndCon2 = resolveActionsAndContext(state.actions, state.event, state, undefined),
         resolvedState = _resolveActionsAndCon2.nextState;
       return resolvedState;
     }
@@ -775,11 +740,6 @@ function mapState(stateMap, stateId) {
   return stateMap[foundStateId];
 }
 
-function createSchema(schema) {
-  return schema;
-}
-var t = createSchema;
-
 var SimulatedClock = /*#__PURE__*/function () {
   function SimulatedClock() {
     _classCallCheck(this, SimulatedClock);
@@ -827,12 +787,12 @@ var SimulatedClock = /*#__PURE__*/function () {
     value: function flushTimeouts() {
       var _this = this;
       _toConsumableArray(this.timeouts).sort(function (_ref, _ref2) {
-        var _ref3 = _slicedToArray(_ref, 2),
-          _idA = _ref3[0],
-          timeoutA = _ref3[1];
-        var _ref4 = _slicedToArray(_ref2, 2),
-          _idB = _ref4[0],
-          timeoutB = _ref4[1];
+        var _ref3 = _slicedToArray(_ref, 2);
+          _ref3[0];
+          var timeoutA = _ref3[1];
+        var _ref4 = _slicedToArray(_ref2, 2);
+          _ref4[0];
+          var timeoutB = _ref4[1];
         var endA = timeoutA.start + timeoutA.timeout;
         var endB = timeoutB.start + timeoutB.timeout;
         return endB > endA ? -1 : 1;
@@ -856,22 +816,71 @@ var SimulatedClock = /*#__PURE__*/function () {
   return SimulatedClock;
 }();
 
-var actions = {
-  raise: raise,
-  send: send,
-  sendParent: sendParent,
-  sendTo: sendTo,
-  log: log,
-  cancel: cancel,
-  stop: stop,
-  assign: assign,
-  after: after,
-  done: done,
-  respond: respond,
-  forwardTo: forwardTo,
-  escalate: escalate,
-  choose: choose,
-  pure: pure
+var defaultWaitForOptions = {
+  timeout: 10000 // 10 seconds
 };
 
-export { SimulatedClock, StateMachine, StateNode, actions, createMachine, createSchema, mapState, t };
+/**
+ * Subscribes to an actor ref and waits for its emitted value to satisfy
+ * a predicate, and then resolves with that value.
+ * Will throw if the desired state is not reached after a timeout
+ * (defaults to 10 seconds).
+ *
+ * @example
+ * ```js
+ * const state = await waitFor(someService, state => {
+ *   return state.hasTag('loaded');
+ * });
+ *
+ * state.hasTag('loaded'); // true
+ * ```
+ *
+ * @param actorRef The actor ref to subscribe to
+ * @param predicate Determines if a value matches the condition to wait for
+ * @param options
+ * @returns A promise that eventually resolves to the emitted value
+ * that matches the condition
+ */
+function waitFor(actorRef, predicate, options) {
+  var resolvedOptions = _objectSpread2(_objectSpread2({}, defaultWaitForOptions), options);
+  return new Promise(function (res, rej) {
+    var done = false;
+    if (process.env.NODE_ENV !== 'production' && resolvedOptions.timeout < 0) {
+      console.error('`timeout` passed to `waitFor` is negative and it will reject its internal promise immediately.');
+    }
+    var handle = resolvedOptions.timeout === Infinity ? undefined : setTimeout(function () {
+      sub.unsubscribe();
+      rej(new Error("Timeout of ".concat(resolvedOptions.timeout, " ms exceeded")));
+    }, resolvedOptions.timeout);
+    var dispose = function dispose() {
+      clearTimeout(handle);
+      done = true;
+      sub === null || sub === void 0 ? void 0 : sub.unsubscribe();
+    };
+    function checkEmitted(emitted) {
+      if (predicate(emitted)) {
+        dispose();
+        res(emitted);
+      }
+    }
+
+    // See if the current snapshot already matches the predicate
+    checkEmitted(actorRef.getSnapshot());
+    var sub = actorRef.subscribe({
+      next: checkEmitted,
+      error: function error(err) {
+        dispose();
+        rej(err);
+      },
+      complete: function complete() {
+        dispose();
+        rej(new Error("Actor terminated without satisfying predicate"));
+      }
+    });
+    if (done) {
+      sub.unsubscribe();
+    }
+  });
+}
+
+export { SimulatedClock, StateMachine, StateNode, createMachine, mapState, waitFor };