xstate 4.7.5 → 4.8.0

package/lib/interpreter.d.ts

@@ -1,7 +1,7 @@
-import { StateMachine, Event, EventObject, DefaultContext, StateSchema, StateValue, InterpreterOptions, DoneEvent, Unsubscribable, MachineOptions, SCXML, EventData, Observer, Spawnable } from './types';
+import { StateMachine, Event, EventObject, DefaultContext, StateSchema, StateValue, InterpreterOptions, DoneEvent, Unsubscribable, MachineOptions, SCXML, EventData, Observer, Spawnable, Typestate } from './types';
 import { State } from './State';
 import { Actor } from './Actor';
-export declare type StateListener<TContext, TEvent extends EventObject> = (state: State<TContext, TEvent>, event: TEvent) => void;
+export declare type StateListener<TContext, TEvent extends EventObject, TTypestate extends Typestate<TContext> = any> = (state: State<TContext, TEvent, any, TTypestate>, event: TEvent) => void;
 export declare type ContextListener<TContext = DefaultContext> = (context: TContext, prevContext: TContext | undefined) => void;
 export declare type EventListener<TEvent extends EventObject = EventObject> = (event: TEvent) => void;
 export declare type Listener = () => void;
@@ -14,8 +14,8 @@ interface SpawnOptions {
     autoForward?: boolean;
     sync?: boolean;
 }
-export declare class Interpreter<TContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject> implements Actor<State<TContext, TEvent>, TEvent> {
-    machine: StateMachine<TContext, TStateSchema, TEvent>;
+export declare class Interpreter<TContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject, TTypestate extends Typestate<TContext> = any> implements Actor<State<TContext, TEvent>, TEvent> {
+    machine: StateMachine<TContext, TStateSchema, TEvent, TTypestate>;
     /**
      * The default interpreter options:
      *
@@ -62,7 +62,7 @@ export declare class Interpreter<TContext, TStateSchema extends StateSchema = an
      * @param machine The machine to be interpreted
      * @param options Interpreter options
      */
-    constructor(machine: StateMachine<TContext, TStateSchema, TEvent>, options?: Partial<InterpreterOptions>, sessionId?: string);
+    constructor(machine: StateMachine<TContext, TStateSchema, TEvent, TTypestate>, options?: Partial<InterpreterOptions>);
     get initialState(): State<TContext, TEvent>;
     get state(): State<TContext, TEvent>;
     static interpret: typeof interpret;
@@ -74,9 +74,9 @@ export declare class Interpreter<TContext, TStateSchema extends StateSchema = an
      */
     execute(state: State<TContext, TEvent>, actionsConfig?: MachineOptions<TContext, TEvent>['actions']): void;
     private update;
-    onTransition(listener: StateListener<TContext, TEvent>): Interpreter<TContext, TStateSchema, TEvent>;
-    subscribe(observer: Observer<State<TContext, TEvent>>): Unsubscribable;
-    subscribe(nextListener?: (state: State<TContext, TEvent>) => void, errorListener?: (error: any) => void, completeListener?: () => void): Unsubscribable;
+    onTransition(listener: StateListener<TContext, TEvent, TTypestate>): this;
+    subscribe(observer: Observer<State<TContext, TEvent, any, TTypestate>>): Unsubscribable;
+    subscribe(nextListener?: (state: State<TContext, TEvent, any, TTypestate>) => void, errorListener?: (error: any) => void, completeListener?: () => void): Unsubscribable;
     /**
      * Adds an event listener that is notified whenever an event is sent to the running interpreter.
      * @param listener The event listener
@@ -110,7 +110,7 @@ export declare class Interpreter<TContext, TStateSchema extends StateSchema = an
     /**
      * Alias for Interpreter.prototype.start
      */
-    init: (initialState?: string | import("./types").StateValueMap | State<TContext, TEvent, any, any> | undefined) => Interpreter<TContext, TStateSchema, TEvent>;
+    init: (initialState?: string | import("./types").StateValueMap | State<TContext, TEvent, any, any> | undefined) => Interpreter<TContext, TStateSchema, TEvent, any>;
     /**
      * Starts the interpreter from the given state, or the initial state.
      * @param initialState The state to start the statechart from
@@ -178,6 +178,6 @@ export declare function spawn(entity: Spawnable, nameOrOptions?: string | SpawnO
  * @param machine The machine to interpret
  * @param options Interpreter options
  */
-export declare function interpret<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject>(machine: StateMachine<TContext, TStateSchema, TEvent>, options?: Partial<InterpreterOptions>): Interpreter<TContext, TStateSchema, TEvent>;
+export declare function interpret<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject, TTypestate extends Typestate<TContext> = any>(machine: StateMachine<TContext, TStateSchema, TEvent, TTypestate>, options?: Partial<InterpreterOptions>): Interpreter<TContext, TStateSchema, TEvent, TTypestate>;
 export {};
 //# sourceMappingURL=interpreter.d.ts.map

package/lib/interpreter.js

@@ -82,7 +82,7 @@ var Interpreter = /** @class */ (function () {
      * @param machine The machine to be interpreted
      * @param options Interpreter options
      */
-    function Interpreter(machine, options, sessionId) {
+    function Interpreter(machine, options) {
         var _this = this;
         if (options === void 0) { options = Interpreter.defaultOptions; }
         this.machine = machine;
@@ -183,8 +183,7 @@ var Interpreter = /** @class */ (function () {
         this.scheduler = new scheduler_1.Scheduler({
             deferEvents: this.options.deferEvents
         });
-        this.sessionId =
-            sessionId !== undefined ? sessionId : registry_1.registry.register(this);
+        this.sessionId = registry_1.registry.bookId();
     }
     Object.defineProperty(Interpreter.prototype, "initialState", {
         get: function () {
@@ -421,6 +420,7 @@ var Interpreter = /** @class */ (function () {
             // Do not restart the service if it is already started
             return this;
         }
+        registry_1.registry.register(this.sessionId, this);
         this.initialized = true;
         this._status = InterpreterStatus.Running;
         var resolvedState = initialState === undefined
@@ -522,6 +522,7 @@ var Interpreter = /** @class */ (function () {
         this.scheduler.clear();
         this.initialized = false;
         this._status = InterpreterStatus.Stopped;
+        registry_1.registry.free(this.sessionId);
         return this;
     };
     Interpreter.prototype.batch = function (events) {

package/lib/json.d.ts

@@ -0,0 +1,31 @@
+import { StateNode, ActionObject, Guard, InvokeDefinition } from './';
+interface JSONFunction {
+    $function: string;
+}
+export declare function stringifyFunction(fn: Function): JSONFunction;
+interface TransitionConfig {
+    target: string[];
+    source: string;
+    actions: Array<ActionObject<any, any>>;
+    cond: Guard<any, any> | undefined;
+    eventType: string;
+}
+interface StateNodeConfig {
+    type: StateNode['type'];
+    id: string;
+    key: string;
+    initial?: string;
+    entry: Array<ActionObject<any, any>>;
+    exit: Array<ActionObject<any, any>>;
+    on: {
+        [key: string]: TransitionConfig[];
+    };
+    invoke: Array<InvokeDefinition<any, any>>;
+    states: Record<string, StateNodeConfig>;
+}
+export declare function machineToJSON(stateNode: StateNode): StateNodeConfig;
+export declare function stringify(machine: StateNode): string;
+export declare function parse(machineString: string): StateNodeConfig;
+export declare function jsonify<T extends Record<string, any>>(value: T): T;
+export {};
+//# sourceMappingURL=json.d.ts.map

package/lib/json.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var utils_1 = require("./utils");
+// tslint:disable-next-line:ban-types
+function stringifyFunction(fn) {
+    return {
+        $function: fn.toString()
+    };
+}
+exports.stringifyFunction = stringifyFunction;
+function getStateNodeId(stateNode) {
+    return "#" + stateNode.id;
+}
+// derive config from machine
+function machineToJSON(stateNode) {
+    var config = {
+        type: stateNode.type,
+        initial: stateNode.initial === undefined ? undefined : String(stateNode.initial),
+        id: stateNode.id,
+        key: stateNode.key,
+        entry: stateNode.onEntry,
+        exit: stateNode.onExit,
+        on: utils_1.mapValues(stateNode.on, function (transition) {
+            return transition.map(function (t) {
+                return {
+                    target: t.target ? t.target.map(getStateNodeId) : [],
+                    source: getStateNodeId(t.source),
+                    actions: t.actions,
+                    cond: t.cond,
+                    eventType: t.eventType
+                };
+            });
+        }),
+        invoke: stateNode.invoke,
+        states: {}
+    };
+    Object.values(stateNode.states).forEach(function (sn) {
+        config.states[sn.key] = machineToJSON(sn);
+    });
+    return config;
+}
+exports.machineToJSON = machineToJSON;
+function stringify(machine) {
+    return JSON.stringify(machineToJSON(machine), function (_, value) {
+        if (utils_1.isFunction(value)) {
+            return { $function: value.toString() };
+        }
+        return value;
+    });
+}
+exports.stringify = stringify;
+function parse(machineString) {
+    var config = JSON.parse(machineString, function (_, value) {
+        if (typeof value === 'object' && '$function' in value) {
+            return new Function(value.value);
+        }
+        return value;
+    });
+    return config;
+}
+exports.parse = parse;
+function jsonify(value) {
+    Object.defineProperty(value, 'toJSON', {
+        value: function () {
+            return utils_1.mapValues(value, function (subValue) {
+                if (utils_1.isFunction(subValue)) {
+                    return stringifyFunction(subValue);
+                }
+                else if (typeof subValue === 'object' && !Array.isArray(subValue)) {
+                    // mostly for assignments
+                    return utils_1.mapValues(subValue, function (subSubValue) {
+                        if (utils_1.isFunction(subSubValue)) {
+                            return stringifyFunction(subSubValue);
+                        }
+                        return subSubValue;
+                    });
+                }
+                return subValue;
+            });
+        }
+    });
+    return value;
+}
+exports.jsonify = jsonify;

package/lib/registry.d.ts

@@ -1,8 +1,9 @@
 import { Actor } from './Actor';
 export interface Registry {
-    register(actor: Actor): string;
+    bookId(): string;
+    register(id: string, actor: Actor): string;
     get(id: string): Actor | undefined;
-    lookup(actor: Actor): string | undefined;
+    free(id: string): void;
 }
 export declare const registry: Registry;
 //# sourceMappingURL=registry.d.ts.map

package/lib/registry.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var children = new Map();
-var idMap = new Map();
 var sessionIdIndex = 0;
 exports.registry = {
-    register: function (actor) {
-        var id = "x:" + sessionIdIndex++;
+    bookId: function () {
+        return "x:" + sessionIdIndex++;
+    },
+    register: function (id, actor) {
         children.set(id, actor);
-        idMap.set(actor, id);
         return id;
     },
     get: function (id) {
         return children.get(id);
     },
-    lookup: function (actorRef) {
-        return idMap.get(actorRef);
+    free: function (id) {
+        children.delete(id);
     }
 };

package/lib/types.d.ts

@@ -50,7 +50,7 @@ export interface AssignMeta<TContext, TEvent extends EventObject> {
     _event: SCXML.Event<TEvent>;
 }
 export declare type ActionFunction<TContext, TEvent extends EventObject> = (context: TContext, event: TEvent, meta: ActionMeta<TContext, TEvent>) => any | void;
-export declare type Action<TContext, TEvent extends EventObject> = ActionType | ActionObject<TContext, TEvent> | ActionFunction<TContext, TEvent> | AssignAction<Required<TContext>, TEvent> | SendAction<TContext, TEvent> | RaiseAction<TEvent>;
+export declare type Action<TContext, TEvent extends EventObject> = ActionType | ActionObject<TContext, TEvent> | ActionFunction<TContext, TEvent> | AssignAction<Required<TContext>, TEvent> | SendAction<TContext, TEvent> | RaiseAction<AnyEventObject>;
 export declare type Actions<TContext, TEvent extends EventObject> = SingleOrArray<Action<TContext, TEvent>>;
 export declare type StateKey = string | State<any>;
 export interface StateValueMap {
@@ -124,7 +124,7 @@ export declare type InvokeCallback = (callback: Sender<any>, onReceive: Receiver
  * @param context The current machine `context`
  * @param event The event that invoked the service
  */
-export declare type InvokeCreator<TContext, TFinalContext = any> = (context: TContext, event: AnyEventObject) => PromiseLike<TFinalContext> | StateMachine<TFinalContext, any, any> | Subscribable<any> | InvokeCallback;
+export declare type InvokeCreator<TContext, TEvent = AnyEventObject, TFinalContext = any> = (context: TContext, event: TEvent) => PromiseLike<TFinalContext> | StateMachine<TFinalContext, any, any> | Subscribable<any> | InvokeCallback;
 export interface InvokeDefinition<TContext, TEvent extends EventObject> extends ActivityDefinition<TContext, TEvent> {
     /**
      * The source of the machine to be invoked, or the machine itself.
@@ -196,7 +196,7 @@ export declare type InvokeConfig<TContext, TEvent extends EventObject> = {
     /**
      * The source of the machine to be invoked, or the machine itself.
      */
-    src: string | StateMachine<any, any, any> | InvokeCreator<any, any>;
+    src: string | StateMachine<any, any, any> | InvokeCreator<TContext, TEvent, any>;
     /**
      * If `true`, events sent to the parent service will be forwarded to the invoked service.
      *
@@ -345,14 +345,15 @@ export interface StateNodeDefinition<TContext, TStateSchema extends StateSchema,
     id: string;
     version: string | undefined;
     key: string;
+    context: TContext;
     type: 'atomic' | 'compound' | 'parallel' | 'final' | 'history';
     initial: StateNodeConfig<TContext, TStateSchema, TEvent>['initial'];
     history: boolean | 'shallow' | 'deep' | undefined;
     states: StatesDefinition<TContext, TStateSchema, TEvent>;
     on: TransitionDefinitionMap<TContext, TEvent>;
     transitions: Array<TransitionDefinition<TContext, TEvent>>;
-    onEntry: Array<ActionObject<TContext, TEvent>>;
-    onExit: Array<ActionObject<TContext, TEvent>>;
+    entry: Array<ActionObject<TContext, TEvent>>;
+    exit: Array<ActionObject<TContext, TEvent>>;
     activities: Array<ActivityDefinition<TContext, TEvent>>;
     meta: any;
     order: number;
@@ -422,7 +423,7 @@ export interface HistoryStateNode<TContext> extends StateNode<TContext> {
     history: 'shallow' | 'deep';
     target: StateValue | undefined;
 }
-export interface StateMachine<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TState extends Typestate<TContext> = Typestate<TContext>> extends StateNode<TContext, TStateSchema, TEvent, TState> {
+export interface StateMachine<TContext, TStateSchema extends StateSchema, TEvent extends EventObject, TTypestate extends Typestate<TContext> = any> extends StateNode<TContext, TStateSchema, TEvent, TTypestate> {
     id: string;
     states: StateNode<TContext, TStateSchema, TEvent>['states'];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xstate",
-  "version": "4.7.5",
+  "version": "4.8.0",
   "description": "Finite State Machines and Statecharts for the Modern Web.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -66,7 +66,7 @@
     "rxjs": "^6.5.1",
     "ts-jest": "^24.1.9",
     "tslib": "^1.10.0",
-    "typescript": "^3.7.2",
+    "typescript": "^3.7.5",
     "xml-js": "^1.6.11"
   }
 }