xstate 5.0.0-beta.52 → 5.0.0-beta.54

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

@@ -484,7 +484,7 @@ export interface DoneActorEvent<TOutput = unknown> {
 }
 export interface ErrorActorEvent<TErrorData = unknown> extends EventObject {
     type: `xstate.error.actor.${string}`;
-    data: TErrorData;
+    error: TErrorData;
 }
 export interface SnapshotEvent<TSnapshot extends Snapshot<unknown> = Snapshot<unknown>> extends EventObject {
     type: `xstate.snapshot.${string}`;
@@ -614,10 +614,14 @@ export interface ActorOptions<TLogic extends AnyActorLogic> {
      * Actions from machine actors will not be re-executed, because they are assumed to have been already executed.
      * However, invocations will be restarted, and spawned actors will be restored recursively.
      *
-     * Can be generated with {@link Actor.getPersistedState}.
+     * Can be generated with {@link Actor.getPersistedSnapshot}.
      *
      * @see https://stately.ai/docs/persistence
      */
+    snapshot?: Snapshot<unknown>;
+    /**
+     * @deprecated Use `snapshot` instead.
+     */
     state?: Snapshot<unknown>;
     /**
      * The source definition.
@@ -738,7 +742,7 @@ export interface ActorRef<TSnapshot extends Snapshot<unknown>, TEvent extends Ev
     send: (event: TEvent) => void;
     start: () => void;
     getSnapshot: () => TSnapshot;
-    getPersistedState: () => Snapshot<unknown>;
+    getPersistedSnapshot: () => Snapshot<unknown>;
     stop: () => void;
     toJSON?: () => any;
     _parent?: ActorRef<any, any>;
@@ -806,7 +810,7 @@ export interface ActorLogic<TSnapshot extends Snapshot<unknown>, TEvent extends
     /**
      * Transition function that processes the current state and an incoming message
      * to produce a new state.
-     * @param state - The current state.
+     * @param snapshot - The current state.
      * @param message - The incoming message.
      * @param ctx - The actor scope.
      * @returns The new state.
@@ -821,25 +825,25 @@ export interface ActorLogic<TSnapshot extends Snapshot<unknown>, TEvent extends
     getInitialState: (actorScope: ActorScope<TSnapshot, TEvent, TSystem>, input: TInput) => TSnapshot;
     /**
      * Called when Actor is created to restore the internal state of the actor given a persisted state.
-     * The persisted state can be created by `getPersistedState`.
+     * The persisted state can be created by `getPersistedSnapshot`.
      * @param persistedState - The persisted state to restore from.
      * @param actorScope - The actor scope.
      * @returns The restored state.
      */
-    restoreState?: (persistedState: Snapshot<unknown>, actorScope: ActorScope<TSnapshot, TEvent>) => TSnapshot;
+    restoreSnapshot?: (persistedState: Snapshot<unknown>, actorScope: ActorScope<TSnapshot, TEvent>) => TSnapshot;
     /**
      * Called when the actor is started.
-     * @param state - The starting state.
+     * @param snapshot - The starting state.
      * @param actorScope - The actor scope.
      */
-    start?: (state: TSnapshot, actorScope: ActorScope<TSnapshot, TEvent>) => void;
+    start?: (snapshot: TSnapshot, actorScope: ActorScope<TSnapshot, TEvent>) => void;
     /**
      * Obtains the internal state of the actor in a representation which can be be persisted.
-     * The persisted state can be restored by `restoreState`.
-     * @param state - The current state.
+     * The persisted state can be restored by `restoreSnapshot`.
+     * @param snapshot - The current state.
      * @returns The a representation of the internal state to be persisted.
      */
-    getPersistedState: (state: TSnapshot, options?: unknown) => Snapshot<unknown>;
+    getPersistedSnapshot: (snapshot: TSnapshot, options?: unknown) => Snapshot<unknown>;
 }
 export type AnyActorLogic = ActorLogic<any, // snapshot
 any, // event

package/dist/{log-d160285c.development.cjs.js → log-516ee274.development.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var guards_dist_xstateGuards = require('./raise-9dd3e757.development.cjs.js');
+var guards_dist_xstateGuards = require('./raise-57f3c654.development.cjs.js');
 
 function createSpawner(actorScope, {
   machine,
@@ -55,17 +55,17 @@ function createSpawner(actorScope, {
   };
 }
 
-function resolveAssign(actorScope, state, actionArgs, actionParams, {
+function resolveAssign(actorScope, snapshot, actionArgs, actionParams, {
   assignment
 }) {
-  if (!state.context) {
+  if (!snapshot.context) {
     throw new Error('Cannot assign to undefined `context`. Ensure that `context` is defined in the machine config.');
   }
   const spawnedChildren = {};
   const assignArgs = {
-    context: state.context,
+    context: snapshot.context,
     event: actionArgs.event,
-    spawn: createSpawner(actorScope, state, actionArgs.event, spawnedChildren),
+    spawn: createSpawner(actorScope, snapshot, actionArgs.event, spawnedChildren),
     self: actorScope?.self,
     system: actorScope?.system
   };
@@ -78,13 +78,13 @@ function resolveAssign(actorScope, state, actionArgs, actionParams, {
       partialUpdate[key] = typeof propAssignment === 'function' ? propAssignment(assignArgs, actionParams) : propAssignment;
     }
   }
-  const updatedContext = Object.assign({}, state.context, partialUpdate);
-  return [guards_dist_xstateGuards.cloneMachineSnapshot(state, {
+  const updatedContext = Object.assign({}, snapshot.context, partialUpdate);
+  return [guards_dist_xstateGuards.cloneMachineSnapshot(snapshot, {
     context: updatedContext,
     children: Object.keys(spawnedChildren).length ? {
-      ...state.children,
+      ...snapshot.children,
       ...spawnedChildren
-    } : state.children
+    } : snapshot.children
   })];
 }
 /**
@@ -168,13 +168,13 @@ let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
  * @template TSystem - The type of the actor system.
  */
 
-function resolveSendTo(actorScope, state, args, actionParams, {
+function resolveSendTo(actorScope, snapshot, args, actionParams, {
   to,
   event: eventOrExpr,
   id,
   delay
 }, extra) {
-  const delaysMap = state.machine.implementations.delays;
+  const delaysMap = snapshot.machine.implementations.delays;
   if (typeof eventOrExpr === 'string') {
     throw new Error(`Only event objects may be used with sendTo; use sendTo({ type: "${eventOrExpr}" }) instead`);
   }
@@ -196,26 +196,26 @@ function resolveSendTo(actorScope, state, args, actionParams, {
     } else if (resolvedTarget.startsWith('#_')) {
       // SCXML compatibility: https://www.w3.org/TR/scxml/#SCXMLEventProcessor
       // #_invokeid. If the target is the special term '#_invokeid', where invokeid is the invokeid of an SCXML session that the sending session has created by <invoke>, the Processor must add the event to the external queue of that session.
-      targetActorRef = state.children[resolvedTarget.slice(2)];
+      targetActorRef = snapshot.children[resolvedTarget.slice(2)];
     } else {
-      targetActorRef = extra.deferredActorIds?.includes(resolvedTarget) ? resolvedTarget : state.children[resolvedTarget];
+      targetActorRef = extra.deferredActorIds?.includes(resolvedTarget) ? resolvedTarget : snapshot.children[resolvedTarget];
     }
     if (!targetActorRef) {
-      throw new Error(`Unable to send event to actor '${resolvedTarget}' from machine '${state.machine.id}'.`);
+      throw new Error(`Unable to send event to actor '${resolvedTarget}' from machine '${snapshot.machine.id}'.`);
     }
   } else {
     targetActorRef = resolvedTarget || actorScope?.self;
   }
-  return [state, {
+  return [snapshot, {
     to: targetActorRef,
     event: resolvedEvent,
     id,
     delay: resolvedDelay
   }];
 }
-function retryResolveSendTo(_, state, params) {
+function retryResolveSendTo(_, snapshot, params) {
   if (typeof params.to === 'string') {
-    params.to = state.children[params.to];
+    params.to = snapshot.children[params.to];
   }
 }
 function executeSendTo(actorScope, params) {
@@ -249,7 +249,7 @@ function sendTo(to, eventOrExpr, options) {
       throw new Error(`This isn't supposed to be called`);
     }
   }
-  sendTo.type = 'xstate.sendTo';
+  sendTo.type = 'xsnapshot.sendTo';
   sendTo.to = to;
   sendTo.event = eventOrExpr;
   sendTo.id = options?.id;
@@ -291,23 +291,7 @@ function forwardTo(target, options) {
   }) => event, options);
 }
 
-/**
- * Escalates an error by sending it as an event to this machine's parent.
- *
- * @param errorData The error data to send, or the expression function that
- * takes in the `context`, `event`, and `meta`, and returns the error data to send.
- * @param options Options to pass into the send action creator.
- */
-function escalate(errorData, options) {
-  return sendParent(arg => {
-    return {
-      type: guards_dist_xstateGuards.XSTATE_ERROR,
-      data: typeof errorData === 'function' ? errorData(arg) : errorData
-    };
-  }, options);
-}
-
-function resolveEnqueueActions(_, state, args, _actionParams, {
+function resolveEnqueueActions(_, snapshot, args, _actionParams, {
   collect
 }) {
   const actions = [];
@@ -336,9 +320,9 @@ function resolveEnqueueActions(_, state, args, _actionParams, {
     context: args.context,
     event: args.event,
     enqueue,
-    check: guard => guards_dist_xstateGuards.evaluateGuard(guard, state.context, args.event, state)
+    check: guard => guards_dist_xstateGuards.evaluateGuard(guard, snapshot.context, args.event, snapshot)
   });
-  return [state, undefined, actions];
+  return [snapshot, undefined, actions];
 }
 function enqueueActions(collect) {
   function enqueueActions(args, params) {
@@ -352,11 +336,11 @@ function enqueueActions(collect) {
   return enqueueActions;
 }
 
-function resolveLog(_, state, actionArgs, actionParams, {
+function resolveLog(_, snapshot, actionArgs, actionParams, {
   value,
   label
 }) {
-  return [state, {
+  return [snapshot, {
     value: typeof value === 'function' ? value(actionArgs, actionParams) : value,
     label
   }];
@@ -404,7 +388,6 @@ function log(value = ({
 exports.SpecialTargets = SpecialTargets;
 exports.assign = assign;
 exports.enqueueActions = enqueueActions;
-exports.escalate = escalate;
 exports.forwardTo = forwardTo;
 exports.log = log;
 exports.sendParent = sendParent;

package/dist/{log-3d815f5e.cjs.js → log-5b24d580.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var guards_dist_xstateGuards = require('./raise-367eeb6f.cjs.js');
+var guards_dist_xstateGuards = require('./raise-5f22d333.cjs.js');
 
 function createSpawner(actorScope, {
   machine,
@@ -55,17 +55,17 @@ function createSpawner(actorScope, {
   };
 }
 
-function resolveAssign(actorScope, state, actionArgs, actionParams, {
+function resolveAssign(actorScope, snapshot, actionArgs, actionParams, {
   assignment
 }) {
-  if (!state.context) {
+  if (!snapshot.context) {
     throw new Error('Cannot assign to undefined `context`. Ensure that `context` is defined in the machine config.');
   }
   const spawnedChildren = {};
   const assignArgs = {
-    context: state.context,
+    context: snapshot.context,
     event: actionArgs.event,
-    spawn: createSpawner(actorScope, state, actionArgs.event, spawnedChildren),
+    spawn: createSpawner(actorScope, snapshot, actionArgs.event, spawnedChildren),
     self: actorScope?.self,
     system: actorScope?.system
   };
@@ -78,13 +78,13 @@ function resolveAssign(actorScope, state, actionArgs, actionParams, {
       partialUpdate[key] = typeof propAssignment === 'function' ? propAssignment(assignArgs, actionParams) : propAssignment;
     }
   }
-  const updatedContext = Object.assign({}, state.context, partialUpdate);
-  return [guards_dist_xstateGuards.cloneMachineSnapshot(state, {
+  const updatedContext = Object.assign({}, snapshot.context, partialUpdate);
+  return [guards_dist_xstateGuards.cloneMachineSnapshot(snapshot, {
     context: updatedContext,
     children: Object.keys(spawnedChildren).length ? {
-      ...state.children,
+      ...snapshot.children,
       ...spawnedChildren
-    } : state.children
+    } : snapshot.children
   })];
 }
 /**
@@ -165,13 +165,13 @@ let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
  * @template TSystem - The type of the actor system.
  */
 
-function resolveSendTo(actorScope, state, args, actionParams, {
+function resolveSendTo(actorScope, snapshot, args, actionParams, {
   to,
   event: eventOrExpr,
   id,
   delay
 }, extra) {
-  const delaysMap = state.machine.implementations.delays;
+  const delaysMap = snapshot.machine.implementations.delays;
   if (typeof eventOrExpr === 'string') {
     throw new Error(`Only event objects may be used with sendTo; use sendTo({ type: "${eventOrExpr}" }) instead`);
   }
@@ -193,26 +193,26 @@ function resolveSendTo(actorScope, state, args, actionParams, {
     } else if (resolvedTarget.startsWith('#_')) {
       // SCXML compatibility: https://www.w3.org/TR/scxml/#SCXMLEventProcessor
       // #_invokeid. If the target is the special term '#_invokeid', where invokeid is the invokeid of an SCXML session that the sending session has created by <invoke>, the Processor must add the event to the external queue of that session.
-      targetActorRef = state.children[resolvedTarget.slice(2)];
+      targetActorRef = snapshot.children[resolvedTarget.slice(2)];
     } else {
-      targetActorRef = extra.deferredActorIds?.includes(resolvedTarget) ? resolvedTarget : state.children[resolvedTarget];
+      targetActorRef = extra.deferredActorIds?.includes(resolvedTarget) ? resolvedTarget : snapshot.children[resolvedTarget];
     }
     if (!targetActorRef) {
-      throw new Error(`Unable to send event to actor '${resolvedTarget}' from machine '${state.machine.id}'.`);
+      throw new Error(`Unable to send event to actor '${resolvedTarget}' from machine '${snapshot.machine.id}'.`);
     }
   } else {
     targetActorRef = resolvedTarget || actorScope?.self;
   }
-  return [state, {
+  return [snapshot, {
     to: targetActorRef,
     event: resolvedEvent,
     id,
     delay: resolvedDelay
   }];
 }
-function retryResolveSendTo(_, state, params) {
+function retryResolveSendTo(_, snapshot, params) {
   if (typeof params.to === 'string') {
-    params.to = state.children[params.to];
+    params.to = snapshot.children[params.to];
   }
 }
 function executeSendTo(actorScope, params) {
@@ -243,7 +243,7 @@ function executeSendTo(actorScope, params) {
 function sendTo(to, eventOrExpr, options) {
   function sendTo(args, params) {
   }
-  sendTo.type = 'xstate.sendTo';
+  sendTo.type = 'xsnapshot.sendTo';
   sendTo.to = to;
   sendTo.event = eventOrExpr;
   sendTo.id = options?.id;
@@ -275,23 +275,7 @@ function forwardTo(target, options) {
   }) => event, options);
 }
 
-/**
- * Escalates an error by sending it as an event to this machine's parent.
- *
- * @param errorData The error data to send, or the expression function that
- * takes in the `context`, `event`, and `meta`, and returns the error data to send.
- * @param options Options to pass into the send action creator.
- */
-function escalate(errorData, options) {
-  return sendParent(arg => {
-    return {
-      type: guards_dist_xstateGuards.XSTATE_ERROR,
-      data: typeof errorData === 'function' ? errorData(arg) : errorData
-    };
-  }, options);
-}
-
-function resolveEnqueueActions(_, state, args, _actionParams, {
+function resolveEnqueueActions(_, snapshot, args, _actionParams, {
   collect
 }) {
   const actions = [];
@@ -320,9 +304,9 @@ function resolveEnqueueActions(_, state, args, _actionParams, {
     context: args.context,
     event: args.event,
     enqueue,
-    check: guard => guards_dist_xstateGuards.evaluateGuard(guard, state.context, args.event, state)
+    check: guard => guards_dist_xstateGuards.evaluateGuard(guard, snapshot.context, args.event, snapshot)
   });
-  return [state, undefined, actions];
+  return [snapshot, undefined, actions];
 }
 function enqueueActions(collect) {
   function enqueueActions(args, params) {
@@ -333,11 +317,11 @@ function enqueueActions(collect) {
   return enqueueActions;
 }
 
-function resolveLog(_, state, actionArgs, actionParams, {
+function resolveLog(_, snapshot, actionArgs, actionParams, {
   value,
   label
 }) {
-  return [state, {
+  return [snapshot, {
     value: typeof value === 'function' ? value(actionArgs, actionParams) : value,
     label
   }];
@@ -382,7 +366,6 @@ function log(value = ({
 exports.SpecialTargets = SpecialTargets;
 exports.assign = assign;
 exports.enqueueActions = enqueueActions;
-exports.escalate = escalate;
 exports.forwardTo = forwardTo;
 exports.log = log;
 exports.sendParent = sendParent;

package/dist/{log-826c9895.development.esm.js → log-5ebdc815.development.esm.js}

@@ -1,4 +1,4 @@
-import { R as ProcessingStatus, y as resolveReferencedActor, z as createActor, T as cloneMachineSnapshot, U as XSTATE_ERROR, V as createErrorActorEvent, e as evaluateGuard, L as cancel, M as raise, O as spawnChild, Q as stopChild } from './raise-1caefe80.development.esm.js';
+import { R as ProcessingStatus, y as resolveReferencedActor, z as createActor, T as cloneMachineSnapshot, U as XSTATE_ERROR, V as createErrorActorEvent, e as evaluateGuard, L as cancel, M as raise, O as spawnChild, Q as stopChild } from './raise-a6c478f8.development.esm.js';
 
 function createSpawner(actorScope, {
   machine,
@@ -53,17 +53,17 @@ function createSpawner(actorScope, {
   };
 }
 
-function resolveAssign(actorScope, state, actionArgs, actionParams, {
+function resolveAssign(actorScope, snapshot, actionArgs, actionParams, {
   assignment
 }) {
-  if (!state.context) {
+  if (!snapshot.context) {
     throw new Error('Cannot assign to undefined `context`. Ensure that `context` is defined in the machine config.');
   }
   const spawnedChildren = {};
   const assignArgs = {
-    context: state.context,
+    context: snapshot.context,
     event: actionArgs.event,
-    spawn: createSpawner(actorScope, state, actionArgs.event, spawnedChildren),
+    spawn: createSpawner(actorScope, snapshot, actionArgs.event, spawnedChildren),
     self: actorScope?.self,
     system: actorScope?.system
   };
@@ -76,13 +76,13 @@ function resolveAssign(actorScope, state, actionArgs, actionParams, {
       partialUpdate[key] = typeof propAssignment === 'function' ? propAssignment(assignArgs, actionParams) : propAssignment;
     }
   }
-  const updatedContext = Object.assign({}, state.context, partialUpdate);
-  return [cloneMachineSnapshot(state, {
+  const updatedContext = Object.assign({}, snapshot.context, partialUpdate);
+  return [cloneMachineSnapshot(snapshot, {
     context: updatedContext,
     children: Object.keys(spawnedChildren).length ? {
-      ...state.children,
+      ...snapshot.children,
       ...spawnedChildren
-    } : state.children
+    } : snapshot.children
   })];
 }
 /**
@@ -166,13 +166,13 @@ let SpecialTargets = /*#__PURE__*/function (SpecialTargets) {
  * @template TSystem - The type of the actor system.
  */
 
-function resolveSendTo(actorScope, state, args, actionParams, {
+function resolveSendTo(actorScope, snapshot, args, actionParams, {
   to,
   event: eventOrExpr,
   id,
   delay
 }, extra) {
-  const delaysMap = state.machine.implementations.delays;
+  const delaysMap = snapshot.machine.implementations.delays;
   if (typeof eventOrExpr === 'string') {
     throw new Error(`Only event objects may be used with sendTo; use sendTo({ type: "${eventOrExpr}" }) instead`);
   }
@@ -194,26 +194,26 @@ function resolveSendTo(actorScope, state, args, actionParams, {
     } else if (resolvedTarget.startsWith('#_')) {
       // SCXML compatibility: https://www.w3.org/TR/scxml/#SCXMLEventProcessor
       // #_invokeid. If the target is the special term '#_invokeid', where invokeid is the invokeid of an SCXML session that the sending session has created by <invoke>, the Processor must add the event to the external queue of that session.
-      targetActorRef = state.children[resolvedTarget.slice(2)];
+      targetActorRef = snapshot.children[resolvedTarget.slice(2)];
     } else {
-      targetActorRef = extra.deferredActorIds?.includes(resolvedTarget) ? resolvedTarget : state.children[resolvedTarget];
+      targetActorRef = extra.deferredActorIds?.includes(resolvedTarget) ? resolvedTarget : snapshot.children[resolvedTarget];
     }
     if (!targetActorRef) {
-      throw new Error(`Unable to send event to actor '${resolvedTarget}' from machine '${state.machine.id}'.`);
+      throw new Error(`Unable to send event to actor '${resolvedTarget}' from machine '${snapshot.machine.id}'.`);
     }
   } else {
     targetActorRef = resolvedTarget || actorScope?.self;
   }
-  return [state, {
+  return [snapshot, {
     to: targetActorRef,
     event: resolvedEvent,
     id,
     delay: resolvedDelay
   }];
 }
-function retryResolveSendTo(_, state, params) {
+function retryResolveSendTo(_, snapshot, params) {
   if (typeof params.to === 'string') {
-    params.to = state.children[params.to];
+    params.to = snapshot.children[params.to];
   }
 }
 function executeSendTo(actorScope, params) {
@@ -247,7 +247,7 @@ function sendTo(to, eventOrExpr, options) {
       throw new Error(`This isn't supposed to be called`);
     }
   }
-  sendTo.type = 'xstate.sendTo';
+  sendTo.type = 'xsnapshot.sendTo';
   sendTo.to = to;
   sendTo.event = eventOrExpr;
   sendTo.id = options?.id;
@@ -289,23 +289,7 @@ function forwardTo(target, options) {
   }) => event, options);
 }
 
-/**
- * Escalates an error by sending it as an event to this machine's parent.
- *
- * @param errorData The error data to send, or the expression function that
- * takes in the `context`, `event`, and `meta`, and returns the error data to send.
- * @param options Options to pass into the send action creator.
- */
-function escalate(errorData, options) {
-  return sendParent(arg => {
-    return {
-      type: XSTATE_ERROR,
-      data: typeof errorData === 'function' ? errorData(arg) : errorData
-    };
-  }, options);
-}
-
-function resolveEnqueueActions(_, state, args, _actionParams, {
+function resolveEnqueueActions(_, snapshot, args, _actionParams, {
   collect
 }) {
   const actions = [];
@@ -334,9 +318,9 @@ function resolveEnqueueActions(_, state, args, _actionParams, {
     context: args.context,
     event: args.event,
     enqueue,
-    check: guard => evaluateGuard(guard, state.context, args.event, state)
+    check: guard => evaluateGuard(guard, snapshot.context, args.event, snapshot)
   });
-  return [state, undefined, actions];
+  return [snapshot, undefined, actions];
 }
 function enqueueActions(collect) {
   function enqueueActions(args, params) {
@@ -350,11 +334,11 @@ function enqueueActions(collect) {
   return enqueueActions;
 }
 
-function resolveLog(_, state, actionArgs, actionParams, {
+function resolveLog(_, snapshot, actionArgs, actionParams, {
   value,
   label
 }) {
-  return [state, {
+  return [snapshot, {
     value: typeof value === 'function' ? value(actionArgs, actionParams) : value,
     label
   }];
@@ -399,4 +383,4 @@ function log(value = ({
   return log;
 }
 
-export { SpecialTargets as S, assign as a, escalate as b, sendTo as c, enqueueActions as e, forwardTo as f, log as l, sendParent as s };
+export { SpecialTargets as S, assign as a, sendTo as b, enqueueActions as e, forwardTo as f, log as l, sendParent as s };