Merge pull request #568 from StoneCypher/SetInitialState

Set initial state
StoneCypher · Mar 27, 2024 · b2d953d · b2d953d
2 parents e642702 + 9f66ad0
commit b2d953d
Show file tree

Hide file tree

Showing 37 changed files with 797 additions and 214 deletions.
diff --git a/CHANGELOG.long.md b/CHANGELOG.long.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -18,23 +18,23 @@ Please edit the file it's derived from, instead: `./src/md/readme_base.md`
 
 
 
-* Generated for version 5.97.1 at 2/5/2024, 2:56:05 PM
+* Generated for version 5.98.0 at 3/25/2024, 7:17:45 PM
 
 -->
-# jssm 5.97.1
+# jssm 5.98.0
 
 Easy.  Small.  Fast.  TS, es6, es5.  Node, Browser.  100% coverage.  Property
 tests.  Fuzz tests.  Language tests for a dozen languages and emoji.  Easy to
 share online.  Easy to embed.
 
 Readable, useful state machines as one-liner strings.
 
-***5,062 tests***, run 5,953 times.
+***5,070 tests***, run 5,961 times.
 
-* 5,053 specs with 100.0% coverage.
-* 9 fuzz tests with 12.5% coverage.
+* 5,061 specs with 100.0% coverage.
+* 9 fuzz tests with 12.4% coverage.
 
-With 2,956 lines, that's about 1.7 tests per line, or 2.0 generated tests per line.
+With 2,970 lines, that's about 1.7 tests per line, or 2.0 generated tests per line.
 
 ***Meet your new state machine library.***
 

diff --git a/dist/deno/README.md b/dist/deno/README.md
@@ -18,23 +18,23 @@ Please edit the file it's derived from, instead: `./src/md/readme_base.md`
 
 
 
-* Generated for version 5.97.1 at 2/5/2024, 2:56:05 PM
+* Generated for version 5.98.0 at 3/25/2024, 7:17:45 PM
 
 -->
-# jssm 5.97.1
+# jssm 5.98.0
 
 Easy.  Small.  Fast.  TS, es6, es5.  Node, Browser.  100% coverage.  Property
 tests.  Fuzz tests.  Language tests for a dozen languages and emoji.  Easy to
 share online.  Easy to embed.
 
 Readable, useful state machines as one-liner strings.
 
-***5,062 tests***, run 5,953 times.
+***5,070 tests***, run 5,961 times.
 
-* 5,053 specs with 100.0% coverage.
-* 9 fuzz tests with 12.5% coverage.
+* 5,061 specs with 100.0% coverage.
+* 9 fuzz tests with 12.4% coverage.
 
-With 2,956 lines, that's about 1.7 tests per line, or 2.0 generated tests per line.
+With 2,970 lines, that's about 1.7 tests per line, or 2.0 generated tests per line.
 
 ***Meet your new state machine library.***
 

diff --git a/dist/deno/jssm.d.ts b/dist/deno/jssm.d.ts
@@ -110,7 +110,7 @@ declare class Machine<mDT> {
     _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>);
+    constructor({ start_states, end_states, initial_state, start_states_no_enforce, 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.

diff --git a/dist/deno/jssm.js b/dist/deno/jssm.js
diff --git a/dist/deno/jssm_types.d.ts b/dist/deno/jssm_types.d.ts
@@ -198,6 +198,8 @@ declare type JssmGenericConfig<StateType, DataType> = {
     dot_preamble?: string;
     start_states: Array<StateType>;
     end_states?: Array<StateType>;
+    initial_state?: StateType;
+    start_states_no_enforce?: boolean;
     state_declaration?: Object[];
     property_definition?: JssmPropertyDefinition[];
     state_property?: JssmPropertyDefinition[];

diff --git a/dist/es6/jssm.d.ts b/dist/es6/jssm.d.ts
@@ -110,7 +110,7 @@ declare class Machine<mDT> {
     _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>);
+    constructor({ start_states, end_states, initial_state, start_states_no_enforce, 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.

diff --git a/dist/es6/jssm.js b/dist/es6/jssm.js
@@ -126,11 +126,10 @@ 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, time_source, timeout_source, clear_timeout_source }) {
+    constructor({ start_states, end_states = [], initial_state, start_states_no_enforce, 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();
         this._state_declarations = new Map();
         this._edges = [];
@@ -352,6 +351,19 @@ class Machine {
                 this._state_properties.set(sp.name, sp.default_value);
             });
         }
+        // set initial state either from the specified or the start state list.  validate admission behavior.
+        if (initial_state) {
+            if (!(this._states.has(initial_state))) {
+                throw new JssmError(this, `requested start state ${initial_state} does not exist`);
+            }
+            if ((!(start_states_no_enforce)) && (!(start_states.includes(initial_state)))) {
+                throw new JssmError(this, `requested start state ${initial_state} is not in start state list; add {start_states_no_enforce:true} to constructor options if desired`);
+            }
+            this._state = initial_state;
+        }
+        else {
+            this._state = start_states[0];
+        }
         // done building, do checks
         // assert all props are valid
         this._state_properties.forEach((_value, key) => {

diff --git a/dist/es6/jssm_types.d.ts b/dist/es6/jssm_types.d.ts
@@ -198,6 +198,8 @@ declare type JssmGenericConfig<StateType, DataType> = {
     dot_preamble?: string;
     start_states: Array<StateType>;
     end_states?: Array<StateType>;
+    initial_state?: StateType;
+    start_states_no_enforce?: boolean;
     state_declaration?: Object[];
     property_definition?: JssmPropertyDefinition[];
     state_property?: JssmPropertyDefinition[];

diff --git a/dist/es6/version.js b/dist/es6/version.js
@@ -1,2 +1,2 @@
-const version = "5.97.1", build_time = 1707173654610;
+const version = "5.98.0", build_time = 1711419354245;
 export { version, build_time };
diff --git a/dist/jssm.es5.cjs b/dist/jssm.es5.cjs
diff --git a/dist/jssm.es5.iife.cjs b/dist/jssm.es5.iife.cjs
diff --git a/dist/jssm.es5.iife.nonmin.cjs b/dist/jssm.es5.iife.nonmin.cjs
diff --git a/dist/jssm.es5.nonmin.cjs b/dist/jssm.es5.nonmin.cjs
diff --git a/dist/jssm.es6.mjs b/dist/jssm.es6.mjs
diff --git a/dist/jssm.es6.nonmin.cjs b/dist/jssm.es6.nonmin.cjs
diff --git a/docs/docs/assets/search.js b/docs/docs/assets/search.js
diff --git a/docs/docs/classes/jssm.Machine.html b/docs/docs/classes/jssm.Machine.html