xstate 5.0.0-beta.44 → 5.0.0-beta.46

package/dist/xstate.development.cjs.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var actors_dist_xstateActors = require('../actors/dist/xstate-actors.development.cjs.js');
-var guards_dist_xstateGuards = require('./raise-ed700d14.development.cjs.js');
-var send = require('./send-00466e37.development.cjs.js');
+var guards_dist_xstateGuards = require('./raise-a9e7e31c.development.cjs.js');
+var send = require('./send-5b256a89.development.cjs.js');
 require('../dev/dist/xstate-dev.development.cjs.js');
 
 class SimulatedClock {
@@ -56,6 +56,20 @@ class SimulatedClock {
   }
 }
 
+const cache = new WeakMap();
+function memo(object, key, fn) {
+  let memoizedData = cache.get(object);
+  if (!memoizedData) {
+    memoizedData = {
+      [key]: fn()
+    };
+    cache.set(object, memoizedData);
+  } else if (!(key in memoizedData)) {
+    memoizedData[key] = fn();
+  }
+  return memoizedData[key];
+}
+
 const EMPTY_OBJECT = {};
 const toSerializableAction = action => {
   if (typeof action === 'string') {
@@ -76,85 +90,72 @@ const toSerializableAction = action => {
   return action;
 };
 class StateNode {
-  /**
-   * 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 output data sent with the "xstate.done.state._id_" event if this is a final state node.
-   */
-
-  /**
-   * The order this state node appears. Corresponds to the implicit document order.
-   */
-
   constructor(
   /**
    * The raw config used to create the machine.
    */
   config, options) {
     this.config = config;
+    /**
+     * The relative key of the state node, which represents its location in the overall state value.
+     */
     this.key = void 0;
+    /**
+     * The unique ID of the state node.
+     */
     this.id = void 0;
+    /**
+     * 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
+     */
     this.type = void 0;
+    /**
+     * The string path from the root machine node to this node.
+     */
     this.path = void 0;
+    /**
+     * The child state nodes.
+     */
     this.states = void 0;
+    /**
+     * 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
+     */
     this.history = void 0;
+    /**
+     * The action(s) to be executed upon entering the state node.
+     */
     this.entry = void 0;
+    /**
+     * The action(s) to be executed upon exiting the state node.
+     */
     this.exit = void 0;
+    /**
+     * The parent state node.
+     */
     this.parent = void 0;
+    /**
+     * The root machine node.
+     */
     this.machine = void 0;
+    /**
+     * The meta data associated with this state node, which will be returned in State instances.
+     */
     this.meta = void 0;
+    /**
+     * The output data sent with the "xstate.done.state._id_" event if this is a final state node.
+     */
     this.output = void 0;
+    /**
+     * The order this state node appears. Corresponds to the implicit document order.
+     */
     this.order = -1;
     this.description = void 0;
     this.tags = [];
@@ -248,7 +249,7 @@ class StateNode {
    * The logic invoked as actors by this state node.
    */
   get invoke() {
-    return guards_dist_xstateGuards.memo(this, 'invoke', () => guards_dist_xstateGuards.toArray(this.config.invoke).map((invokeConfig, i) => {
+    return memo(this, 'invoke', () => guards_dist_xstateGuards.toArray(this.config.invoke).map((invokeConfig, i) => {
       const {
         src,
         systemId
@@ -281,7 +282,7 @@ class StateNode {
    * The mapping of events to transitions.
    */
   get on() {
-    return guards_dist_xstateGuards.memo(this, 'on', () => {
+    return memo(this, 'on', () => {
       const transitions = this.transitions;
       return [...transitions].flatMap(([descriptor, t]) => t.map(t => [descriptor, t])).reduce((map, [descriptor, transition]) => {
         map[descriptor] = map[descriptor] || [];
@@ -291,16 +292,16 @@ class StateNode {
     });
   }
   get after() {
-    return guards_dist_xstateGuards.memo(this, 'delayedTransitions', () => guards_dist_xstateGuards.getDelayedTransitions(this));
+    return memo(this, 'delayedTransitions', () => guards_dist_xstateGuards.getDelayedTransitions(this));
   }
   get initial() {
-    return guards_dist_xstateGuards.memo(this, 'initial', () => guards_dist_xstateGuards.formatInitialTransition(this, this.config.initial));
+    return memo(this, 'initial', () => guards_dist_xstateGuards.formatInitialTransition(this, this.config.initial));
   }
   next(state, event) {
     const eventType = event.type;
     const actions = [];
     let selectedTransition;
-    const candidates = guards_dist_xstateGuards.memo(this, `candidates-${eventType}`, () => guards_dist_xstateGuards.getCandidates(this, eventType));
+    const candidates = memo(this, `candidates-${eventType}`, () => guards_dist_xstateGuards.getCandidates(this, eventType));
     for (const candidate of candidates) {
       const {
         guard
@@ -326,7 +327,7 @@ class StateNode {
    * All the event types accepted by this state node and its descendants.
    */
   get events() {
-    return guards_dist_xstateGuards.memo(this, 'events', () => {
+    return memo(this, 'events', () => {
       const {
         states
       } = this;
@@ -360,16 +361,15 @@ class StateNode {
 
 const STATE_IDENTIFIER = '#';
 class StateMachine {
-  /**
-   * The machine's own version.
-   */
-
   constructor(
   /**
    * The raw config used to create the machine.
    */
   config, implementations) {
     this.config = config;
+    /**
+     * The machine's own version.
+     */
     this.version = void 0;
     this.implementations = void 0;
     this.types = void 0;
@@ -379,15 +379,7 @@ class StateMachine {
     this.id = void 0;
     this.states = void 0;
     this.events = void 0;
-    this.__TContext = void 0;
-    this.__TEvent = void 0;
-    this.__TActor = void 0;
-    this.__TAction = void 0;
-    this.__TGuard = void 0;
-    this.__TDelay = void 0;
-    this.__TTag = void 0;
-    this.__TInput = void 0;
-    this.__TOutput = void 0;
+    /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
     this.__TResolvedTypesMeta = void 0;
     this.id = config.id || '(machine)';
     this.implementations = {
@@ -451,12 +443,12 @@ class StateMachine {
   }
   resolveState(config) {
     const resolvedStateValue = guards_dist_xstateGuards.resolveStateValue(this.root, config.value);
-    const configurationSet = guards_dist_xstateGuards.getConfiguration(guards_dist_xstateGuards.getStateNodes(this.root, resolvedStateValue));
+    const nodeSet = guards_dist_xstateGuards.getAllStateNodes(guards_dist_xstateGuards.getStateNodes(this.root, resolvedStateValue));
     return guards_dist_xstateGuards.createMachineSnapshot({
-      configuration: [...configurationSet],
+      _nodes: [...nodeSet],
       context: config.context || {},
       children: {},
-      status: guards_dist_xstateGuards.isInFinalState(configurationSet, this.root) ? 'done' : config.status || 'active',
+      status: guards_dist_xstateGuards.isInFinalState(nodeSet, this.root) ? 'done' : config.status || 'active',
       output: config.output,
       error: config.error,
       historyValue: config.historyValue
@@ -472,7 +464,7 @@ class StateMachine {
    */
   transition(state, event, actorScope) {
     // TODO: handle error events in a better way
-    if (guards_dist_xstateGuards.isErrorActorEvent(event) && !state.nextEvents.some(nextEvent => nextEvent === event.type)) {
+    if (guards_dist_xstateGuards.isErrorActorEvent(event) && !guards_dist_xstateGuards.getAllOwnEventDescriptors(state).some(nextEvent => nextEvent === event.type)) {
       return guards_dist_xstateGuards.cloneMachineSnapshot(state, {
         status: 'error',
         error: event.data
@@ -508,7 +500,7 @@ class StateMachine {
     } = this.config;
     const preInitial = guards_dist_xstateGuards.createMachineSnapshot({
       context: typeof context !== 'function' && context ? context : {},
-      configuration: [this.root],
+      _nodes: [this.root],
       children: {},
       status: 'active'
     }, this);
@@ -582,11 +574,11 @@ class StateMachine {
       if (!logic) {
         return;
       }
-      const actorState = logic.restoreState?.(childState, _actorScope);
       const actorRef = guards_dist_xstateGuards.createActor(logic, {
         id: actorId,
         parent: _actorScope?.self,
-        state: actorState,
+        syncSnapshot: actorData.syncSnapshot,
+        state: childState,
         src,
         systemId: actorData.systemId
       });
@@ -595,7 +587,7 @@ class StateMachine {
     const restoredSnapshot = guards_dist_xstateGuards.createMachineSnapshot({
       ...snapshot,
       children,
-      configuration: Array.from(guards_dist_xstateGuards.getConfiguration(guards_dist_xstateGuards.getStateNodes(this.root, snapshot.value)))
+      _nodes: Array.from(guards_dist_xstateGuards.getAllStateNodes(guards_dist_xstateGuards.getStateNodes(this.root, snapshot.value)))
     }, this);
     let seen = new Set();
     function reviveContext(contextPart, children) {
@@ -617,8 +609,6 @@ class StateMachine {
     reviveContext(restoredSnapshot.context, children);
     return restoredSnapshot;
   }
-
-  /**@deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
 }
 
 const defaultWaitForOptions = {
@@ -699,6 +689,24 @@ function createMachine(config, implementations) {
   return new StateMachine(config, implementations);
 }
 
+// at the moment we allow extra actors - ones that are not specified by `children`
+// this could be reconsidered in the future
+function setup({
+  actors,
+  actions,
+  guards,
+  delays
+}) {
+  return {
+    createMachine: config => createMachine(config, {
+      actors,
+      actions,
+      guards,
+      delays
+    })
+  };
+}
+
 exports.createEmptyActor = actors_dist_xstateActors.createEmptyActor;
 exports.fromCallback = actors_dist_xstateActors.fromCallback;
 exports.fromEventObservable = actors_dist_xstateActors.fromEventObservable;
@@ -706,6 +714,7 @@ exports.fromObservable = actors_dist_xstateActors.fromObservable;
 exports.fromPromise = actors_dist_xstateActors.fromPromise;
 exports.fromTransition = actors_dist_xstateActors.fromTransition;
 exports.Actor = guards_dist_xstateGuards.Actor;
+exports.__unsafe_getAllOwnEventDescriptors = guards_dist_xstateGuards.getAllOwnEventDescriptors;
 exports.and = guards_dist_xstateGuards.and;
 exports.cancel = guards_dist_xstateGuards.cancel;
 exports.createActor = guards_dist_xstateGuards.createActor;
@@ -734,4 +743,5 @@ exports.SimulatedClock = SimulatedClock;
 exports.StateMachine = StateMachine;
 exports.StateNode = StateNode;
 exports.createMachine = createMachine;
+exports.setup = setup;
 exports.waitFor = waitFor;

package/dist/xstate.development.cjs.mjs

@@ -4,6 +4,7 @@ export {
   SpecialTargets,
   StateMachine,
   StateNode,
+  __unsafe_getAllOwnEventDescriptors,
   and,
   assign,
   cancel,
@@ -30,6 +31,7 @@ export {
   raise,
   sendParent,
   sendTo,
+  setup,
   spawn,
   stateIn,
   stop,

package/dist/xstate.development.esm.js

@@ -1,8 +1,8 @@
 export { createEmptyActor, fromCallback, fromEventObservable, fromObservable, fromPromise, fromTransition } from '../actors/dist/xstate-actors.development.esm.js';
-import { S as STATE_DELIMITER, m as mapValues, t as toArray, f as formatTransitions, a as toTransitionConfigArray, b as formatTransition, N as NULL_EVENT, c as memo, e as evaluateGuard, d as createInvokeId, g as getDelayedTransitions, h as formatInitialTransition, i as getCandidates, r as resolveStateValue, j as getConfiguration, k as getStateNodes, l as createMachineSnapshot, n as isInFinalState, o as isErrorActorEvent, p as cloneMachineSnapshot, q as macrostep, s as transitionNode, u as resolveActionsAndContext, v as createInitEvent, w as microstep, x as getInitialStateNodes, y as isStateId, z as getStateNodeByPath, A as getPersistedState, B as resolveReferencedActor, C as createActor, $ as $$ACTOR_TYPE } from './raise-348cc74e.development.esm.js';
-export { D as Actor, J as and, O as cancel, C as createActor, k as getStateNodes, E as interpret, F as isMachineSnapshot, G as matchesState, K as not, L as or, H as pathToStateValue, P as raise, R as spawn, M as stateIn, Q as stop, I as toObserver } from './raise-348cc74e.development.esm.js';
-import { a as assign } from './send-a0193bdb.development.esm.js';
-export { S as SpecialTargets, a as assign, c as choose, e as escalate, f as forwardTo, l as log, p as pure, s as sendParent, b as sendTo } from './send-a0193bdb.development.esm.js';
+import { S as STATE_DELIMITER, m as mapValues, t as toArray, f as formatTransitions, a as toTransitionConfigArray, b as formatTransition, N as NULL_EVENT, e as evaluateGuard, c as createInvokeId, g as getDelayedTransitions, d as formatInitialTransition, h as getCandidates, r as resolveStateValue, i as getAllStateNodes, j as getStateNodes, k as createMachineSnapshot, l as isInFinalState, n as isErrorActorEvent, o as getAllOwnEventDescriptors, p as cloneMachineSnapshot, q as macrostep, s as transitionNode, u as resolveActionsAndContext, v as createInitEvent, w as microstep, x as getInitialStateNodes, y as isStateId, z as getStateNodeByPath, A as getPersistedState, B as resolveReferencedActor, C as createActor, $ as $$ACTOR_TYPE } from './raise-fa23c2b9.development.esm.js';
+export { D as Actor, o as __unsafe_getAllOwnEventDescriptors, J as and, O as cancel, C as createActor, j as getStateNodes, E as interpret, F as isMachineSnapshot, G as matchesState, K as not, L as or, H as pathToStateValue, P as raise, R as spawn, M as stateIn, Q as stop, I as toObserver } from './raise-fa23c2b9.development.esm.js';
+import { a as assign } from './send-9acdf858.development.esm.js';
+export { S as SpecialTargets, a as assign, c as choose, e as escalate, f as forwardTo, l as log, p as pure, s as sendParent, b as sendTo } from './send-9acdf858.development.esm.js';
 import '../dev/dist/xstate-dev.development.esm.js';
 
 class SimulatedClock {
@@ -54,6 +54,20 @@ class SimulatedClock {
   }
 }
 
+const cache = new WeakMap();
+function memo(object, key, fn) {
+  let memoizedData = cache.get(object);
+  if (!memoizedData) {
+    memoizedData = {
+      [key]: fn()
+    };
+    cache.set(object, memoizedData);
+  } else if (!(key in memoizedData)) {
+    memoizedData[key] = fn();
+  }
+  return memoizedData[key];
+}
+
 const EMPTY_OBJECT = {};
 const toSerializableAction = action => {
   if (typeof action === 'string') {
@@ -74,85 +88,72 @@ const toSerializableAction = action => {
   return action;
 };
 class StateNode {
-  /**
-   * 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 output data sent with the "xstate.done.state._id_" event if this is a final state node.
-   */
-
-  /**
-   * The order this state node appears. Corresponds to the implicit document order.
-   */
-
   constructor(
   /**
    * The raw config used to create the machine.
    */
   config, options) {
     this.config = config;
+    /**
+     * The relative key of the state node, which represents its location in the overall state value.
+     */
     this.key = void 0;
+    /**
+     * The unique ID of the state node.
+     */
     this.id = void 0;
+    /**
+     * 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
+     */
     this.type = void 0;
+    /**
+     * The string path from the root machine node to this node.
+     */
     this.path = void 0;
+    /**
+     * The child state nodes.
+     */
     this.states = void 0;
+    /**
+     * 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
+     */
     this.history = void 0;
+    /**
+     * The action(s) to be executed upon entering the state node.
+     */
     this.entry = void 0;
+    /**
+     * The action(s) to be executed upon exiting the state node.
+     */
     this.exit = void 0;
+    /**
+     * The parent state node.
+     */
     this.parent = void 0;
+    /**
+     * The root machine node.
+     */
     this.machine = void 0;
+    /**
+     * The meta data associated with this state node, which will be returned in State instances.
+     */
     this.meta = void 0;
+    /**
+     * The output data sent with the "xstate.done.state._id_" event if this is a final state node.
+     */
     this.output = void 0;
+    /**
+     * The order this state node appears. Corresponds to the implicit document order.
+     */
     this.order = -1;
     this.description = void 0;
     this.tags = [];
@@ -358,16 +359,15 @@ class StateNode {
 
 const STATE_IDENTIFIER = '#';
 class StateMachine {
-  /**
-   * The machine's own version.
-   */
-
   constructor(
   /**
    * The raw config used to create the machine.
    */
   config, implementations) {
     this.config = config;
+    /**
+     * The machine's own version.
+     */
     this.version = void 0;
     this.implementations = void 0;
     this.types = void 0;
@@ -377,15 +377,7 @@ class StateMachine {
     this.id = void 0;
     this.states = void 0;
     this.events = void 0;
-    this.__TContext = void 0;
-    this.__TEvent = void 0;
-    this.__TActor = void 0;
-    this.__TAction = void 0;
-    this.__TGuard = void 0;
-    this.__TDelay = void 0;
-    this.__TTag = void 0;
-    this.__TInput = void 0;
-    this.__TOutput = void 0;
+    /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
     this.__TResolvedTypesMeta = void 0;
     this.id = config.id || '(machine)';
     this.implementations = {
@@ -449,12 +441,12 @@ class StateMachine {
   }
   resolveState(config) {
     const resolvedStateValue = resolveStateValue(this.root, config.value);
-    const configurationSet = getConfiguration(getStateNodes(this.root, resolvedStateValue));
+    const nodeSet = getAllStateNodes(getStateNodes(this.root, resolvedStateValue));
     return createMachineSnapshot({
-      configuration: [...configurationSet],
+      _nodes: [...nodeSet],
       context: config.context || {},
       children: {},
-      status: isInFinalState(configurationSet, this.root) ? 'done' : config.status || 'active',
+      status: isInFinalState(nodeSet, this.root) ? 'done' : config.status || 'active',
       output: config.output,
       error: config.error,
       historyValue: config.historyValue
@@ -470,7 +462,7 @@ class StateMachine {
    */
   transition(state, event, actorScope) {
     // TODO: handle error events in a better way
-    if (isErrorActorEvent(event) && !state.nextEvents.some(nextEvent => nextEvent === event.type)) {
+    if (isErrorActorEvent(event) && !getAllOwnEventDescriptors(state).some(nextEvent => nextEvent === event.type)) {
       return cloneMachineSnapshot(state, {
         status: 'error',
         error: event.data
@@ -506,7 +498,7 @@ class StateMachine {
     } = this.config;
     const preInitial = createMachineSnapshot({
       context: typeof context !== 'function' && context ? context : {},
-      configuration: [this.root],
+      _nodes: [this.root],
       children: {},
       status: 'active'
     }, this);
@@ -580,11 +572,11 @@ class StateMachine {
       if (!logic) {
         return;
       }
-      const actorState = logic.restoreState?.(childState, _actorScope);
       const actorRef = createActor(logic, {
         id: actorId,
         parent: _actorScope?.self,
-        state: actorState,
+        syncSnapshot: actorData.syncSnapshot,
+        state: childState,
         src,
         systemId: actorData.systemId
       });
@@ -593,7 +585,7 @@ class StateMachine {
     const restoredSnapshot = createMachineSnapshot({
       ...snapshot,
       children,
-      configuration: Array.from(getConfiguration(getStateNodes(this.root, snapshot.value)))
+      _nodes: Array.from(getAllStateNodes(getStateNodes(this.root, snapshot.value)))
     }, this);
     let seen = new Set();
     function reviveContext(contextPart, children) {
@@ -615,8 +607,6 @@ class StateMachine {
     reviveContext(restoredSnapshot.context, children);
     return restoredSnapshot;
   }
-
-  /**@deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
 }
 
 const defaultWaitForOptions = {
@@ -697,4 +687,22 @@ function createMachine(config, implementations) {
   return new StateMachine(config, implementations);
 }
 
-export { SimulatedClock, StateMachine, StateNode, createMachine, waitFor };
+// at the moment we allow extra actors - ones that are not specified by `children`
+// this could be reconsidered in the future
+function setup({
+  actors,
+  actions,
+  guards,
+  delays
+}) {
+  return {
+    createMachine: config => createMachine(config, {
+      actors,
+      actions,
+      guards,
+      delays
+    })
+  };
+}
+
+export { SimulatedClock, StateMachine, StateNode, createMachine, setup, waitFor };