xstate 4.13.0 → 4.15.1

package/lib/types.d.ts

@@ -1,7 +1,6 @@
 import { StateNode } from './StateNode';
 import { State } from './State';
 import { Interpreter, Clock } from './interpreter';
-import { Actor } from './Actor';
 export declare type EventType = string;
 export declare type ActionType = string;
 export declare type MetaObject = Record<string, any>;
@@ -116,6 +115,24 @@ export interface ActivityDefinition<TContext, TEvent extends EventObject> extend
     type: string;
 }
 export declare type Sender<TEvent extends EventObject> = (event: Event<TEvent>) => void;
+declare type ExcludeType<A> = {
+    [K in Exclude<keyof A, 'type'>]: A[K];
+};
+declare type ExtractExtraParameters<A, T> = A extends {
+    type: T;
+} ? ExcludeType<A> : never;
+declare type ExtractSimple<A> = A extends any ? {} extends ExcludeType<A> ? A : never : never;
+declare type NeverIfEmpty<T> = {} extends T ? never : T;
+export interface PayloadSender<TEvent extends EventObject> {
+    /**
+     * Send an event object or just the event type, if the event has no other payload
+     */
+    (event: TEvent | ExtractSimple<TEvent>['type']): void;
+    /**
+     * Send an event type and its payload
+     */
+    <K extends TEvent['type']>(eventType: K, payload: NeverIfEmpty<ExtractExtraParameters<TEvent, K>>): void;
+}
 export declare type Receiver<TEvent extends EventObject> = (listener: (event: TEvent) => void) => void;
 export declare type InvokeCallback = (callback: Sender<any>, onReceive: Receiver<EventObject>) => any;
 export interface InvokeMeta {
@@ -205,7 +222,7 @@ export interface InvokeSourceDefinition {
     [key: string]: any;
     type: string;
 }
-export declare type InvokeConfig<TContext, TEvent extends EventObject> = {
+export interface InvokeConfig<TContext, TEvent extends EventObject> {
     /**
      * The unique identifier for the invoked machine. If not specified, this
      * will be the machine's own `id`, or the URL (from `src`).
@@ -242,7 +259,7 @@ export declare type InvokeConfig<TContext, TEvent extends EventObject> = {
      * The transition to take upon the invoked child machine sending an error event.
      */
     onError?: string | SingleOrArray<TransitionConfig<TContext, DoneInvokeEvent<any>>>;
-};
+}
 export interface StateNodeConfig<TContext, TStateSchema extends StateSchema, TEvent extends EventObject> {
     /**
      * The relative key of the state node, which represents its location in the overall state value.
@@ -541,7 +558,7 @@ export interface NullEvent {
 }
 export interface ActivityActionObject<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> {
     type: ActionTypes.Start | ActionTypes.Stop;
-    activity: ActivityDefinition<TContext, TEvent>;
+    activity: ActivityDefinition<TContext, TEvent> | undefined;
     exec: ActionFunction<TContext, TEvent> | undefined;
 }
 export interface InvokeActionObject<TContext, TEvent extends EventObject> extends ActivityActionObject<TContext, TEvent> {
@@ -557,18 +574,32 @@ export interface LogActionObject<TContext, TEvent extends EventObject> extends L
     value: any;
 }
 export interface SendAction<TContext, TEvent extends EventObject, TSentEvent extends EventObject> extends ActionObject<TContext, TEvent> {
-    to: string | number | Actor | ExprWithMeta<TContext, TEvent, string | number | Actor> | undefined;
+    to: string | number | ActorRef<any> | ExprWithMeta<TContext, TEvent, string | number | ActorRef<any>> | undefined;
     event: TSentEvent | SendExpr<TContext, TEvent, TSentEvent>;
     delay?: number | string | DelayExpr<TContext, TEvent>;
     id: string | number;
 }
 export interface SendActionObject<TContext, TEvent extends EventObject, TSentEvent extends EventObject = AnyEventObject> extends SendAction<TContext, TEvent, TSentEvent> {
-    to: string | number | Actor | undefined;
+    to: string | number | ActorRef<any> | undefined;
     _event: SCXML.Event<TSentEvent>;
     event: TSentEvent;
     delay?: number;
     id: string | number;
 }
+export interface StopAction<TContext, TEvent extends EventObject> extends ActionObject<TContext, TEvent> {
+    type: ActionTypes.Stop;
+    activity: string | {
+        id: string;
+    } | Expr<TContext, TEvent, string | {
+        id: string;
+    }>;
+}
+export interface StopActionObject {
+    type: ActionTypes.Stop;
+    activity: {
+        id: string;
+    };
+}
 export declare type Expr<TContext, TEvent extends EventObject, T> = (context: TContext, event: TEvent) => T;
 export declare type ExprWithMeta<TContext, TEvent extends EventObject, T> = (context: TContext, event: TEvent, meta: SCXMLEventMeta<TEvent>) => T;
 export declare type SendExpr<TContext, TEvent extends EventObject, TSentEvent extends EventObject = AnyEventObject> = ExprWithMeta<TContext, TEvent, TSentEvent>;
@@ -579,7 +610,7 @@ export declare enum SpecialTargets {
 export interface SendActionOptions<TContext, TEvent extends EventObject> {
     id?: string | number;
     delay?: number | string | DelayExpr<TContext, TEvent>;
-    to?: string | ExprWithMeta<TContext, TEvent, string | number | Actor>;
+    to?: string | ExprWithMeta<TContext, TEvent, string | number | ActorRef<any>>;
 }
 export interface CancelAction extends ActionObject<any, any> {
     sendId: string | number;
@@ -620,6 +651,7 @@ export interface TransitionDefinition<TContext, TEvent extends EventObject> exte
         actions: Array<ActionObject<TContext, TEvent>>;
         cond?: Guard<TContext, TEvent>;
         eventType: TEvent['type'] | NullEvent['type'] | '*';
+        meta?: Record<string, any>;
     };
 }
 export declare type TransitionDefinitionMap<TContext, TEvent extends EventObject> = {
@@ -709,7 +741,7 @@ export interface StateConfig<TContext, TEvent extends EventObject> {
     events?: TEvent[];
     configuration: Array<StateNode<TContext, any, TEvent>>;
     transitions: Array<TransitionDefinition<TContext, TEvent>>;
-    children: Record<string, Actor>;
+    children: Record<string, ActorRef<any>>;
     done?: boolean;
 }
 export interface StateSchema<TC = any> {
@@ -809,17 +841,29 @@ export declare namespace SCXML {
         $$type: 'scxml';
     }
 }
-export interface Unsubscribable {
-    unsubscribe(): void;
-}
-export interface Subscribable<T> {
-    subscribe(next?: (value: T) => void, error?: (error: any) => void, complete?: () => void): Unsubscribable;
-}
 export interface Observer<T> {
     next: (value: T) => void;
     error: (err: any) => void;
     complete: () => void;
 }
+export interface Subscription {
+    unsubscribe(): void;
+}
+export interface Subscribable<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> | Promise<any> | InvokeCallback | Subscribable<any>;
+export interface ActorRef<TEvent extends EventObject, TEmitted = any> extends Subscribable<TEmitted> {
+    send: Sender<TEvent>;
+}
+export interface SpawnedActorRef<TEvent extends EventObject, TEmitted = any> extends ActorRef<TEvent, TEmitted> {
+    id: string;
+    stop?: () => void;
+    toJSON?: () => any;
+}
+export declare type ActorRefFrom<T extends StateMachine<any, any, any>> = T extends StateMachine<infer TContext, any, infer TEvent, infer TTypestate> ? SpawnedActorRef<TEvent, State<TContext, TEvent, any, TTypestate>> & {
+    state: State<TContext, TEvent, any, TTypestate>;
+} : never;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/lib/utils.d.ts

@@ -1,6 +1,6 @@
 import { Event, StateValue, ActionType, Action, EventObject, PropertyMapper, Mapper, EventType, HistoryValue, AssignAction, Condition, Subscribable, StateMachine, ConditionPredicate, SCXML, StateLike, EventData, TransitionConfig, TransitionConfigTarget, NullEvent, SingleOrArray, Guard, InvokeSourceDefinition } from './types';
 import { StateNode } from './StateNode';
-import { State } from '.';
+import { Observer, State } from '.';
 import { Actor } from './Actor';
 export declare function keys<T extends object>(value: T): Array<keyof T & string>;
 export declare function matchesState(parentStateId: StateValue, childStateId: StateValue, delimiter?: string): boolean;
@@ -66,4 +66,5 @@ export declare function normalizeTarget<TContext, TEvent extends EventObject>(ta
 export declare function reportUnhandledExceptionOnInvocation(originalError: any, currentError: any, id: string): void;
 export declare function evaluateGuard<TContext, TEvent extends EventObject>(machine: StateNode<TContext, any, TEvent>, guard: Guard<TContext, TEvent>, context: TContext, _event: SCXML.Event<TEvent>, state: State<TContext, TEvent>): boolean;
 export declare function toInvokeSource(src: string | InvokeSourceDefinition): InvokeSourceDefinition;
+export declare function toObserver<T>(nextHandler: Observer<T> | ((value: T) => void), errorHandler?: (error: any) => void, completionHandler?: () => void): Observer<T>;
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.js

@@ -42,7 +42,7 @@ var __spread = (this && this.__spread) || function () {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toInvokeSource = exports.evaluateGuard = exports.reportUnhandledExceptionOnInvocation = exports.normalizeTarget = exports.toTransitionConfigArray = exports.toSCXMLEvent = exports.toEventObject = exports.uniqueId = exports.isActor = exports.isMachine = exports.symbolObservable = exports.isObservable = exports.toGuard = exports.isString = exports.isFunction = exports.isArray = exports.warn = exports.updateContext = exports.updateHistoryValue = exports.updateHistoryStates = exports.partition = exports.isPromiseLike = exports.isBuiltInEvent = exports.mapContext = exports.toArray = exports.toArrayStrict = exports.flatten = exports.pathsToStateValue = exports.toStatePaths = exports.nestedPath = exports.path = exports.mapFilterValues = exports.mapValues = exports.pathToStateValue = exports.toStateValue = exports.isStateLike = exports.toStatePath = exports.getActionType = exports.getEventType = exports.matchesState = exports.keys = void 0;
+exports.toObserver = exports.toInvokeSource = exports.evaluateGuard = exports.reportUnhandledExceptionOnInvocation = exports.normalizeTarget = exports.toTransitionConfigArray = exports.toSCXMLEvent = exports.toEventObject = exports.uniqueId = exports.isActor = exports.isMachine = exports.symbolObservable = exports.isObservable = exports.toGuard = exports.isString = exports.isFunction = exports.isArray = exports.warn = exports.updateContext = exports.updateHistoryValue = exports.updateHistoryStates = exports.partition = exports.isPromiseLike = exports.isBuiltInEvent = exports.mapContext = exports.toArray = exports.toArrayStrict = exports.flatten = exports.pathsToStateValue = exports.toStatePaths = exports.nestedPath = exports.path = exports.mapFilterValues = exports.mapValues = exports.pathToStateValue = exports.toStateValue = exports.isStateLike = exports.toStatePath = exports.getActionType = exports.getEventType = exports.matchesState = exports.keys = void 0;
 var constants_1 = require("./constants");
 var environment_1 = require("./environment");
 function keys(value) {
@@ -184,7 +184,7 @@ exports.mapFilterValues = mapFilterValues;
  * Retrieves a value at the given path.
  * @param props The deep path to the prop of the desired value
  */
-exports.path = function (props) { return function (object) {
+var path = function (props) { return function (object) {
     var e_2, _a;
     var result = object;
     try {
@@ -202,6 +202,7 @@ exports.path = function (props) { return function (object) {
     }
     return result;
 }; };
+exports.path = path;
 /**
  * Retrieves a value at the given path via the nested accessor prop.
  * @param props The deep path to the prop of the desired value
@@ -609,3 +610,15 @@ function toInvokeSource(src) {
     return src;
 }
 exports.toInvokeSource = toInvokeSource;
+function toObserver(nextHandler, errorHandler, completionHandler) {
+    if (typeof nextHandler === 'object') {
+        return nextHandler;
+    }
+    var noop = function () { return void 0; };
+    return {
+        next: nextHandler,
+        error: errorHandler || noop,
+        complete: completionHandler || noop
+    };
+}
+exports.toObserver = toObserver;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xstate",
-  "version": "4.13.0",
+  "version": "4.15.1",
   "description": "Finite State Machines and Statecharts for the Modern Web.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -52,7 +52,7 @@
     "@babel/core": "^7.10.5",
     "@scion-scxml/test-framework": "^2.0.15",
     "babel-plugin-annotate-pure-calls": "^0.4.0",
-    "jest": "^24.8.0",
+    "jest": "^26.4.2",
     "jsdom": "^14.0.0",
     "jsdom-global": "^3.0.2",
     "lerna-alias": "3.0.3-0",
@@ -64,9 +64,9 @@
     "rollup-plugin-typescript2": "^0.25.2",
     "rollup-plugin-uglify": "^6.0.2",
     "rxjs": "^6.5.1",
-    "ts-jest": "^24.1.9",
+    "ts-jest": "^26.4.0",
     "tslib": "^1.10.0",
-    "typescript": "^3.9.7",
+    "typescript": "^4.1.2",
     "xml-js": "^1.6.11"
   }
 }