xstate 6.0.0-beta.0 → 6.0.0-beta.2

package/dist/xstate.development.cjs.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var dist_xstateActors = require('./xstate-actors.development.cjs.js');
-var createActor = require('./createActor-a49ae0ce.development.cjs.js');
-var machineSchemas = require('./machineSchemas-6d96bef4.development.cjs.js');
+var createActor = require('./createActor-c029d29f.development.cjs.js');
+var legacySnapshot = require('./legacySnapshot-ebf0b2b8.development.cjs.js');
 var schema_types = require('./schema.types-1c16f035.development.cjs.js');
-var effectDescriptor = require('./effectDescriptor-f73da4ec.development.cjs.js');
+var effectDescriptor = require('./effectDescriptor-3fff5c51.development.cjs.js');
 require('./validation-f2714a35.development.cjs.js');
 
 /**
@@ -94,7 +94,7 @@ function createMachine(config, ...rest) {
     throw new Error('createMachine(config) takes one argument; the second argument (implementations) was removed. Declare implementations with setup({ actions, guards, actors, delays }).createMachine(config), or pass them to machine.provide({ ... }).' );
   }
   createActor.diagnoseAuthorConfig(config);
-  return new machineSchemas.StateMachine(config);
+  return new legacySnapshot.StateMachine(config);
 }
 
 /**
@@ -104,7 +104,7 @@ function createMachine(config, ...rest) {
  * @experimental Used by `@xstate/scxml`; not part of the stable API.
  */
 function createMachineFromCompiledConfig(config, validator) {
-  return new machineSchemas.StateMachine(config, undefined, validator);
+  return new legacySnapshot.StateMachine(config, undefined, validator);
 }
 
 /** @public */
@@ -1146,10 +1146,10 @@ function isVersionedStateMachine(entry) {
   return 'transition' in entry && typeof entry.transition === 'function';
 }
 function getEntrySnapshotSchema(entry) {
-  return isVersionedStateMachine(entry) ? machineSchemas.snapshotSchema(entry) : entry.snapshotSchema;
+  return isVersionedStateMachine(entry) ? legacySnapshot.snapshotSchema(entry) : entry.snapshotSchema;
 }
 function getEntryEventSchema(entry) {
-  return isVersionedStateMachine(entry) ? machineSchemas.historicalEventSchema(entry) : entry.eventSchema;
+  return isVersionedStateMachine(entry) ? legacySnapshot.historicalEventSchema(entry) : entry.eventSchema;
 }
 function getSnapshotSource(raw) {
   if (!isObject(raw)) {
@@ -1174,7 +1174,7 @@ async function validate(schema, value, description) {
   return result.value;
 }
 async function finalizeSnapshot(snapshot, target) {
-  return await validate(machineSchemas.snapshotSchema(target), {
+  return await validate(legacySnapshot.snapshotSchema(target), {
     ...snapshot,
     machine: {
       id: target.id,
@@ -1311,13 +1311,13 @@ function machineVersions(entries, options) {
           }
           const adapter = adaptationOptions.adapters[source.version];
           if (adapter) {
-            return validateEvents(await adapter(sourceEvents), target, machineSchemas.historicalEventSchema(target));
+            return validateEvents(await adapter(sourceEvents), target, legacySnapshot.historicalEventSchema(target));
           }
         }
       }
       const wildcardAdapter = adaptationOptions.adapters['*'];
       if (wildcardAdapter) {
-        return validateEvents(await wildcardAdapter(events, adaptationOptions.from), target, machineSchemas.historicalEventSchema(target));
+        return validateEvents(await wildcardAdapter(events, adaptationOptions.from), target, legacySnapshot.historicalEventSchema(target));
       }
       if (hasTypedSource) {
         if (sourceValidationFailed) {
@@ -1780,7 +1780,7 @@ const setup = function setupImplementation(config = {}) {
         } : undefined)
       };
       createActor.diagnoseAuthorConfig(config);
-      return new machineSchemas.StateMachine(config, undefined, validator);
+      return new legacySnapshot.StateMachine(config, undefined, validator);
     },
     createInvoke(invokeConfig, ..._check) {
       return typeof invokeConfig.src === 'function' ? {
@@ -2111,13 +2111,13 @@ class SimulatedClock {
 // logical timer key (or, for a directly delivered event, the event type).
 function systemTimerKey(source, event) {
   const key = event.type === 'xstate.timer' ? createActor.readTimerKey(event) : undefined;
-  return JSON.stringify([source.$actor, source.incarnation, key ? createActor.serializeTimerKey(key) : event.type]);
+  return JSON.stringify([source['@actor'], source.incarnation, key ? createActor.serializeTimerKey(key) : event.type]);
 }
 function isLogicalTimerPending(snapshot, key) {
   return (snapshot.timers ?? []).some(timer => createActor.matchesTimerKey(timer, key));
 }
 function isReference(value) {
-  return !!value && typeof value.$actor === 'string' && typeof value.incarnation === 'string';
+  return !!value && typeof value['@actor'] === 'string' && typeof value.incarnation === 'string';
 }
 function isHandle(value) {
   return !!value && typeof value.address === 'string' && typeof value.getSnapshot === 'function';
@@ -2128,12 +2128,12 @@ const systemLogger = () => {};
 /** Converts runtime-shaped, reduction-local capabilities to snapshot data. */
 function encode(value, seen = new Set(), mappers) {
   if (typeof value === 'function' && mappers?.has(value)) return {
-    $systemMapper: mappers.get(value)
+    '@systemMapper': mappers.get(value)
   };
   if (isHandle(value)) {
     if (!value[systemActorHandle]) throw new Error('Live actors cannot be stored in a pure system snapshot.');
     return {
-      $actor: value.address,
+      '@actor': value.address,
       incarnation: value.sessionId
     };
   }
@@ -2146,11 +2146,11 @@ function encode(value, seen = new Set(), mappers) {
   let result;
   if (value.machine && typeof value.machine.transition === 'function' && typeof value.id === 'string' && Array.isArray(value.path)) {
     result = {
-      $stateNode: value.id
+      '@stateNode': value.id
     };
   } else if (value instanceof Error) {
     result = {
-      $error: value.name,
+      '@error': value.name,
       message: value.message
     };
   } else if (Array.isArray(value)) {
@@ -2176,10 +2176,17 @@ function snapshotData(snapshot, mappers) {
     getMeta,
     getInputs,
     toJSON,
+    // Stores such as Convex reject `_`-prefixed field names.
+    _stateInputs: stateInputs,
+    _nextTimerId: nextTimerId,
+    _nextActorIds: nextActorIds,
     ...data
   } = snapshot;
   return encode({
     ...data,
+    stateInputs,
+    nextTimerId,
+    nextActorIds,
     nodeIds: nodes.map(node => node.id)
   }, new Set(), mappers);
 }
@@ -2223,6 +2230,8 @@ class SystemReduction {
     this.mappers = void 0;
     this.remaining = void 0;
     if (!Number.isSafeInteger(maxSteps) || maxSteps < 1) throw new Error('maxSteps must be a positive integer.');
+    // TODO(v7): remove with legacySnapshot.ts.
+    snapshot = legacySnapshot.upgradeLegacySystemSnapshot(snapshot);
     this.logic = definitions(logic);
     this.mappers = logic.mappers ?? {};
     this.mapperNames = new Map(Object.entries(this.mappers).map(([key, mapper]) => [mapper, key]));
@@ -2253,26 +2262,26 @@ class SystemReduction {
   }
   reference(actor) {
     return {
-      $actor: actor.address,
+      '@actor': actor.address,
       incarnation: actor.sessionId
     };
   }
   current(ref) {
-    const actor = this.snapshot.actors[ref.$actor];
+    const actor = this.snapshot.actors[ref['@actor']];
     return actor?.incarnation === ref.incarnation ? actor : undefined;
   }
   decode(value, machine) {
     if (isReference(value)) return this.handle(value);
     if (!value || typeof value !== 'object') return value;
-    if (typeof value.$systemMapper === 'string') {
-      const mapper = Object.hasOwn(this.mappers, value.$systemMapper) && this.mappers[value.$systemMapper];
-      if (!mapper) throw new Error(`Missing pure mapper '${value.$systemMapper}'.`);
+    if (typeof value['@systemMapper'] === 'string') {
+      const mapper = Object.hasOwn(this.mappers, value['@systemMapper']) && this.mappers[value['@systemMapper']];
+      if (!mapper) throw new Error(`Missing pure mapper '${value['@systemMapper']}'.`);
       return mapper;
     }
-    if (typeof value.$stateNode === 'string') return machine.getStateNodeById(value.$stateNode);
-    if (typeof value.$error === 'string') {
+    if (typeof value['@stateNode'] === 'string') return machine.getStateNodeById(value['@stateNode']);
+    if (typeof value['@error'] === 'string') {
       const error = new Error(value.message);
-      error.name = value.$error;
+      error.name = value['@error'];
       if (error.name === 'TimeoutError') Object.setPrototypeOf(error, dist_xstateActors.TimeoutError.prototype);
       return error;
     }
@@ -2290,7 +2299,7 @@ class SystemReduction {
       const kind = this.attachedKind(actor);
       if (!actor.started || actor.snapshot.status !== 'active' || kind !== '@xstate.listener' && kind !== '@xstate.subscription') continue;
       const target = actor.input.actor;
-      if (!target || target.$actor !== source.$actor || target.incarnation !== source.incarnation || !actor.parent || this.current(actor.parent)?.snapshot.status !== 'active') continue;
+      if (!target || target['@actor'] !== source['@actor'] || target.incarnation !== source.incarnation || !actor.parent || this.current(actor.parent)?.snapshot.status !== 'active') continue;
       const input = this.decode(actor.input);
       let event;
       if (kind === '@xstate.listener') {
@@ -2301,7 +2310,7 @@ class SystemReduction {
         if (mapper) event = mapper(snapshot.status === 'done' ? snapshot.output : snapshot.status === 'error' ? snapshot.error : snapshot);
       }
       if (event) this.enqueue({
-        $actor: actor.address,
+        '@actor': actor.address,
         incarnation: actor.incarnation
       }, actor.parent, event);
     }
@@ -2309,8 +2318,8 @@ class SystemReduction {
   stopAttachments(parent) {
     for (const actor of Object.values(this.snapshot.actors)) {
       const kind = this.attachedKind(actor);
-      if ((kind === '@xstate.listener' || kind === '@xstate.subscription') && actor.parent?.$actor === parent.$actor && actor.parent.incarnation === parent.incarnation) this.stop({
-        $actor: actor.address,
+      if ((kind === '@xstate.listener' || kind === '@xstate.subscription') && actor.parent?.['@actor'] === parent['@actor'] && actor.parent.incarnation === parent.incarnation) this.stop({
+        '@actor': actor.address,
         incarnation: actor.incarnation
       });
     }
@@ -2329,6 +2338,9 @@ class SystemReduction {
     const data = this.decode(actor.snapshot, logic);
     const snapshot = typeof logic.getStateNodeById === 'function' && data.nodeIds ? createActor.createMachineSnapshot({
       ...data,
+      _stateInputs: data.stateInputs,
+      _nextTimerId: data.nextTimerId,
+      _nextActorIds: data.nextActorIds,
       _nodes: data.nodeIds.map(id => logic.getStateNodeById(id))
     }, logic) : data;
     this.snapshots.set(key, snapshot);
@@ -2351,8 +2363,8 @@ class SystemReduction {
     };
     const handle = {
       [systemActorHandle]: true,
-      id: actor?.id ?? ref.$actor.split('/').at(-1),
-      address: ref.$actor,
+      id: actor?.id ?? ref['@actor'].split('/').at(-1),
+      address: ref['@actor'],
       sessionId: ref.incarnation,
       options: {
         _inert: true,
@@ -2391,13 +2403,13 @@ class SystemReduction {
       _unregister: actor => {
         this.stopping.add(JSON.stringify(this.reference(actor)));
         for (const [key, ref] of Object.entries(this.snapshot.registry)) {
-          if (ref.$actor === actor.address && ref.incarnation === actor.sessionId) delete this.snapshot.registry[key];
+          if (ref['@actor'] === actor.address && ref.incarnation === actor.sessionId) delete this.snapshot.registry[key];
         }
       },
       _getByAddress: address => {
         const actor = this.snapshot.actors[address];
         return actor?.snapshot.status === 'active' ? this.handle({
-          $actor: address,
+          '@actor': address,
           incarnation: actor.incarnation
         }) : undefined;
       },
@@ -2443,11 +2455,11 @@ class SystemReduction {
     if (!definition) throw new Error('Register dynamically spawned logic in systemLogic.actors.');
     const parent = options.parent && this.reference(options.parent);
     const id = options.id ?? `${createActor.getActorIdPrefix(options.src ?? logic)}:${this.snapshot.counters.actor}`;
-    const address = `${parent ? parent.$actor + '/' : ''}${createActor.encodeAddressSegment(id)}`;
+    const address = `${parent ? parent['@actor'] + '/' : ''}${createActor.encodeAddressSegment(id)}`;
     const occupied = this.snapshot.actors[address];
     if (occupied?.snapshot.status === 'active') {
       const previous = {
-        $actor: address,
+        '@actor': address,
         incarnation: occupied.incarnation
       };
       if (!this.stopping.has(JSON.stringify(previous))) throw new Error(`Actor address '${address}' is already occupied.`);
@@ -2455,7 +2467,7 @@ class SystemReduction {
     }
     const incarnation = String(this.snapshot.counters.actor++);
     const ref = {
-      $actor: address,
+      '@actor': address,
       incarnation
     };
     const state = {
@@ -2493,7 +2505,7 @@ class SystemReduction {
     const actor = this.current(ref);
     if (!actor) return;
     this.snapshots.set(JSON.stringify(ref), snapshot);
-    this.snapshot.actors[ref.$actor] = {
+    this.snapshot.actors[ref['@actor']] = {
       ...actor,
       snapshot: snapshotData(snapshot, this.mapperNames)
     };
@@ -2543,7 +2555,7 @@ class SystemReduction {
       ...key
     });
     for (const [timerKey, timer] of Object.entries(this.snapshot.timers)) {
-      if (timer.source.$actor === ref.$actor && timer.source.incarnation === ref.incarnation && (cancelled === undefined || timerKey === cancelled)) delete this.snapshot.timers[timerKey];
+      if (timer.source['@actor'] === ref['@actor'] && timer.source.incarnation === ref.incarnation && (cancelled === undefined || timerKey === cancelled)) delete this.snapshot.timers[timerKey];
     }
   }
   effectsFor(ref, effects) {
@@ -2581,9 +2593,9 @@ class SystemReduction {
             } else if (createActor.isSerializedActorRef(value.target)) {
               // A ref that went through JSON targets the current incarnation
               // at its address; without one the event is a dead letter.
-              const target = this.snapshot.actors[value.target.$actor];
+              const target = this.snapshot.actors[value.target['@actor']];
               if (target?.snapshot.status === 'active' && (value.target.incarnation === undefined || value.target.incarnation === target.incarnation)) this.enqueue(ref, {
-                $actor: target.address,
+                '@actor': target.address,
                 incarnation: target.incarnation
               }, value.event);else this.external(ref, {
                 kind: 'builtin',
@@ -2623,7 +2635,7 @@ class SystemReduction {
   start(ref) {
     const actor = this.current(ref);
     if (!actor || actor.started || actor.snapshot.status === 'stopped') return;
-    this.snapshot.actors[ref.$actor] = {
+    this.snapshot.actors[ref['@actor']] = {
       ...actor,
       started: true
     };
@@ -2663,13 +2675,13 @@ class SystemReduction {
     });
     this.cancel(ref);
     this.handle(ref).system._unregister(this.handle(ref));
-    this.snapshot.messages = this.snapshot.messages.filter(message => message.target.$actor !== ref.$actor || message.target.incarnation !== ref.incarnation);
+    this.snapshot.messages = this.snapshot.messages.filter(message => message.target['@actor'] !== ref['@actor'] || message.target.incarnation !== ref.incarnation);
     this.cancelExternal(ref);
     this.stopAttachments(ref);
   }
   cancelExternal(ref) {
     for (const [id, effect] of Object.entries(this.snapshot.externalEffects)) {
-      if (effect.kind !== 'action' || effect.type === '@xstate.cancelEffect' || effect.type === '@xstate.cleanup' || effect.source.$actor !== ref.$actor || effect.source.incarnation !== ref.incarnation) continue;
+      if (effect.kind !== 'action' || effect.type === '@xstate.cancelEffect' || effect.type === '@xstate.cleanup' || effect.source['@actor'] !== ref['@actor'] || effect.source.incarnation !== ref.incarnation) continue;
       delete this.snapshot.externalEffects[id];
       const cancellation = {
         id: `${this.snapshot.executionId}:${this.snapshot.counters.effect++}`,
@@ -2706,7 +2718,7 @@ class SystemReduction {
     }
     const logic = this.logic.get(actor.src);
     if (!logic) throw new Error(`Missing actor definition '${actor.src}'.`);
-    if (logic.isInternalEventType?.(message.event.type) && (!message.source || message.source.$actor !== actor.address || message.source.incarnation !== actor.incarnation)) {
+    if (logic.isInternalEventType?.(message.event.type) && (!message.source || message.source['@actor'] !== actor.address || message.source.incarnation !== actor.incarnation)) {
       throw new Error(`Internal event '${message.event.type}' cannot be injected into a pure system.`);
     }
     if (!message.source && /^(xstate\.after(?:\.|$)|xstate\.timeout(?:\.|$))/.test(message.event.type)) throw new Error('Select a pending timer instead of injecting its internal event.');
@@ -2763,7 +2775,7 @@ class SystemReduction {
     if (event.type === 'xstate.timer') {
       const actor = this.snapshot.actors[path];
       if (!actor) throw new Error(`Unknown actor address '${path}'.`);
-      const timer = Object.values(this.snapshot.timers).find(pending => pending.source.$actor === path && pending.source.incarnation === actor.incarnation && pending.occurrence === event.occurrence);
+      const timer = Object.values(this.snapshot.timers).find(pending => pending.source['@actor'] === path && pending.source.incarnation === actor.incarnation && pending.occurrence === event.occurrence);
       if (!timer) throw new Error('Select a current timer occurrence.');
       this.advance(timer.dueAt);
       return;
@@ -2772,12 +2784,12 @@ class SystemReduction {
     const actor = this.snapshot.actors[path];
     if (!actor) throw new Error(`Unknown actor address '${path}'.`);
     const ref = {
-      $actor: path,
+      '@actor': path,
       incarnation: actor.incarnation
     };
     if (event.type === 'xstate.system.effect.result') {
       const effect = this.snapshot.externalEffects[event.effectId];
-      if (!effect || effect.source.$actor !== path || event.event && (effect.source.incarnation !== actor.incarnation || actor.snapshot.status !== 'active' || effect.type === '@xstate.cancelEffect' || effect.type === '@xstate.cleanup')) throw new Error('External effect result does not match its owner or is stale.');
+      if (!effect || effect.source['@actor'] !== path || event.event && (effect.source.incarnation !== actor.incarnation || actor.snapshot.status !== 'active' || effect.type === '@xstate.cancelEffect' || effect.type === '@xstate.cleanup')) throw new Error('External effect result does not match its owner or is stale.');
       delete this.snapshot.externalEffects[event.effectId];
       if (event.event) {
         this.enqueue(ref, ref, event.event);
@@ -3007,10 +3019,10 @@ exports.matchesState = createActor.matchesState;
 exports.runStep = createActor.runStep;
 exports.stopActor = createActor.stopActor;
 exports.terminateActor = createActor.terminateActor;
-exports.InvalidSnapshotError = machineSchemas.InvalidSnapshotError;
-exports.StateMachine = machineSchemas.StateMachine;
-exports.StateNode = machineSchemas.StateNode;
-exports.eventSchema = machineSchemas.eventSchema;
+exports.InvalidSnapshotError = legacySnapshot.InvalidSnapshotError;
+exports.StateMachine = legacySnapshot.StateMachine;
+exports.StateNode = legacySnapshot.StateNode;
+exports.eventSchema = legacySnapshot.eventSchema;
 exports.isTypeSchema = schema_types.isTypeSchema;
 exports.types = schema_types.types;
 exports.describeExecutableEffect = effectDescriptor.describeExecutableEffect;