xstate 4.30.0 → 4.30.3

package/lib/types.d.ts

@@ -22,6 +22,8 @@ export declare type IndexByType<T extends {
 export declare type Equals<A1 extends any, A2 extends any> = (<A>() => A extends A2 ? true : false) extends <A>() => A extends A1 ? true : false ? true : false;
 export declare type IsAny<T> = Equals<T, any>;
 export declare type Cast<A, B> = A extends B ? A : B;
+export declare type NoInfer<T> = [T][T extends any ? 0 : any];
+export declare type LowInfer<T> = T & {};
 export declare type EventType = string;
 export declare type ActionType = string;
 export declare type MetaObject = Record<string, any>;
@@ -90,7 +92,7 @@ export declare type SimpleEventsOf<TEvent extends EventObject> = ExtractWithSimp
 export declare type BaseAction<TContext, TEvent extends EventObject, TAction extends BaseActionObject> = SimpleActionsOf<TAction>['type'] | TAction | RaiseAction<any> | SendAction<TContext, TEvent, any> | AssignAction<TContext, TEvent> | LogAction<TContext, TEvent> | CancelAction | StopAction<TContext, TEvent> | ChooseAction<TContext, TEvent> | ActionFunction<TContext, TEvent>;
 export declare type BaseActions<TContext, TEvent extends EventObject, TAction extends BaseActionObject> = SingleOrArray<BaseAction<TContext, TEvent, TAction>>;
 export declare type Actions<TContext, TEvent extends EventObject> = SingleOrArray<Action<TContext, TEvent>>;
-export declare type StateKey = string | State<any>;
+export declare type StateKey = string | AnyState;
 export interface StateValueMap {
     [key: string]: StateValue;
 }
@@ -268,7 +270,7 @@ export interface InvokeConfig<TContext, TEvent extends EventObject> {
     /**
      * The source of the machine to be invoked, or the machine itself.
      */
-    src: string | InvokeSourceDefinition | StateMachine<any, any, any> | InvokeCreator<TContext, TEvent, any>;
+    src: string | InvokeSourceDefinition | AnyStateMachine | InvokeCreator<TContext, TEvent, any>;
     /**
      * If `true`, events sent to the parent service will be forwarded to the invoked service.
      *
@@ -338,7 +340,7 @@ export interface StateNodeConfig<TContext, TStateSchema extends StateSchema, TEv
     /**
      * The services to invoke upon entering this state node. These services will be stopped upon exiting this state node.
      */
-    invoke?: SingleOrArray<InvokeConfig<TContext, TEvent> | StateMachine<any, any, any>>;
+    invoke?: SingleOrArray<InvokeConfig<TContext, TEvent> | AnyStateMachine>;
     /**
      * The mapping of event types to their potential transition(s).
      */
@@ -458,6 +460,8 @@ export interface StateNodeDefinition<TContext, TStateSchema extends StateSchema,
     tags: string[];
 }
 export declare type AnyStateNodeDefinition = StateNodeDefinition<any, any, any>;
+export declare type AnyState = State<any, any, any, any, any>;
+export declare type AnyStateMachine = StateMachine<any, any, any, any, any, any, any>;
 export interface AtomicStateNodeConfig<TContext, TEvent extends EventObject> extends StateNodeConfig<TContext, StateSchema, TEvent> {
     initial?: undefined;
     parallel?: false | undefined;
@@ -483,7 +487,7 @@ export declare type ActionFunctionMap<TContext, TEvent extends EventObject, TAct
     } ? TAction : never>;
 };
 export declare type DelayFunctionMap<TContext, TEvent extends EventObject> = Record<string, DelayConfig<TContext, TEvent>>;
-export declare type ServiceConfig<TContext, TEvent extends EventObject = AnyEventObject> = string | StateMachine<any, any, any> | InvokeCreator<TContext, TEvent>;
+export declare type ServiceConfig<TContext, TEvent extends EventObject = AnyEventObject> = string | AnyStateMachine | InvokeCreator<TContext, TEvent>;
 export declare type DelayConfig<TContext, TEvent extends EventObject> = number | DelayExpr<TContext, TEvent>;
 declare type MachineOptionsActions<TContext, TResolvedTypesMeta, TEventsCausingActions = Prop<TResolvedTypesMeta, 'eventsCausingActions'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TIndexedActions = Prop<TResolvedTypesMeta, 'indexedActions'>> = {
     [K in keyof TEventsCausingActions]?: ActionObject<TContext, Cast<Prop<TIndexedEvents, TEventsCausingActions[K]>, EventObject>> | ActionFunction<TContext, Cast<Prop<TIndexedEvents, TEventsCausingActions[K]>, EventObject>, Cast<Prop<TIndexedActions, K>, BaseActionObject>>;
@@ -495,7 +499,7 @@ declare type MachineOptionsGuards<TContext, TResolvedTypesMeta, TEventsCausingGu
     [K in keyof TEventsCausingGuards]?: ConditionPredicate<TContext, Cast<Prop<TIndexedEvents, TEventsCausingGuards[K]>, EventObject>>;
 };
 declare type MachineOptionsServices<TContext, TResolvedTypesMeta, TEventsCausingServices = Prop<TResolvedTypesMeta, 'eventsCausingServices'>, TIndexedEvents = Prop<TResolvedTypesMeta, 'indexedEvents'>, TInvokeSrcNameMap = Prop<TResolvedTypesMeta, 'invokeSrcNameMap'>> = {
-    [K in keyof TEventsCausingServices]?: StateMachine<any, any, any, any, any, any, any> | InvokeCreator<TContext, Cast<Prop<TIndexedEvents, TEventsCausingServices[K]>, EventObject>, Prop<Prop<TIndexedEvents, Prop<TInvokeSrcNameMap, K>>, 'data'>, EventObject, Cast<TIndexedEvents[keyof TIndexedEvents], EventObject>>;
+    [K in keyof TEventsCausingServices]?: AnyStateMachine | InvokeCreator<TContext, Cast<Prop<TIndexedEvents, TEventsCausingServices[K]>, EventObject>, Prop<Prop<TIndexedEvents, Prop<TInvokeSrcNameMap, K>>, 'data'>, EventObject, Cast<TIndexedEvents[keyof TIndexedEvents], EventObject>>;
 };
 declare type MakeKeysRequired<T extends string> = {
     [K in T]: unknown;
@@ -522,11 +526,11 @@ export declare type InternalMachineOptions<TContext, TEvent extends EventObject,
     activities?: Record<string, ActivityConfig<TContext, TEvent>>;
 };
 export declare type MachineOptions<TContext, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TTypesMeta extends TypegenConstraint = TypegenDisabled> = InternalMachineOptions<TContext, TEvent, ResolveTypegenMeta<TTypesMeta, TEvent, TAction, TServiceMap>>;
-export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TTypesMeta = TypegenDisabled> extends StateNodeConfig<TContext, TStateSchema, TEvent, TAction> {
+export interface MachineConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TTypesMeta = TypegenDisabled> extends StateNodeConfig<NoInfer<TContext>, TStateSchema, TEvent, TAction> {
     /**
      * The initial context (extended state)
      */
-    context?: TContext | (() => TContext);
+    context?: LowInfer<TContext | (() => TContext)>;
     /**
      * The machine's own version.
      */
@@ -568,7 +572,7 @@ export interface HistoryStateNode<TContext> extends StateNode<TContext> {
 export interface StateMachine<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TTypestate extends Typestate<TContext> = {
     value: any;
     context: TContext;
-}, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TResolvedTypesMeta = TypegenDisabled> extends StateNode<TContext, TStateSchema, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta> {
+}, TAction extends BaseActionObject = BaseActionObject, TServiceMap extends ServiceMap = ServiceMap, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, TEvent, TAction, TServiceMap>> extends StateNode<TContext, TStateSchema, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta> {
     id: string;
     states: StateNode<TContext, TStateSchema, TEvent, TTypestate, TServiceMap, TResolvedTypesMeta>['states'];
     withConfig(options: InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, true>, context?: TContext | (() => TContext)): StateMachine<TContext, TStateSchema, TEvent, TTypestate, TAction, TServiceMap, AreAllImplementationsAssumedToBeProvided<TResolvedTypesMeta> extends false ? MarkAllImplementationsAsProvided<TResolvedTypesMeta> : TResolvedTypesMeta>;
@@ -588,7 +592,7 @@ export interface StateMachine<TContext, TStateSchema extends StateSchema, TEvent
     /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
     __TResolvedTypesMeta: TResolvedTypesMeta;
 }
-export declare type StateFrom<T extends StateMachine<any, any, any, any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any, any, any, any>)> = T extends StateMachine<any, any, any, any, any, any, any> ? ReturnType<T['transition']> : T extends (...args: any[]) => StateMachine<any, any, any, any, any, any, any> ? ReturnType<ReturnType<T>['transition']> : never;
+export declare type StateFrom<T extends AnyStateMachine | ((...args: any[]) => AnyStateMachine)> = T extends AnyStateMachine ? ReturnType<T['transition']> : T extends (...args: any[]) => AnyStateMachine ? ReturnType<ReturnType<T>['transition']> : never;
 export interface ActionMap<TContext, TEvent extends EventObject> {
     onEntry: Array<Action<TContext, TEvent>>;
     actions: Array<Action<TContext, TEvent>>;
@@ -668,7 +672,7 @@ export interface DoneEventObject extends EventObject {
 }
 export interface UpdateObject extends EventObject {
     id: string | number;
-    state: State<any, any>;
+    state: AnyState;
 }
 export declare type DoneEvent = DoneEventObject & string;
 export interface NullEvent {
@@ -868,6 +872,7 @@ export interface StateConfig<TContext, TEvent extends EventObject> {
     tags?: Set<string>;
     machine?: StateMachine<TContext, any, TEvent, any, any, any, any>;
 }
+export declare type AnyStateConfig = StateConfig<any, AnyEventObject>;
 export interface StateSchema<TC = any> {
     meta?: any;
     context?: Partial<TC>;
@@ -973,13 +978,16 @@ export interface Subscription {
     unsubscribe(): void;
 }
 export interface InteropObservable<T> {
-    [Symbol.observable]: () => Subscribable<T>;
+    [Symbol.observable]: () => InteropSubscribable<T>;
 }
-export interface Subscribable<T> {
-    subscribe(next: (value: T) => void, error?: (error: any) => void, complete?: () => void): Subscription;
+export interface InteropSubscribable<T> {
+    subscribe(observer: Observer<T>): Subscription;
+}
+export interface Subscribable<T> extends InteropSubscribable<T> {
     subscribe(observer: Observer<T>): Subscription;
+    subscribe(next: (value: T) => void, error?: (error: any) => void, complete?: () => void): Subscription;
 }
-export declare type Spawnable = StateMachine<any, any, any> | PromiseLike<any> | InvokeCallback | InteropObservable<any> | Subscribable<any> | Behavior<any>;
+export declare type Spawnable = AnyStateMachine | PromiseLike<any> | InvokeCallback | InteropObservable<any> | Subscribable<any> | Behavior<any>;
 export declare type ExtractEvent<TEvent extends EventObject, TEventType extends TEvent['type']> = TEvent extends {
     type: TEventType;
 } ? TEvent : never;
@@ -1003,10 +1011,10 @@ export declare type ActorRefWithDeprecatedState<TContext, TEvent extends EventOb
      */
     state: State<TContext, TEvent, any, TTypestate, TResolvedTypesMeta>;
 };
-export declare type ActorRefFrom<T> = T extends StateMachine<infer TContext, any, infer TEvent, infer TTypestate, any, any, any> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate> : T extends (...args: any[]) => StateMachine<infer TContext, any, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate, TResolvedTypesMeta> : T extends Promise<infer U> ? ActorRef<never, U> : T extends Behavior<infer TEvent1, infer TEmitted> ? ActorRef<TEvent1, TEmitted> : T extends (...args: any[]) => Behavior<infer TEvent1, infer TEmitted> ? ActorRef<TEvent1, TEmitted> : never;
+export declare type ActorRefFrom<T> = ReturnTypeOrValue<T> extends infer R ? R extends StateMachine<infer TContext, any, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? ActorRefWithDeprecatedState<TContext, TEvent, TTypestate, TResolvedTypesMeta> : R extends Promise<infer U> ? ActorRef<never, U> : R extends Behavior<infer TEvent, infer TEmitted> ? ActorRef<TEvent, TEmitted> : never : never;
 export declare type AnyInterpreter = Interpreter<any, any, any, any, any>;
-export declare type InterpreterFrom<T extends StateMachine<any, any, any, any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any, any, any, any>)> = T extends StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> : T extends (...args: any[]) => StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> : never;
-export declare type MachineOptionsFrom<T extends StateMachine<any, any, any, any, any, any, any> | ((...args: any[]) => StateMachine<any, any, any, any, any, any, any>), TRequireMissingImplementations extends boolean = false> = ReturnTypeOrValue<T> extends StateMachine<infer TContext, any, infer TEvent, any, any, any, infer TResolvedTypesMeta> ? InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, TRequireMissingImplementations> : never;
+export declare type InterpreterFrom<T extends AnyStateMachine | ((...args: any[]) => AnyStateMachine)> = T extends StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> : T extends (...args: any[]) => StateMachine<infer TContext, infer TStateSchema, infer TEvent, infer TTypestate, any, any, infer TResolvedTypesMeta> ? Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta> : never;
+export declare type MachineOptionsFrom<T extends AnyStateMachine | ((...args: any[]) => AnyStateMachine), TRequireMissingImplementations extends boolean = false> = ReturnTypeOrValue<T> extends StateMachine<infer TContext, any, infer TEvent, any, any, any, infer TResolvedTypesMeta> ? InternalMachineOptions<TContext, TEvent, TResolvedTypesMeta, TRequireMissingImplementations> : never;
 export declare type __ResolvedTypesMetaFrom<T> = T extends StateMachine<any, any, any, any, any, any, infer TResolvedTypesMeta> ? TResolvedTypesMeta : never;
 export interface ActorContext<TEvent extends EventObject, TEmitted> {
     parent?: ActorRef<any, any>;

package/lib/utils.d.ts

@@ -1,8 +1,8 @@
-import { Event, StateValue, ActionType, Action, EventObject, PropertyMapper, Mapper, EventType, HistoryValue, AssignAction, Condition, Subscribable, StateMachine, ConditionPredicate, SCXML, StateLike, EventData, TransitionConfig, TransitionConfigTarget, NullEvent, SingleOrArray, Guard, InvokeSourceDefinition, Observer, Behavior } from './types';
+import { Event, StateValue, ActionType, Action, EventObject, PropertyMapper, Mapper, EventType, HistoryValue, AssignAction, Condition, Subscribable, ConditionPredicate, SCXML, StateLike, EventData, TransitionConfig, TransitionConfigTarget, NullEvent, SingleOrArray, Guard, InvokeSourceDefinition, Observer, Behavior } from './types';
 import { StateNode } from './StateNode';
 import { State } from './State';
 import { Actor } from './Actor';
-export declare function keys<T extends object>(value: T): Array<keyof T & string>;
+import { AnyStateMachine } from '.';
 export declare function matchesState(parentStateId: StateValue, childStateId: StateValue, delimiter?: string): boolean;
 export declare function getEventType<TEvent extends EventObject = EventObject>(event: Event<TEvent>): TEvent['type'];
 export declare function getActionType(action: Action<any, any>): ActionType;
@@ -10,9 +10,7 @@ export declare function toStatePath(stateId: string | string[], delimiter: strin
 export declare function isStateLike(state: any): state is StateLike<any>;
 export declare function toStateValue(stateValue: StateLike<any> | StateValue | string[], delimiter: string): StateValue;
 export declare function pathToStateValue(statePath: string[]): StateValue;
-export declare function mapValues<T, P, O extends {
-    [key: string]: T;
-}>(collection: O, iteratee: (item: O[keyof O], key: keyof O, collection: O, i: number) => P): {
+export declare function mapValues<P, O extends Record<string, unknown>>(collection: O, iteratee: (item: O[keyof O], key: keyof O, collection: O, i: number) => P): {
     [key in keyof O]: P;
 };
 export declare function mapFilterValues<T, P>(collection: {
@@ -52,12 +50,11 @@ export declare function isFunction(value: any): value is Function;
 export declare function isString(value: any): value is string;
 export declare function toGuard<TContext, TEvent extends EventObject>(condition?: Condition<TContext, TEvent>, guardMap?: Record<string, ConditionPredicate<TContext, TEvent>>): Guard<TContext, TEvent> | undefined;
 export declare function isObservable<T>(value: any): value is Subscribable<T>;
-export declare const symbolObservable: string | typeof Symbol.observable;
+export declare const symbolObservable: typeof Symbol.observable;
 export declare const interopSymbols: {
-    [x: string]: () => any;
     [Symbol.observable]: () => any;
 };
-export declare function isMachine(value: any): value is StateMachine<any, any, any>;
+export declare function isMachine(value: any): value is AnyStateMachine;
 export declare function isActor(value: any): value is Actor;
 export declare const uniqueId: () => string;
 export declare function toEventObject<TEvent extends EventObject>(event: Event<TEvent>, payload?: EventData): TEvent;

package/lib/utils.js

@@ -7,9 +7,6 @@ var constants = require('./constants.js');
 var environment = require('./environment.js');
 
 var _a;
-function keys(value) {
-  return Object.keys(value);
-}
 function matchesState(parentStateId, childStateId, delimiter) {
   if (delimiter === void 0) {
     delimiter = constants.STATE_DELIMITER;
@@ -31,7 +28,7 @@ function matchesState(parentStateId, childStateId, delimiter) {
     return parentStateValue in childStateValue;
   }
 
-  return keys(parentStateValue).every(function (key) {
+  return Object.keys(parentStateValue).every(function (key) {
     if (!(key in childStateValue)) {
       return false;
     }
@@ -97,7 +94,7 @@ function pathToStateValue(statePath) {
 }
 function mapValues(collection, iteratee) {
   var result = {};
-  var collectionKeys = keys(collection);
+  var collectionKeys = Object.keys(collection);
 
   for (var i = 0; i < collectionKeys.length; i++) {
     var key = collectionKeys[i];
@@ -112,7 +109,7 @@ function mapFilterValues(collection, iteratee, predicate) {
   var result = {};
 
   try {
-    for (var _b = _tslib.__values(keys(collection)), _c = _b.next(); !_c.done; _c = _b.next()) {
+    for (var _b = _tslib.__values(Object.keys(collection)), _c = _b.next(); !_c.done; _c = _b.next()) {
       var key = _c.value;
       var item = collection[key];
 
@@ -207,7 +204,7 @@ function toStatePaths(stateValue) {
     return [[stateValue]];
   }
 
-  var result = flatten(keys(stateValue).map(function (key) {
+  var result = flatten(Object.keys(stateValue).map(function (key) {
     var subStateValue = stateValue[key];
 
     if (typeof subStateValue !== 'string' && (!subStateValue || !Object.keys(subStateValue).length)) {
@@ -366,7 +363,7 @@ function updateContext(context, _event, assignActions, state) {
       partialUpdate = assignment(acc, _event.data, meta);
     } else {
       try {
-        for (var _b = _tslib.__values(keys(assignment)), _c = _b.next(); !_c.done; _c = _b.next()) {
+        for (var _b = _tslib.__values(Object.keys(assignment)), _c = _b.next(); !_c.done; _c = _b.next()) {
           var key = _c.value;
           var propAssignment = assignment[key];
           partialUpdate[key] = isFunction(propAssignment) ? propAssignment(acc, _event.data, meta) : propAssignment;
@@ -420,18 +417,7 @@ function isFunction(value) {
 }
 function isString(value) {
   return typeof value === 'string';
-} // export function memoizedGetter<T, TP extends { prototype: object }>(
-//   o: TP,
-//   property: string,
-//   getter: () => T
-// ): void {
-//   Object.defineProperty(o.prototype, property, {
-//     get: getter,
-//     enumerable: false,
-//     configurable: false
-//   });
-// }
-
+}
 function toGuard(condition, guardMap) {
   if (!condition) {
     return undefined;
@@ -464,16 +450,15 @@ function isObservable(value) {
 }
 var symbolObservable = /*#__PURE__*/function () {
   return typeof Symbol === 'function' && Symbol.observable || '@@observable';
-}();
+}(); // TODO: to be removed in v5, left it out just to minimize the scope of the change and maintain compatibility with older versions of integration paackages
+
 var interopSymbols = (_a = {}, _a[symbolObservable] = function () {
   return this;
+}, _a[Symbol.observable] = function () {
+  return this;
 }, _a);
 function isMachine(value) {
-  try {
-    return '__xstatenode' in value;
-  } catch (e) {
-    return false;
-  }
+  return !!value && '__xstatenode' in value;
 }
 function isActor(value) {
   return !!value && typeof value.send === 'function';
@@ -607,7 +592,6 @@ exports.isObservable = isObservable;
 exports.isPromiseLike = isPromiseLike;
 exports.isStateLike = isStateLike;
 exports.isString = isString;
-exports.keys = keys;
 exports.mapContext = mapContext;
 exports.mapFilterValues = mapFilterValues;
 exports.mapValues = mapValues;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xstate",
-  "version": "4.30.0",
+  "version": "4.30.3",
   "description": "Finite State Machines and Statecharts for the Modern Web.",
   "main": "lib/index.js",
   "module": "es/index.js",