xstate 6.0.0-alpha.59 → 6.0.0-alpha.60

package/dist/{createActor-224ece29.development.esm.js → createActor-0b85627f.development.esm.js}

@@ -334,9 +334,19 @@ function relayMappedToParent(self, system, getEvent) {
   system._relay(self, self._parent, getEvent());
 }
 
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
 /**
  * Creates actor logic for listening to emitted events from another actor. Used
  * internally by `enq.listen()`.
+ *
+ * @public
  */
 function createListenerLogic() {
   return createAttachedLogic(({
@@ -361,11 +371,24 @@ function createListenerLogic() {
 }
 
 // Singleton logic instance
+/** @public */
 const listenerLogic = /* #__PURE__ */createListenerLogic();
 
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
 /**
  * Creates actor logic for subscribing to lifecycle events (done/error/snapshot)
  * from another actor. Used internally by `enq.subscribeTo()`.
+ *
+ * @public
  */
 function createSubscriptionLogic() {
   return createAttachedLogic(({
@@ -403,6 +426,7 @@ function createSubscriptionLogic() {
 }
 
 // Singleton logic instance
+/** @public */
 const subscriptionLogic = /* #__PURE__ */createSubscriptionLogic();
 
 /** Marks the internal lazy scope without imposing structure on custom runtimes. @internal */
@@ -1167,11 +1191,17 @@ function deriveDeferredStarts(effects) {
   }
   return [...attachedStarts, ...childStarts];
 }
+
+/** @public */
 function isBuiltInExecutableAction(action) {
   return action.kind === 'builtin';
 }
 
-/** Executes transition effects sequentially, awaiting each runtime operation. */
+/**
+ * Executes transition effects sequentially, awaiting each runtime operation.
+ *
+ * @public
+ */
 async function executeEffects(effects, runtime) {
   for (const effect of effects) {
     await effect.exec(runtime);
@@ -1797,7 +1827,10 @@ function createInertActorScope(actorLogic, snapshot, sourceSelf, sourceActorScop
   return actorScope;
 }
 
-/** @deprecated Use `initialTransition(…)` instead. */
+/**
+ * @deprecated Use `initialTransition(…)` instead.
+ * @public
+ */
 function getInitialSnapshot(actorLogic, ...[input]) {
   const actorScope = createInertActorScope(actorLogic);
   return actorLogic.initialTransition(input, actorScope)[0];
@@ -1835,6 +1868,7 @@ function getInitialSnapshot(actorLogic, ...[input]) {
  * console.log(nextSnapshot2.value);
  * // =>'red'
  * ```
+ * @public
  */
 function getNextSnapshot(actorLogic, snapshot, event) {
   const actorScope = createInertActorScope(actorLogic, snapshot);
@@ -2410,6 +2444,7 @@ function getStateNodeByPath(stateNode, statePath) {
  * Returns the state nodes represented by the current state value.
  *
  * @param stateValue The state value or State instance
+ * @public
  */
 function getStateNodes(stateNode, stateValue) {
   if (typeof stateValue === 'string') {
@@ -3703,9 +3738,14 @@ function compactSnapshotRecord(value) {
   }
   return value && Object.keys(value).length ? value : emptySnapshotRecord;
 }
+
+/** @public */
 function isMachineSnapshot(value) {
   return !!value && typeof value === 'object' && 'machine' in value && 'value' in value;
 }
+
+/** @public */
+
 const machineSnapshotMatches = function matches(testValue) {
   return matchesState(testValue, this.value);
 };
@@ -3990,6 +4030,7 @@ function persistContext(contextPart) {
   return copy ?? contextPart;
 }
 
+/** @public */
 function matchesState(parentStateId, childStateId) {
   const parentStateValue = toStateValue(parentStateId);
   const childStateValue = toStateValue(childStateId);
@@ -4011,6 +4052,8 @@ function matchesState(parentStateId, childStateId) {
     return matchesState(parentStateValue[key], childStateValue[key]);
   });
 }
+
+/** @public */
 function checkStateIn(snapshot, stateValue) {
   if (typeof stateValue === 'string' && isStateId(stateValue)) {
     const target = snapshot.machine.getStateNodeById(stateValue);
@@ -4055,6 +4098,8 @@ function toStateValue(stateValue) {
   const statePath = toStatePath(stateValue);
   return pathToStateValue(statePath);
 }
+
+/** @public */
 function pathToStateValue(statePath) {
   if (statePath.length === 1) {
     return statePath[0];
@@ -4157,6 +4202,8 @@ function normalizeTarget(target) {
   }
   return toArray(target);
 }
+
+/** @public */
 function toObserver(nextHandler, errorHandler, completionHandler) {
   const isObserver = typeof nextHandler === 'object';
   const self = isObserver ? nextHandler : undefined;
@@ -4184,6 +4231,8 @@ function resolveReferencedActor(machine, src) {
   // A referenced actor may itself be registered by name.
   return typeof configSrc === 'string' ? machine.sources.actors[configSrc] : configSrc;
 }
+
+/** @experimental */
 function getAllOwnEventDescriptors(snapshot) {
   return [...new Set([...snapshot.nodes.flatMap(sn => sn.ownEvents)])];
 }
@@ -4590,15 +4639,25 @@ function bookSessionId(system) {
  * declared schema), `'internalEvent'` (an internal event type sent from
  * outside its owning actor) or `'stopped'` (the target actor already
  * stopped). Hosts may report additional reasons.
+ *
+ * @public
  */
 
-/** Extra detail attached to a dead letter. */
+/**
+ * Extra detail attached to a dead letter.
+ *
+ * @public
+ */
 
 /**
  * Describes an event that was rejected at the delivery boundary instead of
  * being delivered to its target actor (a dead letter).
+ *
+ * @public
  */
 
+/** @experimental */
+
 /** @internal Every operation of `ActorSystemRuntime`, for runtime wrappers. */
 const RUNTIME_OPERATIONS = ['spawnActor', 'startActor', 'stopActor', 'terminateActor', 'emitEvent', 'scheduleTimer', 'cancelTimer', 'cancelAllTimers', 'deadLetter'
 // `runLogic`, `runStep` and `sendEvent` are deliberately absent: durable
@@ -4611,6 +4670,10 @@ function createScheduledTimerId(actor, id) {
   return `${actor.sessionId}.${id}`;
 }
 
+/** @public */
+
+/** @public */
+
 // These optional lazy fields intentionally have no emitted initializers.
 // oxlint-disable-next-line typescript/no-unsafe-declaration-merging
 
@@ -5046,6 +5109,8 @@ function createActorRef(logic, options) {
  * system-owned internals. It also satisfies the narrower `ActorRef` contract,
  * so consumer APIs should accept `ActorRef` when they only need to send events
  * or read snapshots.
+ *
+ * @public
  */
 class Actor {
   /**
@@ -5956,6 +6021,9 @@ class Actor {
     return this._snapshot;
   }
 }
+
+/** @public */
+
 /**
  * Creates a new actor instance for the given actor logic with the provided
  * options, if any.
@@ -5994,6 +6062,7 @@ class Actor {
  *   {@link createObservableLogic}, {@link createLogic}, and
  *   {@link createAsyncLogic}.
  * @param options - Actor options
+ * @public
  */
 function createActor(logic, options) {
   return new Actor(logic, options);

package/dist/{createActor-72b67075.development.cjs.js → createActor-6f75c8e1.development.cjs.js}

@@ -336,9 +336,19 @@ function relayMappedToParent(self, system, getEvent) {
   system._relay(self, self._parent, getEvent());
 }
 
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
 /**
  * Creates actor logic for listening to emitted events from another actor. Used
  * internally by `enq.listen()`.
+ *
+ * @public
  */
 function createListenerLogic() {
   return createAttachedLogic(({
@@ -363,11 +373,24 @@ function createListenerLogic() {
 }
 
 // Singleton logic instance
+/** @public */
 const listenerLogic = /* #__PURE__ */createListenerLogic();
 
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
 /**
  * Creates actor logic for subscribing to lifecycle events (done/error/snapshot)
  * from another actor. Used internally by `enq.subscribeTo()`.
+ *
+ * @public
  */
 function createSubscriptionLogic() {
   return createAttachedLogic(({
@@ -405,6 +428,7 @@ function createSubscriptionLogic() {
 }
 
 // Singleton logic instance
+/** @public */
 const subscriptionLogic = /* #__PURE__ */createSubscriptionLogic();
 
 /** Marks the internal lazy scope without imposing structure on custom runtimes. @internal */
@@ -1169,11 +1193,17 @@ function deriveDeferredStarts(effects) {
   }
   return [...attachedStarts, ...childStarts];
 }
+
+/** @public */
 function isBuiltInExecutableAction(action) {
   return action.kind === 'builtin';
 }
 
-/** Executes transition effects sequentially, awaiting each runtime operation. */
+/**
+ * Executes transition effects sequentially, awaiting each runtime operation.
+ *
+ * @public
+ */
 async function executeEffects(effects, runtime) {
   for (const effect of effects) {
     await effect.exec(runtime);
@@ -1799,7 +1829,10 @@ function createInertActorScope(actorLogic, snapshot, sourceSelf, sourceActorScop
   return actorScope;
 }
 
-/** @deprecated Use `initialTransition(…)` instead. */
+/**
+ * @deprecated Use `initialTransition(…)` instead.
+ * @public
+ */
 function getInitialSnapshot(actorLogic, ...[input]) {
   const actorScope = createInertActorScope(actorLogic);
   return actorLogic.initialTransition(input, actorScope)[0];
@@ -1837,6 +1870,7 @@ function getInitialSnapshot(actorLogic, ...[input]) {
  * console.log(nextSnapshot2.value);
  * // =>'red'
  * ```
+ * @public
  */
 function getNextSnapshot(actorLogic, snapshot, event) {
   const actorScope = createInertActorScope(actorLogic, snapshot);
@@ -2412,6 +2446,7 @@ function getStateNodeByPath(stateNode, statePath) {
  * Returns the state nodes represented by the current state value.
  *
  * @param stateValue The state value or State instance
+ * @public
  */
 function getStateNodes(stateNode, stateValue) {
   if (typeof stateValue === 'string') {
@@ -3705,9 +3740,14 @@ function compactSnapshotRecord(value) {
   }
   return value && Object.keys(value).length ? value : emptySnapshotRecord;
 }
+
+/** @public */
 function isMachineSnapshot(value) {
   return !!value && typeof value === 'object' && 'machine' in value && 'value' in value;
 }
+
+/** @public */
+
 const machineSnapshotMatches = function matches(testValue) {
   return matchesState(testValue, this.value);
 };
@@ -3992,6 +4032,7 @@ function persistContext(contextPart) {
   return copy ?? contextPart;
 }
 
+/** @public */
 function matchesState(parentStateId, childStateId) {
   const parentStateValue = toStateValue(parentStateId);
   const childStateValue = toStateValue(childStateId);
@@ -4013,6 +4054,8 @@ function matchesState(parentStateId, childStateId) {
     return matchesState(parentStateValue[key], childStateValue[key]);
   });
 }
+
+/** @public */
 function checkStateIn(snapshot, stateValue) {
   if (typeof stateValue === 'string' && isStateId(stateValue)) {
     const target = snapshot.machine.getStateNodeById(stateValue);
@@ -4057,6 +4100,8 @@ function toStateValue(stateValue) {
   const statePath = toStatePath(stateValue);
   return pathToStateValue(statePath);
 }
+
+/** @public */
 function pathToStateValue(statePath) {
   if (statePath.length === 1) {
     return statePath[0];
@@ -4159,6 +4204,8 @@ function normalizeTarget(target) {
   }
   return toArray(target);
 }
+
+/** @public */
 function toObserver(nextHandler, errorHandler, completionHandler) {
   const isObserver = typeof nextHandler === 'object';
   const self = isObserver ? nextHandler : undefined;
@@ -4186,6 +4233,8 @@ function resolveReferencedActor(machine, src) {
   // A referenced actor may itself be registered by name.
   return typeof configSrc === 'string' ? machine.sources.actors[configSrc] : configSrc;
 }
+
+/** @experimental */
 function getAllOwnEventDescriptors(snapshot) {
   return [...new Set([...snapshot.nodes.flatMap(sn => sn.ownEvents)])];
 }
@@ -4592,15 +4641,25 @@ function bookSessionId(system) {
  * declared schema), `'internalEvent'` (an internal event type sent from
  * outside its owning actor) or `'stopped'` (the target actor already
  * stopped). Hosts may report additional reasons.
+ *
+ * @public
  */
 
-/** Extra detail attached to a dead letter. */
+/**
+ * Extra detail attached to a dead letter.
+ *
+ * @public
+ */
 
 /**
  * Describes an event that was rejected at the delivery boundary instead of
  * being delivered to its target actor (a dead letter).
+ *
+ * @public
  */
 
+/** @experimental */
+
 /** @internal Every operation of `ActorSystemRuntime`, for runtime wrappers. */
 const RUNTIME_OPERATIONS = ['spawnActor', 'startActor', 'stopActor', 'terminateActor', 'emitEvent', 'scheduleTimer', 'cancelTimer', 'cancelAllTimers', 'deadLetter'
 // `runLogic`, `runStep` and `sendEvent` are deliberately absent: durable
@@ -4613,6 +4672,10 @@ function createScheduledTimerId(actor, id) {
   return `${actor.sessionId}.${id}`;
 }
 
+/** @public */
+
+/** @public */
+
 // These optional lazy fields intentionally have no emitted initializers.
 // oxlint-disable-next-line typescript/no-unsafe-declaration-merging
 
@@ -5048,6 +5111,8 @@ function createActorRef(logic, options) {
  * system-owned internals. It also satisfies the narrower `ActorRef` contract,
  * so consumer APIs should accept `ActorRef` when they only need to send events
  * or read snapshots.
+ *
+ * @public
  */
 class Actor {
   /**
@@ -5958,6 +6023,9 @@ class Actor {
     return this._snapshot;
   }
 }
+
+/** @public */
+
 /**
  * Creates a new actor instance for the given actor logic with the provided
  * options, if any.
@@ -5996,6 +6064,7 @@ class Actor {
  *   {@link createObservableLogic}, {@link createLogic}, and
  *   {@link createAsyncLogic}.
  * @param options - Actor options
+ * @public
  */
 function createActor(logic, options) {
   return new Actor(logic, options);

package/dist/{createActor-5236aa33.esm.js → createActor-7e02bc1f.esm.js}

@@ -333,9 +333,19 @@ function relayMappedToParent(self, system, getEvent) {
   system._relay(self, self._parent, getEvent());
 }
 
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
 /**
  * Creates actor logic for listening to emitted events from another actor. Used
  * internally by `enq.listen()`.
+ *
+ * @public
  */
 function createListenerLogic() {
   return createAttachedLogic(({
@@ -360,11 +370,24 @@ function createListenerLogic() {
 }
 
 // Singleton logic instance
+/** @public */
 const listenerLogic = /* #__PURE__ */createListenerLogic();
 
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
+/** @public */
+
 /**
  * Creates actor logic for subscribing to lifecycle events (done/error/snapshot)
  * from another actor. Used internally by `enq.subscribeTo()`.
+ *
+ * @public
  */
 function createSubscriptionLogic() {
   return createAttachedLogic(({
@@ -402,6 +425,7 @@ function createSubscriptionLogic() {
 }
 
 // Singleton logic instance
+/** @public */
 const subscriptionLogic = /* #__PURE__ */createSubscriptionLogic();
 
 /** Marks the internal lazy scope without imposing structure on custom runtimes. @internal */
@@ -1159,11 +1183,17 @@ function deriveDeferredStarts(effects) {
   }
   return [...attachedStarts, ...childStarts];
 }
+
+/** @public */
 function isBuiltInExecutableAction(action) {
   return action.kind === 'builtin';
 }
 
-/** Executes transition effects sequentially, awaiting each runtime operation. */
+/**
+ * Executes transition effects sequentially, awaiting each runtime operation.
+ *
+ * @public
+ */
 async function executeEffects(effects, runtime) {
   for (const effect of effects) {
     await effect.exec(runtime);
@@ -1789,7 +1819,10 @@ function createInertActorScope(actorLogic, snapshot, sourceSelf, sourceActorScop
   return actorScope;
 }
 
-/** @deprecated Use `initialTransition(…)` instead. */
+/**
+ * @deprecated Use `initialTransition(…)` instead.
+ * @public
+ */
 function getInitialSnapshot(actorLogic, ...[input]) {
   const actorScope = createInertActorScope(actorLogic);
   return actorLogic.initialTransition(input, actorScope)[0];
@@ -1827,6 +1860,7 @@ function getInitialSnapshot(actorLogic, ...[input]) {
  * console.log(nextSnapshot2.value);
  * // =>'red'
  * ```
+ * @public
  */
 function getNextSnapshot(actorLogic, snapshot, event) {
   const actorScope = createInertActorScope(actorLogic, snapshot);
@@ -2392,6 +2426,7 @@ function getStateNodeByPath(stateNode, statePath) {
  * Returns the state nodes represented by the current state value.
  *
  * @param stateValue The state value or State instance
+ * @public
  */
 function getStateNodes(stateNode, stateValue) {
   if (typeof stateValue === 'string') {
@@ -3685,9 +3720,14 @@ function compactSnapshotRecord(value) {
   }
   return value && Object.keys(value).length ? value : emptySnapshotRecord;
 }
+
+/** @public */
 function isMachineSnapshot(value) {
   return !!value && typeof value === 'object' && 'machine' in value && 'value' in value;
 }
+
+/** @public */
+
 const machineSnapshotMatches = function matches(testValue) {
   return matchesState(testValue, this.value);
 };
@@ -3969,6 +4009,7 @@ function persistContext(contextPart) {
   return copy ?? contextPart;
 }
 
+/** @public */
 function matchesState(parentStateId, childStateId) {
   const parentStateValue = toStateValue(parentStateId);
   const childStateValue = toStateValue(childStateId);
@@ -3990,6 +4031,8 @@ function matchesState(parentStateId, childStateId) {
     return matchesState(parentStateValue[key], childStateValue[key]);
   });
 }
+
+/** @public */
 function checkStateIn(snapshot, stateValue) {
   if (typeof stateValue === 'string' && isStateId(stateValue)) {
     const target = snapshot.machine.getStateNodeById(stateValue);
@@ -4034,6 +4077,8 @@ function toStateValue(stateValue) {
   const statePath = toStatePath(stateValue);
   return pathToStateValue(statePath);
 }
+
+/** @public */
 function pathToStateValue(statePath) {
   if (statePath.length === 1) {
     return statePath[0];
@@ -4133,6 +4178,8 @@ function normalizeTarget(target) {
   }
   return toArray(target);
 }
+
+/** @public */
 function toObserver(nextHandler, errorHandler, completionHandler) {
   const isObserver = typeof nextHandler === 'object';
   const self = isObserver ? nextHandler : undefined;
@@ -4160,6 +4207,8 @@ function resolveReferencedActor(machine, src) {
   // A referenced actor may itself be registered by name.
   return typeof configSrc === 'string' ? machine.sources.actors[configSrc] : configSrc;
 }
+
+/** @experimental */
 function getAllOwnEventDescriptors(snapshot) {
   return [...new Set([...snapshot.nodes.flatMap(sn => sn.ownEvents)])];
 }
@@ -4560,15 +4609,25 @@ function bookSessionId(system) {
  * declared schema), `'internalEvent'` (an internal event type sent from
  * outside its owning actor) or `'stopped'` (the target actor already
  * stopped). Hosts may report additional reasons.
+ *
+ * @public
  */
 
-/** Extra detail attached to a dead letter. */
+/**
+ * Extra detail attached to a dead letter.
+ *
+ * @public
+ */
 
 /**
  * Describes an event that was rejected at the delivery boundary instead of
  * being delivered to its target actor (a dead letter).
+ *
+ * @public
  */
 
+/** @experimental */
+
 /** @internal Every operation of `ActorSystemRuntime`, for runtime wrappers. */
 const RUNTIME_OPERATIONS = ['spawnActor', 'startActor', 'stopActor', 'terminateActor', 'emitEvent', 'scheduleTimer', 'cancelTimer', 'cancelAllTimers', 'deadLetter'
 // `runLogic`, `runStep` and `sendEvent` are deliberately absent: durable
@@ -4581,6 +4640,10 @@ function createScheduledTimerId(actor, id) {
   return `${actor.sessionId}.${id}`;
 }
 
+/** @public */
+
+/** @public */
+
 // These optional lazy fields intentionally have no emitted initializers.
 // oxlint-disable-next-line typescript/no-unsafe-declaration-merging
 
@@ -5013,6 +5076,8 @@ function createActorRef(logic, options) {
  * system-owned internals. It also satisfies the narrower `ActorRef` contract,
  * so consumer APIs should accept `ActorRef` when they only need to send events
  * or read snapshots.
+ *
+ * @public
  */
 class Actor {
   /**
@@ -5917,6 +5982,9 @@ class Actor {
     return this._snapshot;
   }
 }
+
+/** @public */
+
 /**
  * Creates a new actor instance for the given actor logic with the provided
  * options, if any.
@@ -5955,6 +6023,7 @@ class Actor {
  *   {@link createObservableLogic}, {@link createLogic}, and
  *   {@link createAsyncLogic}.
  * @param options - Actor options
+ * @public
  */
 function createActor(logic, options) {
   return new Actor(logic, options);