xstate 4.32.1 → 5.0.0-alpha.0

package/lib/State.js

@@ -1,282 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _tslib = require('./_virtual/_tslib.js');
-var constants = require('./constants.js');
-var utils = require('./utils.js');
-var stateUtils = require('./stateUtils.js');
-var actions = require('./actions.js');
-var environment = require('./environment.js');
-
-function stateValuesEqual(a, b) {
-  if (a === b) {
-    return true;
-  }
-
-  if (a === undefined || b === undefined) {
-    return false;
-  }
-
-  if (utils.isString(a) || utils.isString(b)) {
-    return a === b;
-  }
-
-  var aKeys = Object.keys(a);
-  var bKeys = Object.keys(b);
-  return aKeys.length === bKeys.length && aKeys.every(function (key) {
-    return stateValuesEqual(a[key], b[key]);
-  });
-}
-function isStateConfig(state) {
-  if (typeof state !== 'object' || state === null) {
-    return false;
-  }
-
-  return 'value' in state && '_event' in state;
-}
-/**
- * @deprecated Use `isStateConfig(object)` or `state instanceof State` instead.
- */
-
-var isState = isStateConfig;
-function bindActionToState(action, state) {
-  var exec = action.exec;
-
-  var boundAction = _tslib.__assign(_tslib.__assign({}, action), {
-    exec: exec !== undefined ? function () {
-      return exec(state.context, state.event, {
-        action: action,
-        state: state,
-        _event: state._event
-      });
-    } : undefined
-  });
-
-  return boundAction;
-}
-
-var State =
-/*#__PURE__*/
-
-/** @class */
-function () {
-  /**
-   * Creates a new State instance.
-   * @param value The state value
-   * @param context The extended state
-   * @param historyValue The tree representing historical values of the state nodes
-   * @param history The previous state
-   * @param actions An array of action objects to execute as side-effects
-   * @param activities A mapping of activities and whether they are started (`true`) or stopped (`false`).
-   * @param meta
-   * @param events Internal event queue. Should be empty with run-to-completion semantics.
-   * @param configuration
-   */
-  function State(config) {
-    var _this = this;
-
-    var _a;
-
-    this.actions = [];
-    this.activities = constants.EMPTY_ACTIVITY_MAP;
-    this.meta = {};
-    this.events = [];
-    this.value = config.value;
-    this.context = config.context;
-    this._event = config._event;
-    this._sessionid = config._sessionid;
-    this.event = this._event.data;
-    this.historyValue = config.historyValue;
-    this.history = config.history;
-    this.actions = config.actions || [];
-    this.activities = config.activities || constants.EMPTY_ACTIVITY_MAP;
-    this.meta = stateUtils.getMeta(config.configuration);
-    this.events = config.events || [];
-    this.matches = this.matches.bind(this);
-    this.toStrings = this.toStrings.bind(this);
-    this.configuration = config.configuration;
-    this.transitions = config.transitions;
-    this.children = config.children;
-    this.done = !!config.done;
-    this.tags = (_a = Array.isArray(config.tags) ? new Set(config.tags) : config.tags) !== null && _a !== void 0 ? _a : new Set();
-    this.machine = config.machine;
-    Object.defineProperty(this, 'nextEvents', {
-      get: function () {
-        return stateUtils.nextEvents(_this.configuration);
-      }
-    });
-  }
-  /**
-   * Creates a new State instance for the given `stateValue` and `context`.
-   * @param stateValue
-   * @param context
-   */
-
-
-  State.from = function (stateValue, context) {
-    if (stateValue instanceof State) {
-      if (stateValue.context !== context) {
-        return new State({
-          value: stateValue.value,
-          context: context,
-          _event: stateValue._event,
-          _sessionid: null,
-          historyValue: stateValue.historyValue,
-          history: stateValue.history,
-          actions: [],
-          activities: stateValue.activities,
-          meta: {},
-          events: [],
-          configuration: [],
-          transitions: [],
-          children: {}
-        });
-      }
-
-      return stateValue;
-    }
-
-    var _event = actions.initEvent;
-    return new State({
-      value: stateValue,
-      context: context,
-      _event: _event,
-      _sessionid: null,
-      historyValue: undefined,
-      history: undefined,
-      actions: [],
-      activities: undefined,
-      meta: undefined,
-      events: [],
-      configuration: [],
-      transitions: [],
-      children: {}
-    });
-  };
-  /**
-   * Creates a new State instance for the given `config`.
-   * @param config The state config
-   */
-
-
-  State.create = function (config) {
-    return new State(config);
-  };
-  /**
-   * Creates a new `State` instance for the given `stateValue` and `context` with no actions (side-effects).
-   * @param stateValue
-   * @param context
-   */
-
-
-  State.inert = function (stateValue, context) {
-    if (stateValue instanceof State) {
-      if (!stateValue.actions.length) {
-        return stateValue;
-      }
-
-      var _event = actions.initEvent;
-      return new State({
-        value: stateValue.value,
-        context: context,
-        _event: _event,
-        _sessionid: null,
-        historyValue: stateValue.historyValue,
-        history: stateValue.history,
-        activities: stateValue.activities,
-        configuration: stateValue.configuration,
-        transitions: [],
-        children: {}
-      });
-    }
-
-    return State.from(stateValue, context);
-  };
-  /**
-   * Returns an array of all the string leaf state node paths.
-   * @param stateValue
-   * @param delimiter The character(s) that separate each subpath in the string state node path.
-   */
-
-
-  State.prototype.toStrings = function (stateValue, delimiter) {
-    var _this = this;
-
-    if (stateValue === void 0) {
-      stateValue = this.value;
-    }
-
-    if (delimiter === void 0) {
-      delimiter = '.';
-    }
-
-    if (utils.isString(stateValue)) {
-      return [stateValue];
-    }
-
-    var valueKeys = Object.keys(stateValue);
-    return valueKeys.concat.apply(valueKeys, _tslib.__spreadArray([], _tslib.__read(valueKeys.map(function (key) {
-      return _this.toStrings(stateValue[key], delimiter).map(function (s) {
-        return key + delimiter + s;
-      });
-    })), false));
-  };
-
-  State.prototype.toJSON = function () {
-    var _a = this;
-        _a.configuration;
-        _a.transitions;
-        var tags = _a.tags;
-        _a.machine;
-        var jsonValues = _tslib.__rest(_a, ["configuration", "transitions", "tags", "machine"]);
-
-    return _tslib.__assign(_tslib.__assign({}, jsonValues), {
-      tags: Array.from(tags)
-    });
-  };
-
-  State.prototype.matches = function (parentStateValue) {
-    return utils.matchesState(parentStateValue, this.value);
-  };
-  /**
-   * Whether the current state configuration has a state node with the specified `tag`.
-   * @param tag
-   */
-
-
-  State.prototype.hasTag = function (tag) {
-    return this.tags.has(tag);
-  };
-  /**
-   * Determines whether sending the `event` will cause a non-forbidden transition
-   * to be selected, even if the transitions have no actions nor
-   * change the state value.
-   *
-   * @param event The event to test
-   * @returns Whether the event will cause a transition
-   */
-
-
-  State.prototype.can = function (event) {
-    var _a;
-
-    if (environment.IS_PRODUCTION) {
-      utils.warn(!!this.machine, "state.can(...) used outside of a machine-created State object; this will always return false.");
-    }
-
-    var transitionData = (_a = this.machine) === null || _a === void 0 ? void 0 : _a.getTransitionData(this, event);
-    return !!(transitionData === null || transitionData === void 0 ? void 0 : transitionData.transitions.length) && // Check that at least one transition is not forbidden
-    transitionData.transitions.some(function (t) {
-      return t.target !== undefined || t.actions.length;
-    });
-  };
-
-  return State;
-}();
-
-exports.State = State;
-exports.bindActionToState = bindActionToState;
-exports.isState = isState;
-exports.isStateConfig = isStateConfig;
-exports.stateValuesEqual = stateValuesEqual;

package/lib/StateNode.d.ts

@@ -1,287 +0,0 @@
-import { Event, StateValue, StateTransition, MachineOptions, EventObject, HistoryValue, StateNodeDefinition, TransitionDefinition, DelayedTransitionDefinition, ActivityDefinition, StateNodeConfig, StateSchema, StateNodesConfig, InvokeDefinition, ActionObject, Mapper, PropertyMapper, SCXML, Typestate, TransitionDefinitionMap, MachineSchema, InternalMachineOptions, ServiceMap, StateConfig } from './types';
-import { State } from './State';
-import { TypegenDisabled } from './typegenTypes';
-declare class StateNode<TContext = any, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject, TTypestate extends Typestate<TContext> = {
-    value: any;
-    context: TContext;
-}, TServiceMap extends ServiceMap = ServiceMap, TResolvedTypesMeta = TypegenDisabled> {
-    /**
-     * The raw config used to create the machine.
-     */
-    config: StateNodeConfig<TContext, TStateSchema, TEvent>;
-    /**
-     * The initial extended state
-     */
-    private _context;
-    /**
-     * The relative key of the state node, which represents its location in the overall state value.
-     */
-    key: string;
-    /**
-     * The unique ID of the state node.
-     */
-    id: string;
-    /**
-     * The machine's own version.
-     */
-    version?: string;
-    /**
-     * 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
-     */
-    type: 'atomic' | 'compound' | 'parallel' | 'final' | 'history';
-    /**
-     * The string path from the root machine node to this node.
-     */
-    path: string[];
-    /**
-     * The initial state node key.
-     */
-    initial?: keyof TStateSchema['states'];
-    /**
-     * (DEPRECATED) Whether the state node is a parallel state node.
-     *
-     * Use `type: 'parallel'` instead.
-     */
-    parallel?: boolean;
-    /**
-     * Whether the state node is "transient". A state node is considered transient if it has
-     * an immediate transition from a "null event" (empty string), taken upon entering the state node.
-     */
-    private _transient;
-    /**
-     * The child state nodes.
-     */
-    states: StateNodesConfig<TContext, TStateSchema, TEvent>;
-    /**
-     * 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
-     */
-    history: false | 'shallow' | 'deep';
-    /**
-     * The action(s) to be executed upon entering the state node.
-     */
-    onEntry: Array<ActionObject<TContext, TEvent>>;
-    /**
-     * The action(s) to be executed upon exiting the state node.
-     */
-    onExit: Array<ActionObject<TContext, TEvent>>;
-    /**
-     * The activities to be started upon entering the state node,
-     * and stopped upon exiting the state node.
-     */
-    activities: Array<ActivityDefinition<TContext, TEvent>>;
-    strict: boolean;
-    /**
-     * The parent state node.
-     */
-    parent?: StateNode<TContext, any, TEvent, any, any, any>;
-    /**
-     * The root machine node.
-     */
-    machine: StateNode<TContext, any, TEvent, TTypestate>;
-    /**
-     * The meta data associated with this state node, which will be returned in State instances.
-     */
-    meta?: TStateSchema extends {
-        meta: infer D;
-    } ? D : any;
-    /**
-     * The data sent with the "done.state._id_" event if this is a final state node.
-     */
-    doneData?: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>;
-    /**
-     * The string delimiter for serializing the path to a string. The default is "."
-     */
-    delimiter: string;
-    /**
-     * The order this state node appears. Corresponds to the implicit SCXML document order.
-     */
-    order: number;
-    /**
-     * The services invoked by this state node.
-     */
-    invoke: Array<InvokeDefinition<TContext, TEvent>>;
-    options: MachineOptions<TContext, TEvent>;
-    schema: MachineSchema<TContext, TEvent>;
-    __xstatenode: true;
-    description?: string;
-    private __cache;
-    private idMap;
-    tags: string[];
-    constructor(
-    /**
-     * The raw config used to create the machine.
-     */
-    config: StateNodeConfig<TContext, TStateSchema, TEvent>, options?: MachineOptions<TContext, TEvent>, 
-    /**
-     * The initial extended state
-     */
-    _context?: Readonly<TContext> | (() => Readonly<TContext>), // TODO: this is unsafe, but we're removing it in v5 anyway
-    _stateInfo?: {
-        parent: StateNode<any, any, any, any, any, any>;
-        key: string;
-    });
-    private _init;
-    /**
-     * Clones this state machine with custom options and context.
-     *
-     * @param options Options (actions, guards, activities, services) to recursively merge with the existing options.
-     * @param context Custom context (will override predefined context)
-     */
-    withConfig(options: InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, true>, context?: TContext | (() => TContext)): StateNode<TContext, TStateSchema, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta>;
-    /**
-     * Clones this state machine with custom context.
-     *
-     * @param context Custom context (will override predefined context, not recursive)
-     */
-    withContext(context: TContext | (() => TContext)): StateNode<TContext, TStateSchema, TEvent, TTypestate>;
-    get context(): TContext;
-    /**
-     * The well-structured state node definition.
-     */
-    get definition(): StateNodeDefinition<TContext, TStateSchema, TEvent>;
-    toJSON(): StateNodeDefinition<TContext, TStateSchema, TEvent>;
-    /**
-     * The mapping of events to transitions.
-     */
-    get on(): TransitionDefinitionMap<TContext, TEvent>;
-    get after(): Array<DelayedTransitionDefinition<TContext, TEvent>>;
-    /**
-     * All the transitions that can be taken from this state node.
-     */
-    get transitions(): Array<TransitionDefinition<TContext, TEvent>>;
-    private getCandidates;
-    /**
-     * All delayed transitions from the config.
-     */
-    private getDelayedTransitions;
-    /**
-     * Returns the state nodes represented by the current state value.
-     *
-     * @param state The state value or State instance
-     */
-    getStateNodes(state: StateValue | State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>): Array<StateNode<TContext, any, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta>>;
-    /**
-     * Returns `true` if this state node explicitly handles the given event.
-     *
-     * @param event The event in question
-     */
-    handles(event: Event<TEvent>): boolean;
-    /**
-     * Resolves the given `state` to a new `State` instance relative to this machine.
-     *
-     * This ensures that `.events` and `.nextEvents` represent the correct values.
-     *
-     * @param state The state to resolve
-     */
-    resolveState(state: State<TContext, TEvent, any, any> | StateConfig<TContext, TEvent>): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
-    private transitionLeafNode;
-    private transitionCompoundNode;
-    private transitionParallelNode;
-    private _transition;
-    getTransitionData(state: State<TContext, TEvent, any, any, any>, event: Event<TEvent> | SCXML.Event<TEvent>): StateTransition<TContext, TEvent> | undefined;
-    private next;
-    private nodesFromChild;
-    /**
-     * Whether the given state node "escapes" this state node. If the `stateNode` is equal to or the parent of
-     * this state node, it does not escape.
-     */
-    private escapes;
-    private getActions;
-    /**
-     * Determines the next state given the current `state` and sent `event`.
-     *
-     * @param state The current State instance or state value
-     * @param event The event that was sent at the current state
-     * @param context The current context (extended state) of the current state
-     */
-    transition(state: StateValue | State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta> | undefined, event: Event<TEvent> | SCXML.Event<TEvent>, context?: TContext): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
-    private resolveRaisedTransition;
-    private resolveTransition;
-    /**
-     * Returns the child state node from its relative `stateKey`, or throws.
-     */
-    getStateNode(stateKey: string): StateNode<TContext, any, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta>;
-    /**
-     * Returns the state node with the given `stateId`, or throws.
-     *
-     * @param stateId The state ID. The prefix "#" is removed.
-     */
-    getStateNodeById(stateId: string): StateNode<TContext, any, TEvent, any, TServiceMap, TResolvedTypesMeta>;
-    /**
-     * Returns the relative state node from the given `statePath`, or throws.
-     *
-     * @param statePath The string or string array relative path to the state node.
-     */
-    getStateNodeByPath(statePath: string | string[]): StateNode<TContext, any, TEvent, any, any, any>;
-    /**
-     * Resolves a partial state value with its full representation in this machine.
-     *
-     * @param stateValue The partial state value to resolve.
-     */
-    resolve(stateValue: StateValue): StateValue;
-    private getResolvedPath;
-    private get initialStateValue();
-    getInitialState(stateValue: StateValue, context?: TContext): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
-    /**
-     * The initial State instance, which includes all actions to be executed from
-     * entering the initial state.
-     */
-    get initialState(): State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
-    /**
-     * 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.
-     */
-    get target(): StateValue | undefined;
-    /**
-     * Returns the leaf nodes from a state path relative to this state node.
-     *
-     * @param relativeStateId The relative state path to retrieve the state nodes
-     * @param history The previous state to retrieve history
-     * @param resolve Whether state nodes should resolve to initial child state nodes
-     */
-    getRelativeStateNodes(relativeStateId: StateNode<TContext, any, TEvent>, historyValue?: HistoryValue, resolve?: boolean): Array<StateNode<TContext, any, TEvent>>;
-    get initialStateNodes(): Array<StateNode<TContext, any, TEvent, any, any, any>>;
-    /**
-     * Retrieves state nodes from a relative path to this state node.
-     *
-     * @param relativePath The relative path from this state node
-     * @param historyValue
-     */
-    getFromRelativePath(relativePath: string[]): Array<StateNode<TContext, any, TEvent, any, any, any>>;
-    private historyValue;
-    /**
-     * Resolves to the historical value(s) of the parent state node,
-     * represented by state nodes.
-     *
-     * @param historyValue
-     */
-    private resolveHistory;
-    /**
-     * All the state node IDs of this state node and its descendant state nodes.
-     */
-    get stateIds(): string[];
-    /**
-     * All the event types accepted by this state node and its descendants.
-     */
-    get events(): Array<TEvent['type']>;
-    /**
-     * All the events that have transitions directly from this state node.
-     *
-     * Excludes any inert events.
-     */
-    get ownEvents(): Array<TEvent['type']>;
-    private resolveTarget;
-    private formatTransition;
-    private formatTransitions;
-}
-export { StateNode };
-//# sourceMappingURL=StateNode.d.ts.map