jssm 5.93.0 → 5.95.0

package/dist/es6/jssm.d.ts

@@ -101,7 +101,16 @@ declare class Machine<mDT> {
     _start_state_style: JssmStateConfig;
     _end_state_style: JssmStateConfig;
     _state_labels: Map<string, string>;
-    constructor({ start_states, end_states, complete, transitions, machine_author, machine_comment, machine_contributor, machine_definition, machine_language, machine_license, machine_name, machine_version, state_declaration, property_definition, state_property, fsl_version, dot_preamble, arrange_declaration, arrange_start_declaration, arrange_end_declaration, theme, flow, graph_layout, instance_name, history, data, default_state_config, default_active_state_config, default_hooked_state_config, default_terminal_state_config, default_start_state_config, default_end_state_config, allows_override, config_allows_override, rng_seed }: JssmGenericConfig<StateType, mDT>);
+    _time_source: () => number;
+    _create_started: number;
+    _created: number;
+    _after_mapping: Map<string, [string, number]>;
+    _timeout_source: (Function: any, number: any) => number;
+    _clear_timeout_source: (h: any) => void;
+    _timeout_handle: number | undefined;
+    _timeout_target: string | undefined;
+    _timeout_target_time: number | undefined;
+    constructor({ start_states, end_states, complete, transitions, machine_author, machine_comment, machine_contributor, machine_definition, machine_language, machine_license, machine_name, machine_version, state_declaration, property_definition, state_property, fsl_version, dot_preamble, arrange_declaration, arrange_start_declaration, arrange_end_declaration, theme, flow, graph_layout, instance_name, history, data, default_state_config, default_active_state_config, default_hooked_state_config, default_terminal_state_config, default_start_state_config, default_end_state_config, allows_override, config_allows_override, rng_seed, time_source, timeout_source, clear_timeout_source }: JssmGenericConfig<StateType, mDT>);
     /********
      *
      *  Internal method for fabricating states.  Not meant for external use.
@@ -694,6 +703,7 @@ declare class Machine<mDT> {
      */
     override(newState: StateType, newData?: mDT | undefined): void;
     transition_impl(newStateOrAction: StateType, newData: mDT | undefined, wasForced: boolean, wasAction: boolean): boolean;
+    auto_set_state_timeout(): void;
     /*********
      *
      *  Get a truncated history of the recent states and data of the machine.
@@ -1065,6 +1075,13 @@ declare class Machine<mDT> {
     valid_transition(newState: StateType, _newData?: mDT): boolean;
     valid_force_transition(newState: StateType, _newData?: mDT): boolean;
     instance_name(): string | undefined;
+    get creation_date(): Date;
+    get creation_timestamp(): number;
+    get create_start_time(): number;
+    set_state_timeout(next_state: StateType, after_time: number): void;
+    clear_state_timeout(): void;
+    state_timeout_for(which_state: StateType): [StateType, number] | undefined;
+    current_state_timeout(): [StateType, number] | undefined;
     sm(template_strings: TemplateStringsArray, ...remainder: any[]): Machine<mDT>;
 }
 /*********

package/dist/es6/jssm.js

@@ -126,7 +126,9 @@ function state_style_condense(jssk) {
 // TODO add a lotta docblock here
 class Machine {
     // whargarbl this badly needs to be broken up, monolith master
-    constructor({ start_states, end_states = [], complete = [], transitions, machine_author, machine_comment, machine_contributor, machine_definition, machine_language, machine_license, machine_name, machine_version, state_declaration, property_definition, state_property, fsl_version, dot_preamble = undefined, arrange_declaration = [], arrange_start_declaration = [], arrange_end_declaration = [], theme = ['default'], flow = 'down', graph_layout = 'dot', instance_name, history, data, default_state_config, default_active_state_config, default_hooked_state_config, default_terminal_state_config, default_start_state_config, default_end_state_config, allows_override, config_allows_override, rng_seed }) {
+    constructor({ start_states, end_states = [], complete = [], transitions, machine_author, machine_comment, machine_contributor, machine_definition, machine_language, machine_license, machine_name, machine_version, state_declaration, property_definition, state_property, fsl_version, dot_preamble = undefined, arrange_declaration = [], arrange_start_declaration = [], arrange_end_declaration = [], theme = ['default'], flow = 'down', graph_layout = 'dot', instance_name, history, data, default_state_config, default_active_state_config, default_hooked_state_config, default_terminal_state_config, default_start_state_config, default_end_state_config, allows_override, config_allows_override, rng_seed, time_source, timeout_source, clear_timeout_source }) {
+        this._time_source = () => new Date().getTime();
+        this._create_started = this._time_source();
         this._instance_name = instance_name;
         this._state = start_states[0];
         this._states = new Map();
@@ -214,6 +216,12 @@ class Machine {
         this._state_labels = new Map();
         this._rng_seed = rng_seed !== null && rng_seed !== void 0 ? rng_seed : new Date().getTime();
         this._rng = gen_splitmix32(this._rng_seed);
+        this._timeout_source = timeout_source !== null && timeout_source !== void 0 ? timeout_source : ((f, a) => setTimeout(f, a));
+        this._clear_timeout_source = clear_timeout_source !== null && clear_timeout_source !== void 0 ? clear_timeout_source : ((h) => clearTimeout(h));
+        this._timeout_handle = undefined;
+        this._timeout_target = undefined;
+        this._timeout_target_time = undefined;
+        this._after_mapping = new Map();
         // consolidate the state declarations
         if (state_declaration) {
             state_declaration.map((state_decl) => {
@@ -275,6 +283,10 @@ class Machine {
                     this._named_transitions.set(tr.name, thisEdgeId);
                 }
             }
+            // set up the after mapping, if any
+            if (tr.after_time) {
+                this._after_mapping.set(tr.from, [tr.to, tr.after_time]);
+            }
             // set up the mapping, so that edges can be looked up by endpoint pairs
             const from_mapping = this._edge_map.get(tr.from) || new Map();
             if (!(this._edge_map.has(tr.from))) {
@@ -382,6 +394,13 @@ class Machine {
         if (!(start_states.length === this._start_states.size)) {
             throw new JssmError(this, `Start states cannot be repeated`);
         }
+        this._created = this._time_source();
+        this.auto_set_state_timeout();
+        this._arrange_declaration.forEach((arrange_pair) => arrange_pair.forEach((possibleState) => {
+            if (!(this._states.has(possibleState))) {
+                throw new JssmError(this, `Cannot arrange state that does not exist "${possibleState}"`);
+            }
+        }));
     }
     /********
      *
@@ -1511,6 +1530,8 @@ class Machine {
         };
         if (valid) {
             if (this._has_hooks) {
+                // once validity is known, clear old 'after' timeout clause
+                this.clear_state_timeout();
                 function update_fields(res) {
                     if (res.hasOwnProperty('data')) {
                         hook_args.data = res.data;
@@ -1700,8 +1721,17 @@ class Machine {
                 }
             }
         }
+        // possibly re-establish new 'after' clause
+        this.auto_set_state_timeout();
         return true;
     }
+    auto_set_state_timeout() {
+        const after_res = this._after_mapping.get(this._state);
+        if (after_res !== undefined) {
+            const [next_state, after_time] = after_res;
+            this.set_state_timeout(next_state, after_time);
+        }
+    }
     /*********
      *
      *  Get a truncated history of the recent states and data of the machine.
@@ -2233,6 +2263,45 @@ class Machine {
     instance_name() {
         return this._instance_name;
     }
+    get creation_date() {
+        return new Date(Math.floor(this.creation_timestamp));
+    }
+    get creation_timestamp() {
+        return this._created;
+    }
+    get create_start_time() {
+        return this._create_started;
+    }
+    set_state_timeout(next_state, after_time) {
+        if (this._timeout_handle !== undefined) {
+            throw new JssmError(this, `Asked to set a state timeout to ${next_state}:${after_time}, but already timing out to ${this._timeout_target}:${this._timeout_target_time}`);
+        }
+        this._timeout_handle = this._timeout_source(
+        // it seems like istanbul can't see this line being followed, even though it is, actively
+        // this is enforced by the "after mapping runs normally with very short time" tests in after_mapping.spec
+        // we'll mark it no-check so that our coverage numbers aren't wrecked
+        /* istanbul ignore next */
+        () => this.go(next_state), after_time);
+        this._timeout_target = next_state;
+        this._timeout_target_time = after_time;
+    }
+    clear_state_timeout() {
+        if (this._timeout_handle === undefined) {
+            return; // calling with no timeout is a no-op, means it can be called glad-handedly
+        }
+        this._clear_timeout_source(this._timeout_handle);
+        this._timeout_handle = undefined;
+        this._timeout_target = undefined;
+        this._timeout_target_time = undefined;
+    }
+    state_timeout_for(which_state) {
+        return this._after_mapping.get(which_state);
+    }
+    current_state_timeout() {
+        return (this._timeout_target !== undefined)
+            ? [this._timeout_target, this._timeout_target_time]
+            : undefined;
+    }
     /* eslint-disable no-use-before-define */
     /* eslint-disable class-methods-use-this */
     sm(template_strings, ...remainder /* , arguments */) {

package/dist/es6/jssm_compiler.js

@@ -21,6 +21,7 @@ function makeTransition(this_se, from, to, isRight, _wasList, _wasIndex) {
         from,
         to,
         kind,
+        after_time: isRight ? this_se.r_after : this_se.l_after,
         forced_only: kind === 'forced',
         main_path: kind === 'main'
     };

package/dist/es6/jssm_types.d.ts

@@ -48,6 +48,8 @@ declare type JssmTransitionPermitterMaybeArray<DataType> = JssmTransitionPermitt
 declare type JssmTransition<StateType, DataType> = {
     from: StateType;
     to: StateType;
+    after_time?: number;
+    se?: JssmCompileSe<StateType, DataType>;
     name?: StateType;
     action?: StateType;
     check?: JssmTransitionPermitterMaybeArray<DataType>;
@@ -220,6 +222,9 @@ declare type JssmGenericConfig<StateType, DataType> = {
     default_terminal_state_config?: JssmStateStyleKeyList;
     default_active_state_config?: JssmStateStyleKeyList;
     rng_seed?: number | undefined;
+    time_source?: () => number;
+    timeout_source?: (Function: any, number: any) => number;
+    clear_timeout_source?: (number: any) => void;
 };
 declare type JssmCompileRule<StateType> = {
     agg_as: string;
@@ -227,12 +232,14 @@ declare type JssmCompileRule<StateType> = {
 };
 declare type JssmCompileSe<StateType, mDT> = {
     to: StateType;
-    se: JssmCompileSe<StateType, mDT>;
+    se?: JssmCompileSe<StateType, mDT>;
     kind: JssmArrow;
     l_action?: StateType;
     r_action?: StateType;
     l_probability: number;
     r_probability: number;
+    l_after?: number;
+    r_after?: number;
 };
 declare type JssmCompileSeStart<StateType, DataType> = {
     from: StateType;

package/dist/es6/version.js

@@ -1,2 +1,2 @@
-const version = "5.93.0", build_time = 1703723662470;
+const version = "5.95.0", build_time = 1704098570300;
 export { version, build_time };