xstate 4.20.0 → 4.23.0

package/es/utils.js

@@ -5,7 +5,6 @@ import { IS_PRODUCTION } from './environment.js';
 function keys(value) {
   return Object.keys(value);
 }
-
 function matchesState(parentStateId, childStateId, delimiter) {
   if (delimiter === void 0) {
     delimiter = STATE_DELIMITER;
@@ -35,7 +34,6 @@ function matchesState(parentStateId, childStateId, delimiter) {
     return matchesState(parentStateValue[key], childStateValue[key]);
   });
 }
-
 function getEventType(event) {
   try {
     return isString(event) || typeof event === 'number' ? "" + event : event.type;
@@ -43,7 +41,6 @@ function getEventType(event) {
     throw new Error('Events must be strings or objects with a string event.type property.');
   }
 }
-
 function toStatePath(stateId, delimiter) {
   try {
     if (isArray(stateId)) {
@@ -55,11 +52,9 @@ function toStatePath(stateId, delimiter) {
     throw new Error("'" + stateId + "' is not a valid state path.");
   }
 }
-
 function isStateLike(state) {
   return typeof state === 'object' && 'value' in state && 'context' in state && 'event' in state && '_event' in state;
 }
-
 function toStateValue(stateValue, delimiter) {
   if (isStateLike(stateValue)) {
     return stateValue.value;
@@ -76,7 +71,6 @@ function toStateValue(stateValue, delimiter) {
   var statePath = toStatePath(stateValue, delimiter);
   return pathToStateValue(statePath);
 }
-
 function pathToStateValue(statePath) {
   if (statePath.length === 1) {
     return statePath[0];
@@ -96,7 +90,6 @@ function pathToStateValue(statePath) {
 
   return value;
 }
-
 function mapValues(collection, iteratee) {
   var result = {};
   var collectionKeys = keys(collection);
@@ -108,7 +101,6 @@ function mapValues(collection, iteratee) {
 
   return result;
 }
-
 function mapFilterValues(collection, iteratee, predicate) {
   var e_1, _a;
 
@@ -144,7 +136,6 @@ function mapFilterValues(collection, iteratee, predicate) {
  * @param props The deep path to the prop of the desired value
  */
 
-
 var path = function (props) {
   return function (object) {
     var e_2, _a;
@@ -176,7 +167,6 @@ var path = function (props) {
  * @param props The deep path to the prop of the desired value
  */
 
-
 function nestedPath(props, accessorProp) {
   return function (object) {
     var e_3, _a;
@@ -203,7 +193,6 @@ function nestedPath(props, accessorProp) {
     return result;
   };
 }
-
 function toStatePaths(stateValue) {
   if (!stateValue) {
     return [[]];
@@ -226,13 +215,11 @@ function toStatePaths(stateValue) {
   }));
   return result;
 }
-
 function flatten(array) {
   var _a;
 
   return (_a = []).concat.apply(_a, __spreadArray([], __read(array)));
 }
-
 function toArrayStrict(value) {
   if (isArray(value)) {
     return value;
@@ -240,7 +227,6 @@ function toArrayStrict(value) {
 
   return [value];
 }
-
 function toArray(value) {
   if (value === undefined) {
     return [];
@@ -248,7 +234,6 @@ function toArray(value) {
 
   return toArrayStrict(value);
 }
-
 function mapContext(mapper, context, _event) {
   var e_5, _a;
 
@@ -283,11 +268,9 @@ function mapContext(mapper, context, _event) {
 
   return result;
 }
-
 function isBuiltInEvent(eventType) {
   return /^(done|error)\./.test(eventType);
 }
-
 function isPromiseLike(value) {
   if (value instanceof Promise) {
     return true;
@@ -300,7 +283,9 @@ function isPromiseLike(value) {
 
   return false;
 }
-
+function isBehavior(value) {
+  return value !== null && typeof value === 'object' && 'transition' in value && typeof value.transition === 'function';
+}
 function partition(items, predicate) {
   var e_6, _a;
 
@@ -332,7 +317,6 @@ function partition(items, predicate) {
 
   return [truthy, falsy];
 }
-
 function updateHistoryStates(hist, stateValue) {
   return mapValues(hist.states, function (subHist, key) {
     if (!subHist) {
@@ -351,14 +335,12 @@ function updateHistoryStates(hist, stateValue) {
     };
   });
 }
-
 function updateHistoryValue(hist, stateValue) {
   return {
     current: stateValue,
     states: updateHistoryStates(hist, stateValue)
   };
 }
-
 function updateContext(context, _event, assignActions, state) {
   if (!IS_PRODUCTION) {
     warn(!!context, 'Attempting to update undefined context');
@@ -402,7 +384,6 @@ function updateContext(context, _event, assignActions, state) {
   return updatedContext;
 } // tslint:disable-next-line:no-empty
 
-
 var warn = function () {};
 
 if (!IS_PRODUCTION) {
@@ -425,16 +406,13 @@ if (!IS_PRODUCTION) {
     }
   };
 }
-
 function isArray(value) {
   return Array.isArray(value);
 } // tslint:disable-next-line:ban-types
 
-
 function isFunction(value) {
   return typeof value === 'function';
 }
-
 function isString(value) {
   return typeof value === 'string';
 } // export function memoizedGetter<T, TP extends { prototype: object }>(
@@ -449,7 +427,6 @@ function isString(value) {
 //   });
 // }
 
-
 function toGuard(condition, guardMap) {
   if (!condition) {
     return undefined;
@@ -473,7 +450,6 @@ function toGuard(condition, guardMap) {
 
   return condition;
 }
-
 function isObservable(value) {
   try {
     return 'subscribe' in value && isFunction(value.subscribe);
@@ -481,11 +457,9 @@ function isObservable(value) {
     return false;
   }
 }
-
 var symbolObservable = /*#__PURE__*/function () {
   return typeof Symbol === 'function' && Symbol.observable || '@@observable';
 }();
-
 function isMachine(value) {
   try {
     return '__xstatenode' in value;
@@ -493,11 +467,9 @@ function isMachine(value) {
     return false;
   }
 }
-
 function isActor(value) {
   return !!value && typeof value.send === 'function';
 }
-
 var uniqueId = /*#__PURE__*/function () {
   var currentId = 0;
   return function () {
@@ -505,7 +477,6 @@ var uniqueId = /*#__PURE__*/function () {
     return currentId.toString(16);
   };
 }();
-
 function toEventObject(event, payload // id?: TEvent['type']
 ) {
   if (isString(event) || typeof event === 'number') {
@@ -516,7 +487,6 @@ function toEventObject(event, payload // id?: TEvent['type']
 
   return event;
 }
-
 function toSCXMLEvent(event, scxmlEvent) {
   if (!isString(event) && '$$type' in event && event.$$type === 'scxml') {
     return event;
@@ -530,7 +500,6 @@ function toSCXMLEvent(event, scxmlEvent) {
     type: 'external'
   }, scxmlEvent);
 }
-
 function toTransitionConfigArray(event, configLike) {
   var transitions = toArrayStrict(configLike).map(function (transitionLike) {
     if (typeof transitionLike === 'undefined' || typeof transitionLike === 'string' || isMachine(transitionLike)) {
@@ -546,7 +515,6 @@ function toTransitionConfigArray(event, configLike) {
   });
   return transitions;
 }
-
 function normalizeTarget(target) {
   if (target === undefined || target === TARGETLESS_KEY) {
     return undefined;
@@ -554,7 +522,6 @@ function normalizeTarget(target) {
 
   return toArray(target);
 }
-
 function reportUnhandledExceptionOnInvocation(originalError, currentError, id) {
   if (!IS_PRODUCTION) {
     var originalStackTrace = originalError.stack ? " Stacktrace was '" + originalError.stack + "'" : '';
@@ -569,7 +536,6 @@ function reportUnhandledExceptionOnInvocation(originalError, currentError, id) {
     }
   }
 }
-
 function evaluateGuard(machine, guard, context, _event, state) {
   var guards = machine.options.guards;
   var guardMeta = {
@@ -590,7 +556,6 @@ function evaluateGuard(machine, guard, context, _event, state) {
 
   return condFn(context, _event.data, guardMeta);
 }
-
 function toInvokeSource(src) {
   if (typeof src === 'string') {
     return {
@@ -600,7 +565,6 @@ function toInvokeSource(src) {
 
   return src;
 }
-
 function toObserver(nextHandler, errorHandler, completionHandler) {
   if (typeof nextHandler === 'object') {
     return nextHandler;
@@ -617,4 +581,4 @@ function toObserver(nextHandler, errorHandler, completionHandler) {
   };
 }
 
-export { evaluateGuard, flatten, getEventType, isActor, isArray, isBuiltInEvent, isFunction, isMachine, isObservable, isPromiseLike, isStateLike, isString, keys, mapContext, mapFilterValues, mapValues, matchesState, nestedPath, normalizeTarget, partition, path, pathToStateValue, reportUnhandledExceptionOnInvocation, symbolObservable, toArray, toArrayStrict, toEventObject, toGuard, toInvokeSource, toObserver, toSCXMLEvent, toStatePath, toStatePaths, toStateValue, toTransitionConfigArray, uniqueId, updateContext, updateHistoryStates, updateHistoryValue, warn };
+export { evaluateGuard, flatten, getEventType, isActor, isArray, isBehavior, isBuiltInEvent, isFunction, isMachine, isObservable, isPromiseLike, isStateLike, isString, keys, mapContext, mapFilterValues, mapValues, matchesState, nestedPath, normalizeTarget, partition, path, pathToStateValue, reportUnhandledExceptionOnInvocation, symbolObservable, toArray, toArrayStrict, toEventObject, toGuard, toInvokeSource, toObserver, toSCXMLEvent, toStatePath, toStatePaths, toStateValue, toTransitionConfigArray, uniqueId, updateContext, updateHistoryStates, updateHistoryValue, warn };

package/lib/Actor.d.ts

@@ -1,25 +1,26 @@
-import { EventObject, Subscribable, InvokeDefinition, AnyEventObject, StateMachine, Spawnable, SCXML } from './types';
-import { ActorRef, SpawnedActorRef } from '.';
-export interface Actor<TContext = any, TEvent extends EventObject = AnyEventObject> extends Subscribable<TContext> {
-    id: string;
-    send: (event: TEvent) => any;
-    stop?: () => any | undefined;
-    toJSON: () => {
-        id: string;
-    };
-    meta?: InvokeDefinition<TContext, TEvent>;
-    state?: any;
-    deferred?: boolean;
-}
-export declare function createNullActor(id: string): SpawnedActorRef<any>;
-/**
- * Creates a deferred actor that is able to be invoked given the provided
- * invocation information in its `.meta` value.
- *
- * @param invokeDefinition The meta information needed to invoke the actor.
- */
-export declare function createInvocableActor<TC, TE extends EventObject>(invokeDefinition: InvokeDefinition<TC, TE>, machine: StateMachine<TC, any, TE, any>, context: TC, _event: SCXML.Event<TE>): SpawnedActorRef<any>;
-export declare function createDeferredActor(entity: Spawnable, id: string, data?: any): SpawnedActorRef<any, undefined>;
-export declare function isActor(item: any): item is ActorRef<any>;
-export declare function isSpawnedActor(item: any): item is SpawnedActorRef<any>;
+import { EventObject, Subscribable, InvokeDefinition, AnyEventObject, StateMachine, Spawnable, SCXML } from './types';
+import { ActorRef, BaseActorRef } from '.';
+export interface Actor<TContext = any, TEvent extends EventObject = AnyEventObject> extends Subscribable<TContext> {
+    id: string;
+    send: (event: TEvent) => any;
+    stop?: () => any | undefined;
+    toJSON: () => {
+        id: string;
+    };
+    meta?: InvokeDefinition<TContext, TEvent>;
+    state?: any;
+    deferred?: boolean;
+}
+export declare function createNullActor(id: string): ActorRef<any>;
+/**
+ * Creates a deferred actor that is able to be invoked given the provided
+ * invocation information in its `.meta` value.
+ *
+ * @param invokeDefinition The meta information needed to invoke the actor.
+ */
+export declare function createInvocableActor<TC, TE extends EventObject>(invokeDefinition: InvokeDefinition<TC, TE>, machine: StateMachine<TC, any, TE, any>, context: TC, _event: SCXML.Event<TE>): ActorRef<any>;
+export declare function createDeferredActor(entity: Spawnable, id: string, data?: any): ActorRef<any, undefined>;
+export declare function isActor(item: any): item is ActorRef<any>;
+export declare function isSpawnedActor(item: any): item is ActorRef<any>;
+export declare function toActorRef<TEvent extends EventObject, TEmitted = any, TActorRefLike extends BaseActorRef<TEvent> = BaseActorRef<TEvent>>(actorRefLike: TActorRefLike): ActorRef<TEvent, TEmitted>;
 //# sourceMappingURL=Actor.d.ts.map

package/lib/Actor.js

@@ -1,65 +1,99 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSpawnedActor = exports.isActor = exports.createDeferredActor = exports.createInvocableActor = exports.createNullActor = void 0;
-var utils_1 = require("./utils");
-var serviceScope = require("./serviceScope");
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('./_virtual/_tslib.js');
+var utils = require('./utils.js');
+var serviceScope = require('./serviceScope.js');
+
 function createNullActor(id) {
-    return {
-        id: id,
-        send: function () { return void 0; },
-        subscribe: function () { return ({
-            unsubscribe: function () { return void 0; }
-        }); },
-        getSnapshot: function () { return undefined; },
-        toJSON: function () { return ({
-            id: id
-        }); }
-    };
+  return {
+    id: id,
+    send: function () {
+      return void 0;
+    },
+    subscribe: function () {
+      return {
+        unsubscribe: function () {
+          return void 0;
+        }
+      };
+    },
+    getSnapshot: function () {
+      return undefined;
+    },
+    toJSON: function () {
+      return {
+        id: id
+      };
+    }
+  };
 }
-exports.createNullActor = createNullActor;
-/**
- * Creates a deferred actor that is able to be invoked given the provided
- * invocation information in its `.meta` value.
- *
- * @param invokeDefinition The meta information needed to invoke the actor.
+/**
+ * Creates a deferred actor that is able to be invoked given the provided
+ * invocation information in its `.meta` value.
+ *
+ * @param invokeDefinition The meta information needed to invoke the actor.
  */
+
 function createInvocableActor(invokeDefinition, machine, context, _event) {
-    var _a;
-    var invokeSrc = utils_1.toInvokeSource(invokeDefinition.src);
-    var serviceCreator = (_a = machine === null || machine === void 0 ? void 0 : machine.options.services) === null || _a === void 0 ? void 0 : _a[invokeSrc.type];
-    var resolvedData = invokeDefinition.data
-        ? utils_1.mapContext(invokeDefinition.data, context, _event)
-        : undefined;
-    var tempActor = serviceCreator
-        ? createDeferredActor(serviceCreator, invokeDefinition.id, resolvedData)
-        : createNullActor(invokeDefinition.id);
-    // @ts-ignore
-    tempActor.meta = invokeDefinition;
-    return tempActor;
+  var _a;
+
+  var invokeSrc = utils.toInvokeSource(invokeDefinition.src);
+  var serviceCreator = (_a = machine === null || machine === void 0 ? void 0 : machine.options.services) === null || _a === void 0 ? void 0 : _a[invokeSrc.type];
+  var resolvedData = invokeDefinition.data ? utils.mapContext(invokeDefinition.data, context, _event) : undefined;
+  var tempActor = serviceCreator ? createDeferredActor(serviceCreator, invokeDefinition.id, resolvedData) : createNullActor(invokeDefinition.id); // @ts-ignore
+
+  tempActor.meta = invokeDefinition;
+  return tempActor;
 }
-exports.createInvocableActor = createInvocableActor;
 function createDeferredActor(entity, id, data) {
-    var tempActor = createNullActor(id);
-    // @ts-ignore
-    tempActor.deferred = true;
-    if (utils_1.isMachine(entity)) {
-        // "mute" the existing service scope so potential spawned actors within the `.initialState` stay deferred here
-        // @ts-ignore
-        tempActor.state = serviceScope.provide(undefined, function () { return (data ? entity.withContext(data) : entity).initialState; });
-    }
-    return tempActor;
+  var tempActor = createNullActor(id); // @ts-ignore
+
+  tempActor.deferred = true;
+
+  if (utils.isMachine(entity)) {
+    // "mute" the existing service scope so potential spawned actors within the `.initialState` stay deferred here
+    var initialState_1 = tempActor.state = serviceScope.provide(undefined, function () {
+      return (data ? entity.withContext(data) : entity).initialState;
+    });
+
+    tempActor.getSnapshot = function () {
+      return initialState_1;
+    };
+  }
+
+  return tempActor;
 }
-exports.createDeferredActor = createDeferredActor;
 function isActor(item) {
-    try {
-        return typeof item.send === 'function';
-    }
-    catch (e) {
-        return false;
-    }
+  try {
+    return typeof item.send === 'function';
+  } catch (e) {
+    return false;
+  }
 }
-exports.isActor = isActor;
 function isSpawnedActor(item) {
-    return isActor(item) && 'id' in item;
+  return isActor(item) && 'id' in item;
+}
+function toActorRef(actorRefLike) {
+  return _tslib.__assign({
+    subscribe: function () {
+      return {
+        unsubscribe: function () {
+          return void 0;
+        }
+      };
+    },
+    id: 'anonymous',
+    getSnapshot: function () {
+      return undefined;
+    }
+  }, actorRefLike);
 }
+
+exports.createDeferredActor = createDeferredActor;
+exports.createInvocableActor = createInvocableActor;
+exports.createNullActor = createNullActor;
+exports.isActor = isActor;
 exports.isSpawnedActor = isSpawnedActor;
+exports.toActorRef = toActorRef;

package/lib/Machine.d.ts

@@ -1,13 +1,18 @@
-import { StateMachine, MachineOptions, DefaultContext, MachineConfig, StateSchema, EventObject, AnyEventObject, Typestate } from './types';
-import { Model, ModelContextFrom, ModelEventsFrom } from './model';
-export declare function Machine<TContext = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, initialContext?: TContext): StateMachine<TContext, any, TEvent>;
-export declare function Machine<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, TStateSchema, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, initialContext?: TContext): StateMachine<TContext, TStateSchema, TEvent>;
-export declare function createMachine<TModel extends Model<any, any, any>, TContext = ModelContextFrom<TModel>, TEvent extends EventObject = ModelEventsFrom<TModel>, TTypestate extends Typestate<TContext> = {
-    value: any;
-    context: TContext;
-}>(config: MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>): StateMachine<TContext, any, TEvent, TTypestate>;
-export declare function createMachine<TContext, TEvent extends EventObject = AnyEventObject, TTypestate extends Typestate<TContext> = {
-    value: any;
-    context: TContext;
-}>(config: MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>): StateMachine<TContext, any, TEvent, TTypestate>;
+import { StateMachine, MachineOptions, DefaultContext, MachineConfig, StateSchema, EventObject, AnyEventObject, Typestate, EventFrom } from './types';
+import { Model, ModelContextFrom } from './model.types';
+/**
+ * @deprecated Use `createMachine(...)` instead.
+ */
+export declare function Machine<TContext = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, initialContext?: TContext): StateMachine<TContext, any, TEvent>;
+export declare function Machine<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = AnyEventObject>(config: MachineConfig<TContext, TStateSchema, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>, initialContext?: TContext): StateMachine<TContext, TStateSchema, TEvent>;
+export declare function createMachine<TModel extends Model<any, any, any>, TContext = ModelContextFrom<TModel>, TEvent extends EventObject = EventFrom<TModel>, TTypestate extends Typestate<TContext> = {
+    value: any;
+    context: TContext;
+}>(config: MachineConfig<TContext, any, TEvent> & {
+    context: TContext;
+}, options?: Partial<MachineOptions<TContext, TEvent>>): StateMachine<TContext, any, TEvent, TTypestate>;
+export declare function createMachine<TContext, TEvent extends EventObject = AnyEventObject, TTypestate extends Typestate<TContext> = {
+    value: any;
+    context: TContext;
+}>(config: TContext extends Model<any, any, any> ? never : MachineConfig<TContext, any, TEvent>, options?: Partial<MachineOptions<TContext, TEvent>>): StateMachine<TContext, any, TEvent, TTypestate>;
 //# sourceMappingURL=Machine.d.ts.map

package/lib/Machine.js

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMachine = exports.Machine = void 0;
-var StateNode_1 = require("./StateNode");
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var StateNode = require('./StateNode.js');
+
 function Machine(config, options, initialContext) {
-    if (initialContext === void 0) { initialContext = config.context; }
-    var resolvedInitialContext = typeof initialContext === 'function'
-        ? initialContext()
-        : initialContext;
-    return new StateNode_1.StateNode(config, options, resolvedInitialContext);
+  if (initialContext === void 0) {
+    initialContext = config.context;
+  }
+
+  return new StateNode.StateNode(config, options, initialContext);
 }
-exports.Machine = Machine;
 function createMachine(config, options) {
-    var resolvedInitialContext = typeof config.context === 'function'
-        ? config.context()
-        : config.context;
-    return new StateNode_1.StateNode(config, options, resolvedInitialContext);
+  return new StateNode.StateNode(config, options);
 }
+
+exports.Machine = Machine;
 exports.createMachine = createMachine;

package/lib/SimulatedClock.d.ts

@@ -1,17 +1,17 @@
-import { Clock } from './interpreter';
-export interface SimulatedClock extends Clock {
-    start(speed: number): void;
-    increment(ms: number): void;
-    set(ms: number): void;
-}
-export declare class SimulatedClock implements SimulatedClock {
-    private timeouts;
-    private _now;
-    private _id;
-    now(): number;
-    private getId;
-    setTimeout(fn: (...args: any[]) => void, timeout: number): number;
-    clearTimeout(id: number): void;
-    private flushTimeouts;
-}
+import { Clock } from './interpreter';
+export interface SimulatedClock extends Clock {
+    start(speed: number): void;
+    increment(ms: number): void;
+    set(ms: number): void;
+}
+export declare class SimulatedClock implements SimulatedClock {
+    private timeouts;
+    private _now;
+    private _id;
+    now(): number;
+    private getId;
+    setTimeout(fn: (...args: any[]) => void, timeout: number): number;
+    clearTimeout(id: number): void;
+    private flushTimeouts;
+}
 //# sourceMappingURL=SimulatedClock.d.ts.map