xstate 6.0.0-alpha.1 → 6.0.0-alpha.11

package/README.md

@@ -119,7 +119,7 @@ npm install xstate
 ```
 
 ```ts
-import { createMachine, createActor, assign } from 'xstate';
+import { createMachine, createActor } from 'xstate';
 
 // State machine
 const toggleMachine = createMachine({
@@ -135,7 +135,9 @@ const toggleMachine = createMachine({
       }
     },
     active: {
-      entry: assign({ count: ({ context }) => context.count + 1 }),
+      entry: ({ context }) => ({
+        context: { count: context.count + 1 }
+      }),
       on: {
         TOGGLE: { target: 'inactive' }
       }
@@ -365,10 +367,10 @@ const wordMachine = createMachine({
       initial: 'off',
       states: {
         on: {
-          on: { TOGGLE_BOLD: 'off' }
+          on: { TOGGLE_BOLD: { target: 'off' } }
         },
         off: {
-          on: { TOGGLE_BOLD: 'on' }
+          on: { TOGGLE_BOLD: { target: 'on' } }
         }
       }
     },
@@ -376,10 +378,10 @@ const wordMachine = createMachine({
       initial: 'off',
       states: {
         on: {
-          on: { TOGGLE_UNDERLINE: 'off' }
+          on: { TOGGLE_UNDERLINE: { target: 'off' } }
         },
         off: {
-          on: { TOGGLE_UNDERLINE: 'on' }
+          on: { TOGGLE_UNDERLINE: { target: 'on' } }
         }
       }
     },
@@ -387,10 +389,10 @@ const wordMachine = createMachine({
       initial: 'off',
       states: {
         on: {
-          on: { TOGGLE_ITALICS: 'off' }
+          on: { TOGGLE_ITALICS: { target: 'off' } }
         },
         off: {
-          on: { TOGGLE_ITALICS: 'on' }
+          on: { TOGGLE_ITALICS: { target: 'on' } }
         }
       }
     },
@@ -399,20 +401,20 @@ const wordMachine = createMachine({
       states: {
         none: {
           on: {
-            BULLETS: 'bullets',
-            NUMBERS: 'numbers'
+            BULLETS: { target: 'bullets' },
+            NUMBERS: { target: 'numbers' }
           }
         },
         bullets: {
           on: {
-            NONE: 'none',
-            NUMBERS: 'numbers'
+            NONE: { target: 'none' },
+            NUMBERS: { target: 'numbers' }
           }
         },
         numbers: {
           on: {
-            BULLETS: 'bullets',
-            NONE: 'none'
+            BULLETS: { target: 'bullets' },
+            NONE: { target: 'none' }
           }
         }
       }
@@ -493,10 +495,10 @@ const paymentMachine = createMachine({
         },
         hist: { type: 'history' }
       },
-      on: { NEXT: 'review' }
+      on: { NEXT: { target: 'review' } }
     },
     review: {
-      on: { PREVIOUS: 'method.hist' }
+      on: { PREVIOUS: { target: 'method.hist' } }
     }
   }
 });

package/dist/{StateMachine-6ec50e21.development.esm.js → StateMachine-0aa98f54.development.esm.js}

@@ -1,4 +1,4 @@
-import { P as ProcessingStatus, G as resolveReferencedActor, c as createActor, S as STATE_DELIMITER, H as mapValues, t as toArray, I as createInvokeId, J as getDelayedTransitions, K as evaluateCandidate, L as formatTransition, N as NULL_EVENT, M as toTransitionConfigArray, O as createInvokeTimeoutEvent, Q as getCandidates, R as formatRouteTransitions, U as resolveStateValue, V as getAllStateNodes, n as getStateNodes, W as createMachineSnapshot, X as isInFinalState, a as macrostep, Y as transitionNode, m as matchesEventDescriptor, Z as resolveAndExecuteActionsWithContext, b as createInitEvent, d as initialMicrostep, _ as toStatePath, $ as isStateId, a0 as getStateNodeByPath, a1 as getPersistedSnapshot, a2 as $$ACTOR_TYPE } from './index-39259ea4.development.esm.js';
+import { P as ProcessingStatus, C as resolveReferencedActor, c as createActor, S as STATE_DELIMITER, D as mapValues, t as toArray, E as createInvokeId, F as getDelayedTransitions, G as evaluateCandidate, H as formatTransition, N as NULL_EVENT, I as toTransitionConfigArray, J as createInvokeTimeoutEvent, K as getCandidates, L as formatRouteTransitions, M as resolveStateValue, O as getAllStateNodes, f as getStateNodes, Q as createMachineSnapshot, R as isInFinalState, a as macrostep, U as transitionNode, m as matchesEventDescriptor, V as resolveActionsWithContext, b as createInitEvent, d as initialMicrostep, W as toStatePath, X as isStateId, Y as getStateNodeByPath, Z as getPersistedSnapshot, $ as $$ACTOR_TYPE } from './index-2f2fbd9b.development.esm.js';
 
 function createSpawner(actorScope, {
   machine,
@@ -20,7 +20,7 @@ function createSpawner(actorScope, {
           self: actorScope.self
         }) : options?.input,
         src,
-        systemId: options?.systemId
+        registryKey: options?.registryKey
       });
       spawnedChildren[actor.id] = actor;
       return actor;
@@ -31,7 +31,7 @@ function createSpawner(actorScope, {
         syncSnapshot: options?.syncSnapshot,
         input: options?.input,
         src,
-        systemId: options?.systemId
+        registryKey: options?.registryKey
       });
       return actor;
     }
@@ -171,7 +171,7 @@ class StateNode {
     this.invoke = toArray(this.config.invoke).map((invokeConfig, i) => {
       const {
         src,
-        systemId
+        registryKey
       } = invokeConfig;
       const invokeId = createInvokeId(this.id, i);
       const resolvedId = invokeConfig.id ?? invokeId;
@@ -184,7 +184,7 @@ class StateNode {
         src: sourceName,
         logic: src,
         id: resolvedId,
-        systemId
+        registryKey
       };
     });
   }
@@ -422,7 +422,7 @@ class StateMachine {
     this._json = void 0;
     this.id = config.id || '(machine)';
     this.implementations = {
-      actors: config.actors ?? {},
+      actorSources: config.actorSources ?? {},
       actions: config.actions ?? {},
       delays: config.delays ?? {},
       guards: config.guards ?? {},
@@ -431,7 +431,7 @@ class StateMachine {
     {
       // The `@xstate.` prefix is reserved for built-in serialized action and
       // guard descriptors — user implementation names must not collide.
-      for (const kind of ['actions', 'guards', 'actors', 'delays']) {
+      for (const kind of ['actions', 'guards', 'actorSources', 'delays']) {
         for (const key of Object.keys(this.implementations[kind])) {
           if (key.startsWith('@xstate.')) {
             throw new Error(`Invalid ${kind} name '${key}': the '@xstate.' prefix is reserved for built-in descriptors.`);
@@ -447,6 +447,7 @@ class StateMachine {
       ...this.config.options
     };
     this.transition = this.transition.bind(this);
+    this.initialTransition = this.initialTransition.bind(this);
     this.getInitialSnapshot = this.getInitialSnapshot.bind(this);
     this.getPersistedSnapshot = this.getPersistedSnapshot.bind(this);
     this.restoreSnapshot = this.restoreSnapshot.bind(this);
@@ -468,15 +469,15 @@ class StateMachine {
   /**
    * Clones this state machine with the provided implementations.
    *
-   * @param implementations Options (`actions`, `guards`, `actors`, `delays`) to
-   *   recursively merge with the existing options.
+   * @param implementations Options (`actions`, `guards`, `actorSources`,
+   *   `delays`) to recursively merge with the existing options.
    * @returns A new `StateMachine` instance with the provided implementations.
    */
   provide(implementations) {
     const {
       actions,
       guards,
-      actors,
+      actorSources,
       delays
     } = this.implementations;
     const provided = new StateMachine(this.config, {
@@ -488,9 +489,9 @@ class StateMachine {
         ...guards,
         ...implementations.guards
       },
-      actors: {
-        ...actors,
-        ...implementations.actors
+      actorSources: {
+        ...actorSources,
+        ...implementations.actorSources
       },
       delays: {
         ...delays,
@@ -525,7 +526,11 @@ class StateMachine {
    * @param event The received event
    */
   transition(snapshot, event, actorScope) {
-    return macrostep(snapshot, event, actorScope, []).snapshot;
+    const {
+      snapshot: nextSnapshot,
+      microsteps
+    } = macrostep(snapshot, event, actorScope, []);
+    return [nextSnapshot, microsteps.flatMap(([, actions]) => actions)];
   }
 
   /**
@@ -580,9 +585,9 @@ class StateMachine {
         spawn,
         input: initEvent.input,
         self: actorScope.self,
-        actors: this.implementations.actors
+        actorSources: this.implementations.actorSources
       });
-      const nextState = resolveAndExecuteActionsWithContext(preInitial, initEvent, actorScope, []);
+      const [nextState] = resolveActionsWithContext(preInitial, initEvent, actorScope, []);
       if (resolvedContext) {
         nextState.context = resolvedContext;
       }
@@ -602,14 +607,18 @@ class StateMachine {
    * `ActorRef`.
    */
   getInitialSnapshot(actorScope, input) {
+    return this.initialTransition(input, actorScope)[0];
+  }
+  initialTransition(input, actorScope) {
     const initEvent = createInitEvent(input); // TODO: fix;
     const internalQueue = [];
     const preInitialState = this._getPreInitialState(actorScope, initEvent);
-    const [nextState] = initialMicrostep(this.root, preInitialState, actorScope, initEvent, internalQueue);
+    const [nextState, initialActions] = initialMicrostep(this.root, preInitialState, actorScope, initEvent, internalQueue);
     const {
-      snapshot: macroState
+      snapshot: macroState,
+      microsteps
     } = macrostep(nextState, initEvent, actorScope, internalQueue);
-    return macroState;
+    return [macroState, [...initialActions, ...microsteps.flatMap(([, actions]) => actions)]];
   }
   start(snapshot) {
     // Start rehydrated children that were active when persisted. Freshly
@@ -663,7 +672,7 @@ class StateMachine {
         syncSnapshot: actorData.syncSnapshot,
         snapshot: childState,
         src,
-        systemId: actorData.systemId
+        registryKey: actorData.registryKey
       });
       // Mark so `start()` knows to start this child (freshly invoked/spawned
       // children are started via deferred `@xstate.start` actions instead).

package/dist/{StateMachine-48dcad8f.cjs.js → StateMachine-aef700df.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var dist_xstateActors = require('./index-f0d7107d.cjs.js');
+var dist_xstateActors = require('./index-559ceab3.cjs.js');
 
 function createSpawner(actorScope, {
   machine,
@@ -22,7 +22,7 @@ function createSpawner(actorScope, {
           self: actorScope.self
         }) : options?.input,
         src,
-        systemId: options?.systemId
+        registryKey: options?.registryKey
       });
       spawnedChildren[actor.id] = actor;
       return actor;
@@ -33,7 +33,7 @@ function createSpawner(actorScope, {
         syncSnapshot: options?.syncSnapshot,
         input: options?.input,
         src,
-        systemId: options?.systemId
+        registryKey: options?.registryKey
       });
       return actor;
     }
@@ -173,7 +173,7 @@ class StateNode {
     this.invoke = dist_xstateActors.toArray(this.config.invoke).map((invokeConfig, i) => {
       const {
         src,
-        systemId
+        registryKey
       } = invokeConfig;
       const invokeId = dist_xstateActors.createInvokeId(this.id, i);
       const resolvedId = invokeConfig.id ?? invokeId;
@@ -186,7 +186,7 @@ class StateNode {
         src: sourceName,
         logic: src,
         id: resolvedId,
-        systemId
+        registryKey
       };
     });
   }
@@ -424,7 +424,7 @@ class StateMachine {
     this._json = void 0;
     this.id = config.id || '(machine)';
     this.implementations = {
-      actors: config.actors ?? {},
+      actorSources: config.actorSources ?? {},
       actions: config.actions ?? {},
       delays: config.delays ?? {},
       guards: config.guards ?? {},
@@ -438,6 +438,7 @@ class StateMachine {
       ...this.config.options
     };
     this.transition = this.transition.bind(this);
+    this.initialTransition = this.initialTransition.bind(this);
     this.getInitialSnapshot = this.getInitialSnapshot.bind(this);
     this.getPersistedSnapshot = this.getPersistedSnapshot.bind(this);
     this.restoreSnapshot = this.restoreSnapshot.bind(this);
@@ -456,15 +457,15 @@ class StateMachine {
   /**
    * Clones this state machine with the provided implementations.
    *
-   * @param implementations Options (`actions`, `guards`, `actors`, `delays`) to
-   *   recursively merge with the existing options.
+   * @param implementations Options (`actions`, `guards`, `actorSources`,
+   *   `delays`) to recursively merge with the existing options.
    * @returns A new `StateMachine` instance with the provided implementations.
    */
   provide(implementations) {
     const {
       actions,
       guards,
-      actors,
+      actorSources,
       delays
     } = this.implementations;
     const provided = new StateMachine(this.config, {
@@ -476,9 +477,9 @@ class StateMachine {
         ...guards,
         ...implementations.guards
       },
-      actors: {
-        ...actors,
-        ...implementations.actors
+      actorSources: {
+        ...actorSources,
+        ...implementations.actorSources
       },
       delays: {
         ...delays,
@@ -513,7 +514,11 @@ class StateMachine {
    * @param event The received event
    */
   transition(snapshot, event, actorScope) {
-    return dist_xstateActors.macrostep(snapshot, event, actorScope, []).snapshot;
+    const {
+      snapshot: nextSnapshot,
+      microsteps
+    } = dist_xstateActors.macrostep(snapshot, event, actorScope, []);
+    return [nextSnapshot, microsteps.flatMap(([, actions]) => actions)];
   }
 
   /**
@@ -568,9 +573,9 @@ class StateMachine {
         spawn,
         input: initEvent.input,
         self: actorScope.self,
-        actors: this.implementations.actors
+        actorSources: this.implementations.actorSources
       });
-      const nextState = dist_xstateActors.resolveAndExecuteActionsWithContext(preInitial, initEvent, actorScope, []);
+      const [nextState] = dist_xstateActors.resolveActionsWithContext(preInitial, initEvent, actorScope, []);
       if (resolvedContext) {
         nextState.context = resolvedContext;
       }
@@ -590,14 +595,18 @@ class StateMachine {
    * `ActorRef`.
    */
   getInitialSnapshot(actorScope, input) {
+    return this.initialTransition(input, actorScope)[0];
+  }
+  initialTransition(input, actorScope) {
     const initEvent = dist_xstateActors.createInitEvent(input); // TODO: fix;
     const internalQueue = [];
     const preInitialState = this._getPreInitialState(actorScope, initEvent);
-    const [nextState] = dist_xstateActors.initialMicrostep(this.root, preInitialState, actorScope, initEvent, internalQueue);
+    const [nextState, initialActions] = dist_xstateActors.initialMicrostep(this.root, preInitialState, actorScope, initEvent, internalQueue);
     const {
-      snapshot: macroState
+      snapshot: macroState,
+      microsteps
     } = dist_xstateActors.macrostep(nextState, initEvent, actorScope, internalQueue);
-    return macroState;
+    return [macroState, [...initialActions, ...microsteps.flatMap(([, actions]) => actions)]];
   }
   start(snapshot) {
     // Start rehydrated children that were active when persisted. Freshly
@@ -651,7 +660,7 @@ class StateMachine {
         syncSnapshot: actorData.syncSnapshot,
         snapshot: childState,
         src,
-        systemId: actorData.systemId
+        registryKey: actorData.registryKey
       });
       // Mark so `start()` knows to start this child (freshly invoked/spawned
       // children are started via deferred `@xstate.start` actions instead).

package/dist/{StateMachine-47e60715.esm.js → StateMachine-d4931336.esm.js}

@@ -1,4 +1,4 @@
-import { P as ProcessingStatus, G as resolveReferencedActor, c as createActor, S as STATE_DELIMITER, H as mapValues, t as toArray, I as createInvokeId, J as getDelayedTransitions, K as evaluateCandidate, L as formatTransition, N as NULL_EVENT, M as toTransitionConfigArray, O as createInvokeTimeoutEvent, Q as getCandidates, R as formatRouteTransitions, U as resolveStateValue, V as getAllStateNodes, n as getStateNodes, W as createMachineSnapshot, X as isInFinalState, a as macrostep, Y as transitionNode, m as matchesEventDescriptor, Z as resolveAndExecuteActionsWithContext, b as createInitEvent, d as initialMicrostep, _ as toStatePath, $ as isStateId, a0 as getStateNodeByPath, a1 as getPersistedSnapshot, a2 as $$ACTOR_TYPE } from './index-688701ed.esm.js';
+import { P as ProcessingStatus, C as resolveReferencedActor, c as createActor, S as STATE_DELIMITER, D as mapValues, t as toArray, E as createInvokeId, F as getDelayedTransitions, G as evaluateCandidate, H as formatTransition, N as NULL_EVENT, I as toTransitionConfigArray, J as createInvokeTimeoutEvent, K as getCandidates, L as formatRouteTransitions, M as resolveStateValue, O as getAllStateNodes, f as getStateNodes, Q as createMachineSnapshot, R as isInFinalState, a as macrostep, U as transitionNode, m as matchesEventDescriptor, V as resolveActionsWithContext, b as createInitEvent, d as initialMicrostep, W as toStatePath, X as isStateId, Y as getStateNodeByPath, Z as getPersistedSnapshot, $ as $$ACTOR_TYPE } from './index-8828376f.esm.js';
 
 function createSpawner(actorScope, {
   machine,
@@ -20,7 +20,7 @@ function createSpawner(actorScope, {
           self: actorScope.self
         }) : options?.input,
         src,
-        systemId: options?.systemId
+        registryKey: options?.registryKey
       });
       spawnedChildren[actor.id] = actor;
       return actor;
@@ -31,7 +31,7 @@ function createSpawner(actorScope, {
         syncSnapshot: options?.syncSnapshot,
         input: options?.input,
         src,
-        systemId: options?.systemId
+        registryKey: options?.registryKey
       });
       return actor;
     }
@@ -171,7 +171,7 @@ class StateNode {
     this.invoke = toArray(this.config.invoke).map((invokeConfig, i) => {
       const {
         src,
-        systemId
+        registryKey
       } = invokeConfig;
       const invokeId = createInvokeId(this.id, i);
       const resolvedId = invokeConfig.id ?? invokeId;
@@ -184,7 +184,7 @@ class StateNode {
         src: sourceName,
         logic: src,
         id: resolvedId,
-        systemId
+        registryKey
       };
     });
   }
@@ -422,7 +422,7 @@ class StateMachine {
     this._json = void 0;
     this.id = config.id || '(machine)';
     this.implementations = {
-      actors: config.actors ?? {},
+      actorSources: config.actorSources ?? {},
       actions: config.actions ?? {},
       delays: config.delays ?? {},
       guards: config.guards ?? {},
@@ -436,6 +436,7 @@ class StateMachine {
       ...this.config.options
     };
     this.transition = this.transition.bind(this);
+    this.initialTransition = this.initialTransition.bind(this);
     this.getInitialSnapshot = this.getInitialSnapshot.bind(this);
     this.getPersistedSnapshot = this.getPersistedSnapshot.bind(this);
     this.restoreSnapshot = this.restoreSnapshot.bind(this);
@@ -454,15 +455,15 @@ class StateMachine {
   /**
    * Clones this state machine with the provided implementations.
    *
-   * @param implementations Options (`actions`, `guards`, `actors`, `delays`) to
-   *   recursively merge with the existing options.
+   * @param implementations Options (`actions`, `guards`, `actorSources`,
+   *   `delays`) to recursively merge with the existing options.
    * @returns A new `StateMachine` instance with the provided implementations.
    */
   provide(implementations) {
     const {
       actions,
       guards,
-      actors,
+      actorSources,
       delays
     } = this.implementations;
     const provided = new StateMachine(this.config, {
@@ -474,9 +475,9 @@ class StateMachine {
         ...guards,
         ...implementations.guards
       },
-      actors: {
-        ...actors,
-        ...implementations.actors
+      actorSources: {
+        ...actorSources,
+        ...implementations.actorSources
       },
       delays: {
         ...delays,
@@ -511,7 +512,11 @@ class StateMachine {
    * @param event The received event
    */
   transition(snapshot, event, actorScope) {
-    return macrostep(snapshot, event, actorScope, []).snapshot;
+    const {
+      snapshot: nextSnapshot,
+      microsteps
+    } = macrostep(snapshot, event, actorScope, []);
+    return [nextSnapshot, microsteps.flatMap(([, actions]) => actions)];
   }
 
   /**
@@ -566,9 +571,9 @@ class StateMachine {
         spawn,
         input: initEvent.input,
         self: actorScope.self,
-        actors: this.implementations.actors
+        actorSources: this.implementations.actorSources
       });
-      const nextState = resolveAndExecuteActionsWithContext(preInitial, initEvent, actorScope, []);
+      const [nextState] = resolveActionsWithContext(preInitial, initEvent, actorScope, []);
       if (resolvedContext) {
         nextState.context = resolvedContext;
       }
@@ -588,14 +593,18 @@ class StateMachine {
    * `ActorRef`.
    */
   getInitialSnapshot(actorScope, input) {
+    return this.initialTransition(input, actorScope)[0];
+  }
+  initialTransition(input, actorScope) {
     const initEvent = createInitEvent(input); // TODO: fix;
     const internalQueue = [];
     const preInitialState = this._getPreInitialState(actorScope, initEvent);
-    const [nextState] = initialMicrostep(this.root, preInitialState, actorScope, initEvent, internalQueue);
+    const [nextState, initialActions] = initialMicrostep(this.root, preInitialState, actorScope, initEvent, internalQueue);
     const {
-      snapshot: macroState
+      snapshot: macroState,
+      microsteps
     } = macrostep(nextState, initEvent, actorScope, internalQueue);
-    return macroState;
+    return [macroState, [...initialActions, ...microsteps.flatMap(([, actions]) => actions)]];
   }
   start(snapshot) {
     // Start rehydrated children that were active when persisted. Freshly
@@ -649,7 +658,7 @@ class StateMachine {
         syncSnapshot: actorData.syncSnapshot,
         snapshot: childState,
         src,
-        systemId: actorData.systemId
+        registryKey: actorData.registryKey
       });
       // Mark so `start()` knows to start this child (freshly invoked/spawned
       // children are started via deferred `@xstate.start` actions instead).