xstate 4.31.0 → 5.0.0-alpha.0

package/lib/Actor.d.ts

@@ -1,25 +0,0 @@
-import { EventObject, Subscribable, InvokeDefinition, AnyEventObject, StateMachine, Spawnable, SCXML, ActorRef, BaseActorRef } from './types';
-export interface Actor<TContext = any, TEvent extends EventObject = AnyEventObject> extends Subscribable<TContext> {
-    id: string;
-    send: (event: TEvent) => any;
-    stop?: () => any | undefined;
-    toJSON: () => {
-        id: string;
-    };
-    meta?: InvokeDefinition<TContext, TEvent>;
-    state?: any;
-    deferred?: boolean;
-}
-export declare function createNullActor(id: string): ActorRef<any>;
-/**
- * Creates a deferred actor that is able to be invoked given the provided
- * invocation information in its `.meta` value.
- *
- * @param invokeDefinition The meta information needed to invoke the actor.
- */
-export declare function createInvocableActor<TC, TE extends EventObject>(invokeDefinition: InvokeDefinition<TC, TE>, machine: StateMachine<TC, any, TE, any>, context: TC, _event: SCXML.Event<TE>): ActorRef<any>;
-export declare function createDeferredActor(entity: Spawnable, id: string, data?: any): ActorRef<any, undefined>;
-export declare function isActor(item: any): item is ActorRef<any>;
-export declare function isSpawnedActor(item: any): item is ActorRef<any>;
-export declare function toActorRef<TEvent extends EventObject, TEmitted = any, TActorRefLike extends BaseActorRef<TEvent> = BaseActorRef<TEvent>>(actorRefLike: TActorRefLike): ActorRef<TEvent, TEmitted> & Omit<TActorRefLike, keyof ActorRef<any, any>>;
-//# sourceMappingURL=Actor.d.ts.map

package/lib/Actor.js

@@ -1,108 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _tslib = require('./_virtual/_tslib.js');
-var utils = require('./utils.js');
-var serviceScope = require('./serviceScope.js');
-
-function createNullActor(id) {
-  var _a;
-
-  return _a = {
-    id: id,
-    send: function () {
-      return void 0;
-    },
-    subscribe: function () {
-      return {
-        unsubscribe: function () {
-          return void 0;
-        }
-      };
-    },
-    getSnapshot: function () {
-      return undefined;
-    },
-    toJSON: function () {
-      return {
-        id: id
-      };
-    }
-  }, _a[utils.symbolObservable] = function () {
-    return this;
-  }, _a;
-}
-/**
- * Creates a deferred actor that is able to be invoked given the provided
- * invocation information in its `.meta` value.
- *
- * @param invokeDefinition The meta information needed to invoke the actor.
- */
-
-function createInvocableActor(invokeDefinition, machine, context, _event) {
-  var _a;
-
-  var invokeSrc = utils.toInvokeSource(invokeDefinition.src);
-  var serviceCreator = (_a = machine === null || machine === void 0 ? void 0 : machine.options.services) === null || _a === void 0 ? void 0 : _a[invokeSrc.type];
-  var resolvedData = invokeDefinition.data ? utils.mapContext(invokeDefinition.data, context, _event) : undefined;
-  var tempActor = serviceCreator ? createDeferredActor(serviceCreator, invokeDefinition.id, resolvedData) : createNullActor(invokeDefinition.id); // @ts-ignore
-
-  tempActor.meta = invokeDefinition;
-  return tempActor;
-}
-function createDeferredActor(entity, id, data) {
-  var tempActor = createNullActor(id); // @ts-ignore
-
-  tempActor.deferred = true;
-
-  if (utils.isMachine(entity)) {
-    // "mute" the existing service scope so potential spawned actors within the `.initialState` stay deferred here
-    var initialState_1 = tempActor.state = serviceScope.provide(undefined, function () {
-      return (data ? entity.withContext(data) : entity).initialState;
-    });
-
-    tempActor.getSnapshot = function () {
-      return initialState_1;
-    };
-  }
-
-  return tempActor;
-}
-function isActor(item) {
-  try {
-    return typeof item.send === 'function';
-  } catch (e) {
-    return false;
-  }
-}
-function isSpawnedActor(item) {
-  return isActor(item) && 'id' in item;
-} // TODO: refactor the return type, this could be written in a better way but it's best to avoid unneccessary breaking changes now
-
-function toActorRef(actorRefLike) {
-  var _a;
-
-  return _tslib.__assign((_a = {
-    subscribe: function () {
-      return {
-        unsubscribe: function () {
-          return void 0;
-        }
-      };
-    },
-    id: 'anonymous',
-    getSnapshot: function () {
-      return undefined;
-    }
-  }, _a[utils.symbolObservable] = function () {
-    return this;
-  }, _a), actorRefLike);
-}
-
-exports.createDeferredActor = createDeferredActor;
-exports.createInvocableActor = createInvocableActor;
-exports.createNullActor = createNullActor;
-exports.isActor = isActor;
-exports.isSpawnedActor = isSpawnedActor;
-exports.toActorRef = toActorRef;

package/lib/Machine.d.ts

@@ -1,12 +0,0 @@
-import { AnyEventObject, BaseActionObject, DefaultContext, EventObject, MachineConfig, InternalMachineOptions, StateMachine, StateSchema, Typestate, ServiceMap } from './types';
-import { TypegenConstraint, TypegenDisabled, ResolveTypegenMeta } from './typegenTypes';
-/**
- * @deprecated Use `createMachine(...)` instead.
- */
-export declare function Machine<TContext = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, any, TEvent>, options?: InternalMachineOptions<TContext, TEvent, ResolveTypegenMeta<TypegenDisabled, TEvent, BaseActionObject, ServiceMap>>, initialContext?: TContext): StateMachine<TContext, any, TEvent, any, BaseActionObject, ServiceMap, ResolveTypegenMeta<TypegenDisabled, TEvent, BaseActionObject, ServiceMap>>;
-export declare function Machine<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, TStateSchema, TEvent>, options?: InternalMachineOptions<TContext, TEvent, ResolveTypegenMeta<TypegenDisabled, TEvent, BaseActionObject, ServiceMap>>, initialContext?: TContext): StateMachine<TContext, TStateSchema, TEvent, any, BaseActionObject, ServiceMap, ResolveTypegenMeta<TypegenDisabled, TEvent, BaseActionObject, ServiceMap>>;
-export declare function createMachine<TContext, TEvent extends EventObject = AnyEventObject, TTypestate extends Typestate<TContext> = {
-    value: any;
-    context: TContext;
-}, TServiceMap extends ServiceMap = ServiceMap, TTypesMeta extends TypegenConstraint = TypegenDisabled>(config: MachineConfig<TContext, any, TEvent, BaseActionObject, TServiceMap, TTypesMeta>, options?: InternalMachineOptions<TContext, TEvent, ResolveTypegenMeta<TTypesMeta, TEvent, BaseActionObject, TServiceMap>>): StateMachine<TContext, any, TEvent, TTypestate, BaseActionObject, TServiceMap, ResolveTypegenMeta<TTypesMeta, TEvent, BaseActionObject, TServiceMap>>;
-//# sourceMappingURL=Machine.d.ts.map

package/lib/Machine.js

@@ -1,19 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var StateNode = require('./StateNode.js');
-
-function Machine(config, options, initialContext) {
-  if (initialContext === void 0) {
-    initialContext = config.context;
-  }
-
-  return new StateNode.StateNode(config, options, initialContext);
-}
-function createMachine(config, options) {
-  return new StateNode.StateNode(config, options);
-}
-
-exports.Machine = Machine;
-exports.createMachine = createMachine;

package/lib/SimulatedClock.js

@@ -1,85 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _tslib = require('./_virtual/_tslib.js');
-
-var SimulatedClock =
-/*#__PURE__*/
-
-/** @class */
-function () {
-  function SimulatedClock() {
-    this.timeouts = new Map();
-    this._now = 0;
-    this._id = 0;
-  }
-
-  SimulatedClock.prototype.now = function () {
-    return this._now;
-  };
-
-  SimulatedClock.prototype.getId = function () {
-    return this._id++;
-  };
-
-  SimulatedClock.prototype.setTimeout = function (fn, timeout) {
-    var id = this.getId();
-    this.timeouts.set(id, {
-      start: this.now(),
-      timeout: timeout,
-      fn: fn
-    });
-    return id;
-  };
-
-  SimulatedClock.prototype.clearTimeout = function (id) {
-    this.timeouts.delete(id);
-  };
-
-  SimulatedClock.prototype.set = function (time) {
-    if (this._now > time) {
-      throw new Error('Unable to travel back in time');
-    }
-
-    this._now = time;
-    this.flushTimeouts();
-  };
-
-  SimulatedClock.prototype.flushTimeouts = function () {
-    var _this = this;
-
-    _tslib.__spreadArray([], _tslib.__read(this.timeouts), false).sort(function (_a, _b) {
-      var _c = _tslib.__read(_a, 2);
-          _c[0];
-          var timeoutA = _c[1];
-
-      var _d = _tslib.__read(_b, 2);
-          _d[0];
-          var timeoutB = _d[1];
-
-      var endA = timeoutA.start + timeoutA.timeout;
-      var endB = timeoutB.start + timeoutB.timeout;
-      return endB > endA ? -1 : 1;
-    }).forEach(function (_a) {
-      var _b = _tslib.__read(_a, 2),
-          id = _b[0],
-          timeout = _b[1];
-
-      if (_this.now() - timeout.start >= timeout.timeout) {
-        _this.timeouts.delete(id);
-
-        timeout.fn.call(null);
-      }
-    });
-  };
-
-  SimulatedClock.prototype.increment = function (ms) {
-    this._now += ms;
-    this.flushTimeouts();
-  };
-
-  return SimulatedClock;
-}();
-
-exports.SimulatedClock = SimulatedClock;

package/lib/State.d.ts

@@ -1,123 +0,0 @@
-import { StateValue, ActivityMap, EventObject, HistoryValue, ActionObject, EventType, StateConfig, SCXML, StateSchema, TransitionDefinition, Typestate, ActorRef, StateMachine, SimpleEventsOf } from './types';
-import { StateNode } from './StateNode';
-import { TypegenDisabled, TypegenEnabled } from './typegenTypes';
-import { BaseActionObject, Prop } from './types';
-export declare function stateValuesEqual(a: StateValue | undefined, b: StateValue | undefined): boolean;
-export declare function isStateConfig<TContext, TEvent extends EventObject>(state: any): state is StateConfig<TContext, TEvent>;
-/**
- * @deprecated Use `isStateConfig(object)` or `state instanceof State` instead.
- */
-export declare const isState: typeof isStateConfig;
-export declare function bindActionToState<TC, TE extends EventObject>(action: ActionObject<TC, TE>, state: State<TC, TE, any, any, any>): ActionObject<TC, TE>;
-export declare class State<TContext, TEvent extends EventObject = EventObject, TStateSchema extends StateSchema<TContext> = any, TTypestate extends Typestate<TContext> = {
-    value: any;
-    context: TContext;
-}, TResolvedTypesMeta = TypegenDisabled> {
-    value: StateValue;
-    context: TContext;
-    historyValue?: HistoryValue | undefined;
-    history?: State<TContext, TEvent, TStateSchema, TTypestate, TResolvedTypesMeta>;
-    actions: Array<ActionObject<TContext, TEvent>>;
-    activities: ActivityMap;
-    meta: any;
-    events: TEvent[];
-    event: TEvent;
-    _event: SCXML.Event<TEvent>;
-    _sessionid: string | null;
-    /**
-     * Indicates whether the state has changed from the previous state. A state is considered "changed" if:
-     *
-     * - Its value is not equal to its previous value, or:
-     * - It has any new actions (side-effects) to execute.
-     *
-     * An initial state (with no history) will return `undefined`.
-     */
-    changed: boolean | undefined;
-    /**
-     * Indicates whether the state is a final state.
-     */
-    done: boolean | undefined;
-    /**
-     * The enabled state nodes representative of the state value.
-     */
-    configuration: Array<StateNode<TContext, any, TEvent, any, any>>;
-    /**
-     * The next events that will cause a transition from the current state.
-     */
-    nextEvents: EventType[];
-    /**
-     * The transition definitions that resulted in this state.
-     */
-    transitions: Array<TransitionDefinition<TContext, TEvent>>;
-    /**
-     * An object mapping actor IDs to spawned actors/invoked services.
-     */
-    children: Record<string, ActorRef<any>>;
-    tags: Set<string>;
-    machine: StateMachine<TContext, any, TEvent, TTypestate, BaseActionObject, any, TResolvedTypesMeta> | undefined;
-    /**
-     * Creates a new State instance for the given `stateValue` and `context`.
-     * @param stateValue
-     * @param context
-     */
-    static from<TC, TE extends EventObject = EventObject>(stateValue: State<TC, TE, any, any, any> | StateValue, context?: TC | undefined): State<TC, TE, any, any, any>;
-    /**
-     * Creates a new State instance for the given `config`.
-     * @param config The state config
-     */
-    static create<TC, TE extends EventObject = EventObject>(config: StateConfig<TC, TE>): State<TC, TE, any, any, any>;
-    /**
-     * Creates a new `State` instance for the given `stateValue` and `context` with no actions (side-effects).
-     * @param stateValue
-     * @param context
-     */
-    static inert<TC, TE extends EventObject = EventObject>(stateValue: State<TC, TE, any, any, any> | StateValue, context: TC): State<TC, TE>;
-    /**
-     * 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
-     */
-    constructor(config: StateConfig<TContext, TEvent>);
-    /**
-     * 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.
-     */
-    toStrings(stateValue?: StateValue, delimiter?: string): string[];
-    toJSON(): Omit<this, "machine" | "tags" | "transitions" | "configuration"> & {
-        tags: string[];
-    };
-    /**
-     * Whether the current state value is a subset of the given parent state value.
-     * @param parentStateValue
-     */
-    matches<TSV extends TResolvedTypesMeta extends TypegenEnabled ? Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'matchesStates'> : never>(parentStateValue: TSV): boolean;
-    matches<TSV extends TResolvedTypesMeta extends TypegenDisabled ? TTypestate['value'] : never>(parentStateValue: TSV): this is State<(TTypestate extends any ? {
-        value: TSV;
-        context: any;
-    } extends TTypestate ? TTypestate : never : never)['context'], TEvent, TStateSchema, TTypestate, TResolvedTypesMeta> & {
-        value: TSV;
-    };
-    /**
-     * Whether the current state configuration has a state node with the specified `tag`.
-     * @param tag
-     */
-    hasTag(tag: TResolvedTypesMeta extends TypegenEnabled ? Prop<Prop<TResolvedTypesMeta, 'resolved'>, 'tags'> : string): boolean;
-    /**
-     * 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
-     */
-    can(event: TEvent | SimpleEventsOf<TEvent>['type']): boolean;
-}
-//# sourceMappingURL=State.d.ts.map

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;