xstate 4.31.0 → 5.0.0-alpha.0

package/dist/Machine-fb2f47f5.esm.js

@@ -0,0 +1,751 @@
+import { b as _createClass, J as formatTransitions, K as toTransitionConfigArray, N as NULL_EVENT, L as formatTransition, M as mapValues, P as memo, Q as getEventType, _ as _createForOfIteratorHelper, R as evaluateGuard, d as _toConsumableArray, T as flatten, e as _classCallCheck, f as _defineProperty, t as toArray, U as toActionObject, V as createInvokeId, W as toInvokeConfig, X as _objectSpread2, Y as invoke, Z as _objectWithoutProperties, $ as getDelayedTransitions, a0 as formatInitialTransition, a1 as getCandidates, a2 as toInvokeSource, a3 as isString, a4 as createSpawner, a5 as getConfiguration, B as getStateNodes, a6 as resolveStateValue, a7 as toState, a8 as macrostep, F as toSCXMLEvent, a9 as isBuiltInEvent, aa as resolveMicroTransition, ab as transitionNode, a as _slicedToArray, S as State, ac as getStateValue, ad as isStateId, ae as isFunction, af as STATE_DELIMITER } from './actions-ff512f16.esm.js';
+import { I as IS_PRODUCTION } from './index-20b364c4.esm.js';
+
+var _excluded = ["onDone", "onError"];
+var EMPTY_OBJECT = {};
+var StateNode = /*#__PURE__*/function () {
+  /**
+   * The relative key of the state node, which represents its location in the overall state value.
+   */
+
+  /**
+   * The unique ID of the state node.
+   */
+
+  /**
+   * The type of this state node:
+   *
+   *  - `'atomic'` - no child state nodes
+   *  - `'compound'` - nested child state nodes (XOR)
+   *  - `'parallel'` - orthogonal nested child state nodes (AND)
+   *  - `'history'` - history state node
+   *  - `'final'` - final state node
+   */
+
+  /**
+   * The string path from the root machine node to this node.
+   */
+
+  /**
+   * The child state nodes.
+   */
+
+  /**
+   * The type of history on this state node. Can be:
+   *
+   *  - `'shallow'` - recalls only top-level historical state value
+   *  - `'deep'` - recalls historical state value at all levels
+   */
+
+  /**
+   * The action(s) to be executed upon entering the state node.
+   */
+
+  /**
+   * The action(s) to be executed upon exiting the state node.
+   */
+
+  /**
+   * The parent state node.
+   */
+
+  /**
+   * The root machine node.
+   */
+
+  /**
+   * The meta data associated with this state node, which will be returned in State instances.
+   */
+
+  /**
+   * The 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.
+   */
+  function StateNode(
+  /**
+   * The raw config used to create the machine.
+   */
+  config, options) {
+    var _this = this;
+
+    _classCallCheck(this, StateNode);
+
+    this.config = config;
+
+    _defineProperty(this, "key", void 0);
+
+    _defineProperty(this, "id", void 0);
+
+    _defineProperty(this, "type", void 0);
+
+    _defineProperty(this, "path", void 0);
+
+    _defineProperty(this, "states", void 0);
+
+    _defineProperty(this, "history", void 0);
+
+    _defineProperty(this, "entry", void 0);
+
+    _defineProperty(this, "exit", void 0);
+
+    _defineProperty(this, "parent", void 0);
+
+    _defineProperty(this, "machine", void 0);
+
+    _defineProperty(this, "meta", void 0);
+
+    _defineProperty(this, "doneData", void 0);
+
+    _defineProperty(this, "order", -1);
+
+    _defineProperty(this, "description", void 0);
+
+    _defineProperty(this, "tags", []);
+
+    _defineProperty(this, "transitions", void 0);
+
+    _defineProperty(this, "always", void 0);
+
+    this.parent = options._parent;
+    this.key = this.config.key || options._key;
+    this.machine = options._machine;
+    this.path = this.parent ? this.parent.path.concat(this.key) : [];
+    this.id = this.config.id || [this.machine.key].concat(_toConsumableArray(this.path)).join(this.machine.delimiter);
+    this.type = this.config.type || (this.config.states && Object.keys(this.config.states).length ? 'compound' : this.config.history ? 'history' : 'atomic');
+    this.description = this.config.description;
+    this.order = this.machine.idMap.size;
+    this.machine.idMap.set(this.id, this);
+    this.states = this.config.states ? mapValues(this.config.states, function (stateConfig, key) {
+      var stateNode = new StateNode(stateConfig, {
+        _parent: _this,
+        _key: key,
+        _machine: _this.machine
+      });
+      return stateNode;
+    }) : EMPTY_OBJECT;
+
+    if (this.type === 'compound' && !this.config.initial) {
+      throw new Error("No initial state specified for compound state node \"#".concat(this.id, "\". Try adding { initial: \"").concat(Object.keys(this.states)[0], "\" } to the state config."));
+    } // History config
+
+
+    this.history = this.config.history === true ? 'shallow' : this.config.history || false;
+    this.entry = toArray(this.config.entry).map(function (action) {
+      return toActionObject(action, _this.machine.options.actions);
+    });
+    this.exit = toArray(this.config.exit).map(function (action) {
+      return toActionObject(action, _this.machine.options.actions);
+    });
+    this.meta = this.config.meta;
+    this.doneData = this.type === 'final' ? this.config.data : undefined;
+    this.tags = toArray(config.tags);
+  }
+
+  _createClass(StateNode, [{
+    key: "_initialize",
+    value: function _initialize() {
+      var _this2 = this;
+
+      this.transitions = formatTransitions(this);
+
+      if (this.config.always) {
+        this.always = toTransitionConfigArray(NULL_EVENT, this.config.always).map(function (t) {
+          return formatTransition(_this2, t);
+        });
+      }
+
+      Object.keys(this.states).forEach(function (key) {
+        _this2.states[key]._initialize();
+      });
+    }
+    /**
+     * The well-structured state node definition.
+     */
+
+  }, {
+    key: "definition",
+    get: function get() {
+      var _this3 = this;
+
+      return {
+        id: this.id,
+        key: this.key,
+        version: this.machine.version,
+        context: this.machine.context,
+        type: this.type,
+        initial: this.initial ? {
+          target: this.initial.target,
+          source: this,
+          actions: this.initial.actions,
+          eventType: null,
+          toJSON: function toJSON() {
+            return {
+              target: _this3.initial.target.map(function (t) {
+                return "#".concat(t.id);
+              }),
+              source: "#".concat(_this3.id),
+              actions: _this3.initial.actions,
+              eventType: null
+            };
+          }
+        } : undefined,
+        history: this.history,
+        states: mapValues(this.states, function (state) {
+          return state.definition;
+        }),
+        on: this.on,
+        transitions: this.transitions,
+        entry: this.entry,
+        exit: this.exit,
+        meta: this.meta,
+        order: this.order || -1,
+        data: this.doneData,
+        invoke: this.invoke,
+        description: this.description,
+        tags: this.tags
+      };
+    }
+  }, {
+    key: "toJSON",
+    value: function toJSON() {
+      return this.definition;
+    }
+    /**
+     * The behaviors invoked as actors by this state node.
+     */
+
+  }, {
+    key: "invoke",
+    get: function get() {
+      var _this4 = this;
+
+      return memo(this, 'invoke', function () {
+        return toArray(_this4.config.invoke).map(function (invocable, i) {
+          var generatedId = createInvokeId(_this4.id, i);
+          var invokeConfig = toInvokeConfig(invocable, generatedId);
+          var resolvedId = invokeConfig.id || generatedId;
+          var src = invokeConfig.src;
+          var resolvedSrc = toInvokeSource(isString(src) ? src : !('type' in src) ? resolvedId : src);
+
+          if (!_this4.machine.options.actors[resolvedId] && typeof src !== 'string' && !('type' in src)) {
+            _this4.machine.options.actors = _objectSpread2(_objectSpread2({}, _this4.machine.options.actors), {}, _defineProperty({}, resolvedId, typeof src === 'function' ? src : function () {
+              return src;
+            }));
+          }
+
+          return _objectSpread2(_objectSpread2({
+            type: invoke
+          }, invokeConfig), {}, {
+            src: resolvedSrc,
+            id: resolvedId,
+            toJSON: function toJSON() {
+              var onDone = invokeConfig.onDone,
+                  onError = invokeConfig.onError,
+                  invokeDefValues = _objectWithoutProperties(invokeConfig, _excluded);
+
+              return _objectSpread2(_objectSpread2({}, invokeDefValues), {}, {
+                type: invoke,
+                src: resolvedSrc,
+                id: resolvedId
+              });
+            }
+          });
+        });
+      });
+    }
+    /**
+     * The mapping of events to transitions.
+     */
+
+  }, {
+    key: "on",
+    get: function get() {
+      var _this5 = this;
+
+      return memo(this, 'on', function () {
+        var transitions = _this5.transitions;
+        return transitions.reduce(function (map, transition) {
+          map[transition.eventType] = map[transition.eventType] || [];
+          map[transition.eventType].push(transition);
+          return map;
+        }, {});
+      });
+    }
+  }, {
+    key: "after",
+    get: function get() {
+      var _this6 = this;
+
+      return memo(this, 'delayedTransitions', function () {
+        return getDelayedTransitions(_this6);
+      });
+    }
+  }, {
+    key: "initial",
+    get: function get() {
+      var _this7 = this;
+
+      return memo(this, 'initial', 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) {
+      var eventType = getEventType(event);
+      return this.events.includes(eventType);
+    }
+  }, {
+    key: "next",
+    value: function next(state, _event) {
+      var _this8 = this;
+
+      var eventName = _event.name;
+      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 _iterator = _createForOfIteratorHelper(candidates),
+          _step;
+
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var candidate = _step.value;
+          var guard = candidate.guard;
+          var resolvedContext = state.context;
+          var guardPassed = false;
+
+          try {
+            guardPassed = !guard || evaluateGuard(guard, resolvedContext, _event, state, this.machine);
+          } 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));
+          }
+
+          if (guardPassed) {
+            actions.push.apply(actions, _toConsumableArray(candidate.actions));
+            selectedTransition = candidate;
+            break;
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+
+      return selectedTransition ? [selectedTransition] : undefined;
+    }
+    /**
+     * The target state value of the history state node, if it exists. This represents the
+     * default state value to transition to if no history value exists yet.
+     */
+
+  }, {
+    key: "target",
+    get: function get() {
+      if (this.type === 'history') {
+        var historyConfig = this.config;
+        return historyConfig.target;
+      }
+
+      return undefined;
+    }
+    /**
+     * All the state node IDs of this state node and its descendant state nodes.
+     */
+
+  }, {
+    key: "stateIds",
+    get: function get() {
+      var _this9 = this;
+
+      var childStateIds = flatten(Object.keys(this.states).map(function (stateKey) {
+        return _this9.states[stateKey].stateIds;
+      }));
+      return [this.id].concat(childStateIds);
+    }
+    /**
+     * All the event types accepted by this state node and its descendants.
+     */
+
+  }, {
+    key: "events",
+    get: function get() {
+      var _this10 = this;
+
+      return memo(this, 'events', function () {
+        var states = _this10.states;
+        var events = new Set(_this10.ownEvents);
+
+        if (states) {
+          for (var _i = 0, _Object$keys = Object.keys(states); _i < _Object$keys.length; _i++) {
+            var stateId = _Object$keys[_i];
+            var state = states[stateId];
+
+            if (state.states) {
+              var _iterator2 = _createForOfIteratorHelper(state.events),
+                  _step2;
+
+              try {
+                for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+                  var event = _step2.value;
+                  events.add("".concat(event));
+                }
+              } catch (err) {
+                _iterator2.e(err);
+              } finally {
+                _iterator2.f();
+              }
+            }
+          }
+        }
+
+        return Array.from(events);
+      });
+    }
+    /**
+     * All the events that have transitions directly from this state node.
+     *
+     * Excludes any inert events.
+     */
+
+  }, {
+    key: "ownEvents",
+    get: function get() {
+      var events = new Set(this.transitions.filter(function (transition) {
+        return !(!transition.target && !transition.actions.length && transition.internal);
+      }).map(function (transition) {
+        return transition.eventType;
+      }));
+      return Array.from(events);
+    }
+  }]);
+
+  return StateNode;
+}();
+
+var STATE_IDENTIFIER = '#';
+var WILDCARD = '*';
+
+function createDefaultOptions() {
+  return {
+    actions: {},
+    actors: {},
+    delays: {},
+    guards: {},
+    context: {}
+  };
+}
+
+function resolveContext(context, partialContext) {
+  if (isFunction(partialContext)) {
+    return _objectSpread2(_objectSpread2({}, context), partialContext);
+  }
+
+  return _objectSpread2(_objectSpread2({}, context), partialContext);
+}
+
+var StateMachine = /*#__PURE__*/function () {
+  function StateMachine(
+  /**
+   * The raw config used to create the machine.
+   */
+  config, options) {
+    var _this$config$schema;
+
+    _classCallCheck(this, StateMachine);
+
+    this.config = config;
+
+    _defineProperty(this, "_contextFactory", void 0);
+
+    _defineProperty(this, "version", void 0);
+
+    _defineProperty(this, "strict", void 0);
+
+    _defineProperty(this, "delimiter", void 0);
+
+    _defineProperty(this, "options", void 0);
+
+    _defineProperty(this, "schema", void 0);
+
+    _defineProperty(this, "__xstatenode", true);
+
+    _defineProperty(this, "idMap", new Map());
+
+    _defineProperty(this, "root", void 0);
+
+    _defineProperty(this, "key", void 0);
+
+    _defineProperty(this, "states", void 0);
+
+    _defineProperty(this, "events", void 0);
+
+    _defineProperty(this, "__TContext", void 0);
+
+    _defineProperty(this, "__TEvent", void 0);
+
+    _defineProperty(this, "__TAction", void 0);
+
+    _defineProperty(this, "__TActorMap", void 0);
+
+    _defineProperty(this, "__TResolvedTypesMeta", void 0);
+
+    this.key = config.key || config.id || '(machine)';
+    this.options = Object.assign(createDefaultOptions(), options);
+    this._contextFactory = isFunction(config.context) ? config.context : function (stuff) {
+      var partialContext = typeof (options === null || options === void 0 ? void 0 : options.context) === 'function' ? options.context(stuff) : options === null || options === void 0 ? void 0 : options.context;
+      return resolveContext(config.context, partialContext);
+    }; // TODO: fix types
+    // this.context = resolveContext(config.context, options?.context);
+
+    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.strict = !!this.config.strict;
+    this.transition = this.transition.bind(this);
+    this.root = new StateNode(config, {
+      _key: this.key,
+      _machine: this
+    });
+
+    this.root._initialize();
+
+    this.states = this.root.states; // TODO: remove!
+
+    this.events = this.root.events;
+  }
+  /**
+   * Clones this state machine with the provided implementations
+   * and merges the `context` (if provided).
+   *
+   * @param implementations Options (`actions`, `guards`, `actors`, `delays`, `context`)
+   *  to recursively merge with the existing options.
+   *
+   * @returns A new `StateMachine` instance with the provided implementations.
+   */
+
+
+  _createClass(StateMachine, [{
+    key: "context",
+    get: function get() {
+      return this.getContextAndActions()[0];
+    }
+  }, {
+    key: "getContextAndActions",
+    value: function getContextAndActions() {
+      var actions = []; // TODO: merge with this.options.context
+
+      var context = this._contextFactory({
+        spawn: createSpawner(this, null, null, actions) // TODO: fix types
+
+      });
+
+      return [context, actions];
+    }
+    /**
+     * The machine's own version.
+     */
+
+  }, {
+    key: "provide",
+    value: function provide(implementations) {
+      var _this$options = this.options,
+          actions = _this$options.actions,
+          guards = _this$options.guards,
+          actors = _this$options.actors,
+          delays = _this$options.delays;
+      return new StateMachine(this.config, {
+        actions: _objectSpread2(_objectSpread2({}, actions), implementations.actions),
+        guards: _objectSpread2(_objectSpread2({}, guards), implementations.guards),
+        actors: _objectSpread2(_objectSpread2({}, actors), implementations.actors),
+        delays: _objectSpread2(_objectSpread2({}, delays), implementations.delays),
+        context: implementations.context
+      });
+    }
+    /**
+     * Clones this state machine with custom `context`.
+     *
+     * The `context` provided can be partial `context`, which will be combined with the original `context`.
+     *
+     * @param context Custom context (will override predefined context, not recursive)
+     */
+
+  }, {
+    key: "withContext",
+    value: function withContext(context) {
+      return this.provide({
+        context: context
+      });
+    }
+    /**
+     * Resolves the given `state` to a new `State` instance relative to this machine.
+     *
+     * This ensures that `.nextEvents` represent the correct values.
+     *
+     * @param state The state to resolve
+     */
+
+  }, {
+    key: "resolveState",
+    value: function resolveState(state) {
+      var configuration = Array.from(getConfiguration(getStateNodes(this.root, state.value)));
+      return this.createState(_objectSpread2(_objectSpread2({}, state), {}, {
+        value: resolveStateValue(this.root, state.value),
+        configuration: configuration
+      }));
+    }
+    /**
+     * Determines the next state given the current `state` and received `event`.
+     * Calculates a full macrostep from all microsteps.
+     *
+     * @param state The current State instance or state value
+     * @param event The received event
+     */
+
+  }, {
+    key: "transition",
+    value: function transition() {
+      var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.initialState;
+      var event = arguments.length > 1 ? arguments[1] : undefined;
+      var currentState = toState(state, this);
+      return macrostep(currentState, event, this);
+    }
+    /**
+     * Determines the next state given the current `state` and `event`.
+     * Calculates a microstep.
+     *
+     * @param state The current state
+     * @param event The received event
+     */
+
+  }, {
+    key: "microstep",
+    value: function microstep() {
+      var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.initialState;
+      var event = arguments.length > 1 ? arguments[1] : undefined;
+      var resolvedState = toState(state, this);
+
+      var _event = toSCXMLEvent(event);
+
+      if (!IS_PRODUCTION && _event.name === WILDCARD) {
+        throw new Error("An event cannot have the wildcard type ('".concat(WILDCARD, "')"));
+      }
+
+      if (this.strict) {
+        if (!this.root.events.includes(_event.name) && !isBuiltInEvent(_event.name)) {
+          throw new Error("Machine '".concat(this.key, "' does not accept event '").concat(_event.name, "'"));
+        }
+      }
+
+      var transitions = this.getTransitionData(resolvedState, _event);
+      return resolveMicroTransition(this, transitions, resolvedState, _event);
+    }
+  }, {
+    key: "getTransitionData",
+    value: function getTransitionData(state, _event) {
+      return transitionNode(this.root, state.value, state, _event) || [];
+    }
+    /**
+     * The initial state _before_ evaluating any microsteps.
+     * This "pre-initial" state is provided to initial actions executed in the initial state.
+     */
+
+  }, {
+    key: "preInitialState",
+    get: function get() {
+      var _preInitial$actions;
+
+      var _this$getContextAndAc = this.getContextAndActions(),
+          _this$getContextAndAc2 = _slicedToArray(_this$getContextAndAc, 2),
+          context = _this$getContextAndAc2[0],
+          actions = _this$getContextAndAc2[1];
+
+      var preInitial = this.resolveState(State.from(getStateValue(this.root, getConfiguration([this.root])), context));
+      preInitial._initial = true;
+
+      (_preInitial$actions = preInitial.actions).unshift.apply(_preInitial$actions, _toConsumableArray(actions));
+
+      return preInitial;
+    }
+    /**
+     * The initial State instance, which includes all actions to be executed from
+     * entering the initial state.
+     */
+
+  }, {
+    key: "initialState",
+    get: function get() {
+      return this.getInitialState();
+    }
+    /**
+     * Returns the initial `State` instance, with reference to `self` as an `ActorRef`.
+     */
+
+  }, {
+    key: "getInitialState",
+    value: function getInitialState() {
+      var _nextState$actions;
+
+      var preInitialState = this.preInitialState;
+      var nextState = resolveMicroTransition(this, [], preInitialState, undefined);
+
+      (_nextState$actions = nextState.actions).unshift.apply(_nextState$actions, _toConsumableArray(preInitialState.actions));
+
+      var macroState = macrostep(nextState, null, this);
+      macroState.changed = undefined;
+      return macroState;
+    }
+  }, {
+    key: "getStateNodeById",
+    value: function getStateNodeById(stateId) {
+      var resolvedStateId = isStateId(stateId) ? stateId.slice(STATE_IDENTIFIER.length) : stateId;
+      var stateNode = this.idMap.get(resolvedStateId);
+
+      if (!stateNode) {
+        throw new Error("Child state node '#".concat(resolvedStateId, "' does not exist on machine '").concat(this.key, "'"));
+      }
+
+      return stateNode;
+    }
+  }, {
+    key: "definition",
+    get: function get() {
+      return this.root.definition;
+    }
+  }, {
+    key: "toJSON",
+    value: function toJSON() {
+      return this.definition;
+    }
+  }, {
+    key: "createState",
+    value: function createState(stateConfig) {
+      var state = stateConfig instanceof State ? stateConfig : new State(stateConfig);
+      state.machine = this;
+      return state;
+    }
+    /**@deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
+
+  }]);
+
+  return StateMachine;
+}();
+
+function createMachine(config, implementations) {
+  return new StateMachine(config, implementations);
+}
+
+export { StateNode as S, StateMachine as a, createMachine as c };