xstate 5.18.0 → 5.18.2

package/dist/declarations/src/inspection.d.ts

@@ -1,4 +1,4 @@
-import { ActorRefLike, AnyActorRef, AnyEventObject, AnyTransitionDefinition, Snapshot } from "./types.js";
+import { ActorRefLike, AnyEventObject, AnyTransitionDefinition, Snapshot } from "./types.js";
 export type InspectionEvent = InspectedSnapshotEvent | InspectedEventEvent | InspectedActorEvent | InspectedMicrostepEvent | InspectedActionEvent;
 interface BaseInspectionEventProperties {
     rootId: string;
@@ -31,7 +31,7 @@ export interface InspectedActionEvent extends BaseInspectionEventProperties {
 }
 export interface InspectedEventEvent extends BaseInspectionEventProperties {
     type: '@xstate.event';
-    sourceRef: AnyActorRef | undefined;
+    sourceRef: ActorRefLike | undefined;
     event: AnyEventObject;
 }
 export interface InspectedActorEvent extends BaseInspectionEventProperties {

package/dist/{log-54d038f7.esm.js → log-15d0f775.esm.js}

@@ -1,4 +1,4 @@
-import { T as ProcessingStatus, z as resolveReferencedActor, A as createActor, U as cloneMachineSnapshot, V as XSTATE_ERROR, W as createErrorActorEvent, e as evaluateGuard, M as cancel, O as raise, P as spawnChild, R as stopChild } from './State-cdbc7940.esm.js';
+import { T as ProcessingStatus, z as resolveReferencedActor, A as createActor, U as cloneMachineSnapshot, V as XSTATE_ERROR, W as createErrorActorEvent, e as evaluateGuard, M as cancel, O as raise, P as spawnChild, R as stopChild } from './raise-0f7cf128.esm.js';
 
 function createSpawner(actorScope, {
   machine,
@@ -177,7 +177,7 @@ function executeEmit(actorScope, {
  * // }
  * ```
  */
-function emit( /** The event to emit, or an expression that returns an event to emit. */
+function emit(/** The event to emit, or an expression that returns an event to emit. */
 eventOrExpr) {
   function emit(args, params) {
   }
@@ -209,8 +209,11 @@ eventOrExpr) {
 
 // @TODO: Replace with native `NoInfer` when TS issue gets fixed:
 // https://github.com/microsoft/TypeScript/pull/57673
+
 /** @deprecated Use the built-in `NoInfer` type instead */
+
 /** The full definition of an event, with a string `type`. */
+
 /**
  * The string or object representing the state value relative to the parent
  * state node.
@@ -220,10 +223,14 @@ eventOrExpr) {
  * - For complex state nodes, this is an object, e.g., `{ success:
  *   "someChildState" }`.
  */
+
 // TODO: remove once TS fixes this type-widening issue
+
 /** @deprecated Use `AnyMachineSnapshot` instead */
+
 // TODO: possibly refactor this somehow, use even a simpler type, and maybe even make `machine.options` private or something
 /** @ignore */
+
 let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
   SpecialTargets["Parent"] = "#_parent";
   SpecialTargets["Internal"] = "#_internal";

package/dist/{log-4f8360d3.development.esm.js → log-38475d87.development.esm.js}

@@ -1,4 +1,4 @@
-import { T as ProcessingStatus, z as resolveReferencedActor, A as createActor, U as executingCustomAction, V as cloneMachineSnapshot, W as XSTATE_ERROR, Y as createErrorActorEvent, e as evaluateGuard, M as cancel, O as raise, P as spawnChild, R as stopChild } from './State-34039d2a.development.esm.js';
+import { T as ProcessingStatus, z as resolveReferencedActor, A as createActor, U as cloneMachineSnapshot, V as executingCustomAction, W as XSTATE_ERROR, Y as createErrorActorEvent, e as evaluateGuard, M as cancel, O as raise, P as spawnChild, R as stopChild } from './raise-5ea71f04.development.esm.js';
 
 function createSpawner(actorScope, {
   machine,
@@ -186,7 +186,7 @@ function executeEmit(actorScope, {
  * // }
  * ```
  */
-function emit( /** The event to emit, or an expression that returns an event to emit. */
+function emit(/** The event to emit, or an expression that returns an event to emit. */
 eventOrExpr) {
   if (executingCustomAction) {
     console.warn('Custom actions should not call `emit()` directly, as it is not imperative. See https://stately.ai/docs/actions#built-in-actions for more details.');
@@ -224,8 +224,11 @@ eventOrExpr) {
 
 // @TODO: Replace with native `NoInfer` when TS issue gets fixed:
 // https://github.com/microsoft/TypeScript/pull/57673
+
 /** @deprecated Use the built-in `NoInfer` type instead */
+
 /** The full definition of an event, with a string `type`. */
+
 /**
  * The string or object representing the state value relative to the parent
  * state node.
@@ -235,10 +238,14 @@ eventOrExpr) {
  * - For complex state nodes, this is an object, e.g., `{ success:
  *   "someChildState" }`.
  */
+
 // TODO: remove once TS fixes this type-widening issue
+
 /** @deprecated Use `AnyMachineSnapshot` instead */
+
 // TODO: possibly refactor this somehow, use even a simpler type, and maybe even make `machine.options` private or something
 /** @ignore */
+
 let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
   SpecialTargets["Parent"] = "#_parent";
   SpecialTargets["Internal"] = "#_internal";

package/dist/{log-f7dcaa97.cjs.js → log-98fcce74.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var guards_dist_xstateGuards = require('./State-30c95050.cjs.js');
+var guards_dist_xstateGuards = require('./raise-b1e0b9a9.cjs.js');
 
 function createSpawner(actorScope, {
   machine,
@@ -179,7 +179,7 @@ function executeEmit(actorScope, {
  * // }
  * ```
  */
-function emit( /** The event to emit, or an expression that returns an event to emit. */
+function emit(/** The event to emit, or an expression that returns an event to emit. */
 eventOrExpr) {
   function emit(args, params) {
   }
@@ -211,8 +211,11 @@ eventOrExpr) {
 
 // @TODO: Replace with native `NoInfer` when TS issue gets fixed:
 // https://github.com/microsoft/TypeScript/pull/57673
+
 /** @deprecated Use the built-in `NoInfer` type instead */
+
 /** The full definition of an event, with a string `type`. */
+
 /**
  * The string or object representing the state value relative to the parent
  * state node.
@@ -222,10 +225,14 @@ eventOrExpr) {
  * - For complex state nodes, this is an object, e.g., `{ success:
  *   "someChildState" }`.
  */
+
 // TODO: remove once TS fixes this type-widening issue
+
 /** @deprecated Use `AnyMachineSnapshot` instead */
+
 // TODO: possibly refactor this somehow, use even a simpler type, and maybe even make `machine.options` private or something
 /** @ignore */
+
 let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
   SpecialTargets["Parent"] = "#_parent";
   SpecialTargets["Internal"] = "#_internal";

package/dist/{log-40d606d3.development.cjs.js → log-b7ed1b61.development.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var guards_dist_xstateGuards = require('./State-a2464a1e.development.cjs.js');
+var guards_dist_xstateGuards = require('./raise-e919c5d4.development.cjs.js');
 
 function createSpawner(actorScope, {
   machine,
@@ -188,7 +188,7 @@ function executeEmit(actorScope, {
  * // }
  * ```
  */
-function emit( /** The event to emit, or an expression that returns an event to emit. */
+function emit(/** The event to emit, or an expression that returns an event to emit. */
 eventOrExpr) {
   if (guards_dist_xstateGuards.executingCustomAction) {
     console.warn('Custom actions should not call `emit()` directly, as it is not imperative. See https://stately.ai/docs/actions#built-in-actions for more details.');
@@ -226,8 +226,11 @@ eventOrExpr) {
 
 // @TODO: Replace with native `NoInfer` when TS issue gets fixed:
 // https://github.com/microsoft/TypeScript/pull/57673
+
 /** @deprecated Use the built-in `NoInfer` type instead */
+
 /** The full definition of an event, with a string `type`. */
+
 /**
  * The string or object representing the state value relative to the parent
  * state node.
@@ -237,10 +240,14 @@ eventOrExpr) {
  * - For complex state nodes, this is an object, e.g., `{ success:
  *   "someChildState" }`.
  */
+
 // TODO: remove once TS fixes this type-widening issue
+
 /** @deprecated Use `AnyMachineSnapshot` instead */
+
 // TODO: possibly refactor this somehow, use even a simpler type, and maybe even make `machine.options` private or something
 /** @ignore */
+
 let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
   SpecialTargets["Parent"] = "#_parent";
   SpecialTargets["Internal"] = "#_internal";

package/dist/{State-cdbc7940.esm.js → raise-0f7cf128.esm.js}

@@ -1120,6 +1120,136 @@ function cancel(sendId) {
   return cancel;
 }
 
+function resolveSpawn(actorScope, snapshot, actionArgs, _actionParams, {
+  id,
+  systemId,
+  src,
+  input,
+  syncSnapshot
+}) {
+  const logic = typeof src === 'string' ? resolveReferencedActor(snapshot.machine, src) : src;
+  const resolvedId = typeof id === 'function' ? id(actionArgs) : id;
+  let actorRef;
+  if (logic) {
+    actorRef = createActor(logic, {
+      id: resolvedId,
+      src,
+      parent: actorScope.self,
+      syncSnapshot,
+      systemId,
+      input: typeof input === 'function' ? input({
+        context: snapshot.context,
+        event: actionArgs.event,
+        self: actorScope.self
+      }) : input
+    });
+  }
+  return [cloneMachineSnapshot(snapshot, {
+    children: {
+      ...snapshot.children,
+      [resolvedId]: actorRef
+    }
+  }), {
+    id,
+    actorRef
+  }];
+}
+function executeSpawn(actorScope, {
+  id,
+  actorRef
+}) {
+  if (!actorRef) {
+    return;
+  }
+  actorScope.defer(() => {
+    if (actorRef._processingStatus === ProcessingStatus.Stopped) {
+      return;
+    }
+    actorRef.start();
+  });
+}
+function spawnChild(...[src, {
+  id,
+  systemId,
+  input,
+  syncSnapshot = false
+} = {}]) {
+  function spawnChild(args, params) {
+  }
+  spawnChild.type = 'snapshot.spawnChild';
+  spawnChild.id = id;
+  spawnChild.systemId = systemId;
+  spawnChild.src = src;
+  spawnChild.input = input;
+  spawnChild.syncSnapshot = syncSnapshot;
+  spawnChild.resolve = resolveSpawn;
+  spawnChild.execute = executeSpawn;
+  return spawnChild;
+}
+
+function resolveStop(_, snapshot, args, actionParams, {
+  actorRef
+}) {
+  const actorRefOrString = typeof actorRef === 'function' ? actorRef(args, actionParams) : actorRef;
+  const resolvedActorRef = typeof actorRefOrString === 'string' ? snapshot.children[actorRefOrString] : actorRefOrString;
+  let children = snapshot.children;
+  if (resolvedActorRef) {
+    children = {
+      ...children
+    };
+    delete children[resolvedActorRef.id];
+  }
+  return [cloneMachineSnapshot(snapshot, {
+    children
+  }), resolvedActorRef];
+}
+function executeStop(actorScope, actorRef) {
+  if (!actorRef) {
+    return;
+  }
+
+  // we need to eagerly unregister it here so a new actor with the same systemId can be registered immediately
+  // since we defer actual stopping of the actor but we don't defer actor creations (and we can't do that)
+  // this could throw on `systemId` collision, for example, when dealing with reentering transitions
+  actorScope.system._unregister(actorRef);
+
+  // this allows us to prevent an actor from being started if it gets stopped within the same macrostep
+  // this can happen, for example, when the invoking state is being exited immediately by an always transition
+  if (actorRef._processingStatus !== ProcessingStatus.Running) {
+    actorScope.stopChild(actorRef);
+    return;
+  }
+  // stopping a child enqueues a stop event in the child actor's mailbox
+  // we need for all of the already enqueued events to be processed before we stop the child
+  // the parent itself might want to send some events to a child (for example from exit actions on the invoking state)
+  // and we don't want to ignore those events
+  actorScope.defer(() => {
+    actorScope.stopChild(actorRef);
+  });
+}
+/**
+ * Stops a child actor.
+ *
+ * @param actorRef The actor to stop.
+ */
+function stopChild(actorRef) {
+  function stop(args, params) {
+  }
+  stop.type = 'xstate.stopChild';
+  stop.actorRef = actorRef;
+  stop.resolve = resolveStop;
+  stop.execute = executeStop;
+  return stop;
+}
+
+/**
+ * Stops a child actor.
+ *
+ * @deprecated Use `stopChild(...)` instead
+ * @alias
+ */
+const stop = stopChild;
+
 function checkStateIn(snapshot, _, {
   stateValue
 }) {
@@ -1308,196 +1438,6 @@ function evaluateGuard(guard, context, event, snapshot) {
   );
 }
 
-function resolveRaise(_, snapshot, args, actionParams, {
-  event: eventOrExpr,
-  id,
-  delay
-}, {
-  internalQueue
-}) {
-  const delaysMap = snapshot.machine.implementations.delays;
-  if (typeof eventOrExpr === 'string') {
-    throw new Error(`Only event objects may be used with raise; use raise({ type: "${eventOrExpr}" }) instead`);
-  }
-  const resolvedEvent = typeof eventOrExpr === 'function' ? eventOrExpr(args, actionParams) : eventOrExpr;
-  let resolvedDelay;
-  if (typeof delay === 'string') {
-    const configDelay = delaysMap && delaysMap[delay];
-    resolvedDelay = typeof configDelay === 'function' ? configDelay(args, actionParams) : configDelay;
-  } else {
-    resolvedDelay = typeof delay === 'function' ? delay(args, actionParams) : delay;
-  }
-  if (typeof resolvedDelay !== 'number') {
-    internalQueue.push(resolvedEvent);
-  }
-  return [snapshot, {
-    event: resolvedEvent,
-    id,
-    delay: resolvedDelay
-  }];
-}
-function executeRaise(actorScope, params) {
-  const {
-    event,
-    delay,
-    id
-  } = params;
-  if (typeof delay === 'number') {
-    actorScope.defer(() => {
-      const self = actorScope.self;
-      actorScope.system.scheduler.schedule(self, self, event, delay, id);
-    });
-    return;
-  }
-}
-/**
- * Raises an event. This places the event in the internal event queue, so that
- * the event is immediately consumed by the machine in the current step.
- *
- * @param eventType The event to raise.
- */
-function raise(eventOrExpr, options) {
-  function raise(args, params) {
-  }
-  raise.type = 'xstate.raise';
-  raise.event = eventOrExpr;
-  raise.id = options?.id;
-  raise.delay = options?.delay;
-  raise.resolve = resolveRaise;
-  raise.execute = executeRaise;
-  return raise;
-}
-
-function resolveSpawn(actorScope, snapshot, actionArgs, _actionParams, {
-  id,
-  systemId,
-  src,
-  input,
-  syncSnapshot
-}) {
-  const logic = typeof src === 'string' ? resolveReferencedActor(snapshot.machine, src) : src;
-  const resolvedId = typeof id === 'function' ? id(actionArgs) : id;
-  let actorRef;
-  if (logic) {
-    actorRef = createActor(logic, {
-      id: resolvedId,
-      src,
-      parent: actorScope.self,
-      syncSnapshot,
-      systemId,
-      input: typeof input === 'function' ? input({
-        context: snapshot.context,
-        event: actionArgs.event,
-        self: actorScope.self
-      }) : input
-    });
-  }
-  return [cloneMachineSnapshot(snapshot, {
-    children: {
-      ...snapshot.children,
-      [resolvedId]: actorRef
-    }
-  }), {
-    id,
-    actorRef
-  }];
-}
-function executeSpawn(actorScope, {
-  id,
-  actorRef
-}) {
-  if (!actorRef) {
-    return;
-  }
-  actorScope.defer(() => {
-    if (actorRef._processingStatus === ProcessingStatus.Stopped) {
-      return;
-    }
-    actorRef.start();
-  });
-}
-function spawnChild(...[src, {
-  id,
-  systemId,
-  input,
-  syncSnapshot = false
-} = {}]) {
-  function spawnChild(args, params) {
-  }
-  spawnChild.type = 'snapshot.spawnChild';
-  spawnChild.id = id;
-  spawnChild.systemId = systemId;
-  spawnChild.src = src;
-  spawnChild.input = input;
-  spawnChild.syncSnapshot = syncSnapshot;
-  spawnChild.resolve = resolveSpawn;
-  spawnChild.execute = executeSpawn;
-  return spawnChild;
-}
-
-function resolveStop(_, snapshot, args, actionParams, {
-  actorRef
-}) {
-  const actorRefOrString = typeof actorRef === 'function' ? actorRef(args, actionParams) : actorRef;
-  const resolvedActorRef = typeof actorRefOrString === 'string' ? snapshot.children[actorRefOrString] : actorRefOrString;
-  let children = snapshot.children;
-  if (resolvedActorRef) {
-    children = {
-      ...children
-    };
-    delete children[resolvedActorRef.id];
-  }
-  return [cloneMachineSnapshot(snapshot, {
-    children
-  }), resolvedActorRef];
-}
-function executeStop(actorScope, actorRef) {
-  if (!actorRef) {
-    return;
-  }
-
-  // we need to eagerly unregister it here so a new actor with the same systemId can be registered immediately
-  // since we defer actual stopping of the actor but we don't defer actor creations (and we can't do that)
-  // this could throw on `systemId` collision, for example, when dealing with reentering transitions
-  actorScope.system._unregister(actorRef);
-
-  // this allows us to prevent an actor from being started if it gets stopped within the same macrostep
-  // this can happen, for example, when the invoking state is being exited immediately by an always transition
-  if (actorRef._processingStatus !== ProcessingStatus.Running) {
-    actorScope.stopChild(actorRef);
-    return;
-  }
-  // stopping a child enqueues a stop event in the child actor's mailbox
-  // we need for all of the already enqueued events to be processed before we stop the child
-  // the parent itself might want to send some events to a child (for example from exit actions on the invoking state)
-  // and we don't want to ignore those events
-  actorScope.defer(() => {
-    actorScope.stopChild(actorRef);
-  });
-}
-/**
- * Stops a child actor.
- *
- * @param actorRef The actor to stop.
- */
-function stopChild(actorRef) {
-  function stop(args, params) {
-  }
-  stop.type = 'xstate.stopChild';
-  stop.actorRef = actorRef;
-  stop.resolve = resolveStop;
-  stop.execute = executeStop;
-  return stop;
-}
-
-/**
- * Stops a child actor.
- *
- * @deprecated Use `stopChild(...)` instead
- * @alias
- */
-const stop = stopChild;
-
 const isAtomicStateNode = stateNode => stateNode.type === 'atomic' || stateNode.type === 'final';
 function getChildren(stateNode) {
   return Object.values(stateNode.states).filter(sn => sn.type !== 'history');
@@ -1557,7 +1497,6 @@ function getValueFromAdj(baseNode, adjList) {
   if (!childStateNodes) {
     return {}; // todo: fix?
   }
-
   if (baseNode.type === 'compound') {
     const childStateNode = childStateNodes[0];
     if (childStateNode) {
@@ -2602,4 +2541,64 @@ function persistContext(contextPart) {
   return copy ?? contextPart;
 }
 
-export { $$ACTOR_TYPE as $, createActor as A, isMachineSnapshot as B, Actor as C, interpret as D, and as E, not as F, or as G, stateIn as H, getAllOwnEventDescriptors as I, matchesState as J, pathToStateValue as K, toObserver as L, cancel as M, NULL_EVENT as N, raise as O, spawnChild as P, stop as Q, stopChild as R, STATE_DELIMITER as S, ProcessingStatus as T, cloneMachineSnapshot as U, XSTATE_ERROR as V, createErrorActorEvent as W, XSTATE_STOP as X, toTransitionConfigArray as a, formatTransition as b, createInvokeId as c, formatInitialTransition as d, evaluateGuard as e, formatTransitions as f, getDelayedTransitions as g, getCandidates as h, getAllStateNodes as i, getStateNodes as j, createMachineSnapshot as k, isInFinalState as l, mapValues as m, macrostep as n, transitionNode as o, resolveActionsAndContext as p, createInitEvent as q, resolveStateValue as r, microstep as s, toArray as t, getInitialStateNodes as u, toStatePath as v, isStateId as w, getStateNodeByPath as x, getPersistedSnapshot as y, resolveReferencedActor as z };
+function resolveRaise(_, snapshot, args, actionParams, {
+  event: eventOrExpr,
+  id,
+  delay
+}, {
+  internalQueue
+}) {
+  const delaysMap = snapshot.machine.implementations.delays;
+  if (typeof eventOrExpr === 'string') {
+    throw new Error(`Only event objects may be used with raise; use raise({ type: "${eventOrExpr}" }) instead`);
+  }
+  const resolvedEvent = typeof eventOrExpr === 'function' ? eventOrExpr(args, actionParams) : eventOrExpr;
+  let resolvedDelay;
+  if (typeof delay === 'string') {
+    const configDelay = delaysMap && delaysMap[delay];
+    resolvedDelay = typeof configDelay === 'function' ? configDelay(args, actionParams) : configDelay;
+  } else {
+    resolvedDelay = typeof delay === 'function' ? delay(args, actionParams) : delay;
+  }
+  if (typeof resolvedDelay !== 'number') {
+    internalQueue.push(resolvedEvent);
+  }
+  return [snapshot, {
+    event: resolvedEvent,
+    id,
+    delay: resolvedDelay
+  }];
+}
+function executeRaise(actorScope, params) {
+  const {
+    event,
+    delay,
+    id
+  } = params;
+  if (typeof delay === 'number') {
+    actorScope.defer(() => {
+      const self = actorScope.self;
+      actorScope.system.scheduler.schedule(self, self, event, delay, id);
+    });
+    return;
+  }
+}
+/**
+ * Raises an event. This places the event in the internal event queue, so that
+ * the event is immediately consumed by the machine in the current step.
+ *
+ * @param eventType The event to raise.
+ */
+function raise(eventOrExpr, options) {
+  function raise(args, params) {
+  }
+  raise.type = 'xstate.raise';
+  raise.event = eventOrExpr;
+  raise.id = options?.id;
+  raise.delay = options?.delay;
+  raise.resolve = resolveRaise;
+  raise.execute = executeRaise;
+  return raise;
+}
+
+export { $$ACTOR_TYPE as $, createActor as A, Actor as B, interpret as C, and as D, not as E, or as F, stateIn as G, isMachineSnapshot as H, getAllOwnEventDescriptors as I, matchesState as J, pathToStateValue as K, toObserver as L, cancel as M, NULL_EVENT as N, raise as O, spawnChild as P, stop as Q, stopChild as R, STATE_DELIMITER as S, ProcessingStatus as T, cloneMachineSnapshot as U, XSTATE_ERROR as V, createErrorActorEvent as W, XSTATE_STOP as X, toTransitionConfigArray as a, formatTransition as b, createInvokeId as c, formatInitialTransition as d, evaluateGuard as e, formatTransitions as f, getDelayedTransitions as g, getCandidates as h, getAllStateNodes as i, getStateNodes as j, createMachineSnapshot as k, isInFinalState as l, mapValues as m, macrostep as n, transitionNode as o, resolveActionsAndContext as p, createInitEvent as q, resolveStateValue as r, microstep as s, toArray as t, getInitialStateNodes as u, toStatePath as v, isStateId as w, getStateNodeByPath as x, getPersistedSnapshot as y, resolveReferencedActor as z };