jssm 5.86.0 → 5.86.2

package/dist/es6/jssm.d.ts

@@ -1,6 +1,6 @@
 declare type StateType = string;
 import { JssmGenericState, JssmGenericConfig, JssmStateConfig, JssmTransition, JssmTransitionList, // JssmTransitionRule,
-JssmMachineInternalState, JssmStateDeclaration, JssmStateStyleKeyList, JssmLayout, JssmHistory, JssmSerialization, FslDirection, FslDirections, FslTheme, HookDescription, HookHandler, HookContext, HookResult, HookComplexResult } from './jssm_types';
+JssmMachineInternalState, JssmAllowsOverride, JssmStateDeclaration, JssmStateStyleKeyList, JssmLayout, JssmHistory, JssmSerialization, FslDirection, FslDirections, FslTheme, HookDescription, HookHandler, HookContext, HookResult, HookComplexResult } from './jssm_types';
 import { arrow_direction, arrow_left_kind, arrow_right_kind } from './jssm_arrow';
 import { compile, make, wrap_parse } from './jssm_compiler';
 import { seq, unique, find_repeated, weighted_rand_select, weighted_sample_select, histograph, weighted_histo_key } from './jssm_util';
@@ -74,7 +74,8 @@ declare class Machine<mDT> {
     _has_post_exit_hooks: boolean;
     _has_post_global_action_hooks: boolean;
     _has_post_transition_hooks: boolean;
-    _allows_override: boolean;
+    _code_allows_override: JssmAllowsOverride;
+    _config_allows_override: JssmAllowsOverride;
     _post_hooks: Map<string, HookHandler<mDT>>;
     _post_named_hooks: Map<string, HookHandler<mDT>>;
     _post_entry_hooks: Map<string, HookHandler<mDT>>;
@@ -98,7 +99,7 @@ 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 }: JssmGenericConfig<StateType, mDT>);
+    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 }: JssmGenericConfig<StateType, mDT>);
     /********
      *
      *  Internal method for fabricating states.  Not meant for external use.
@@ -484,12 +485,24 @@ declare class Machine<mDT> {
     list_actions(): Array<StateType>;
     get uses_actions(): boolean;
     get uses_forced_transitions(): boolean;
+    /*********
+     *
+     *  Check if the code that built the machine allows overriding state and data.
+     *
+     */
+    get code_allows_override(): JssmAllowsOverride;
+    /*********
+     *
+     *  Check if the machine config allows overriding state and data.
+     *
+     */
+    get config_allows_override(): JssmAllowsOverride;
     /*********
      *
      *  Check if a machine allows overriding state and data.
      *
      */
-    get allows_override(): boolean;
+    get allows_override(): JssmAllowsOverride;
     all_themes(): FslTheme[];
     get themes(): FslTheme | FslTheme[];
     set themes(to: FslTheme | FslTheme[]);

package/dist/es6/jssm.js

@@ -126,7 +126,7 @@ 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 }) {
+    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 }) {
         this._instance_name = instance_name;
         this._state = start_states[0];
         this._states = new Map();
@@ -183,7 +183,11 @@ class Machine {
         this._has_post_global_action_hooks = false;
         this._has_post_transition_hooks = true;
         // no need for a boolean for single hooks, just test for undefinedness
-        this._allows_override = false;
+        this._code_allows_override = allows_override;
+        this._config_allows_override = config_allows_override;
+        if ((allows_override === false) && (config_allows_override === true)) {
+            throw new JssmError(undefined, "Code specifies no override, but config tries to permit; config may not be less strict than code");
+        }
         this._post_hooks = new Map();
         this._post_named_hooks = new Map();
         this._post_entry_hooks = new Map();
@@ -901,13 +905,55 @@ class Machine {
     get uses_forced_transitions() {
         return this._has_forced_transitions;
     }
+    /*********
+     *
+     *  Check if the code that built the machine allows overriding state and data.
+     *
+     */
+    get code_allows_override() {
+        return this._code_allows_override;
+    }
+    /*********
+     *
+     *  Check if the machine config allows overriding state and data.
+     *
+     */
+    get config_allows_override() {
+        return this._config_allows_override;
+    }
     /*********
      *
      *  Check if a machine allows overriding state and data.
      *
      */
     get allows_override() {
-        return this._allows_override === true;
+        // code false?  config true, throw.  config false, false.  config undefined, false.
+        if (this._code_allows_override === false) {
+            /* istanbul ignore next */
+            if (this._config_allows_override === true) {
+                /* istanbul ignore next */
+                throw new JssmError(this, "Code specifies no override, but config tries to permit; config may not be less strict than code; should be unreachable");
+            }
+            else {
+                return false;
+            }
+        }
+        // code true?  config true, true.  config false, false.  config undefined, true.
+        if (this._code_allows_override === true) {
+            if (this._config_allows_override === false) {
+                return false;
+            }
+            else {
+                return true;
+            }
+        }
+        // code must be undefined.  config false, false.  config true, true.  config undefined, false.
+        if (this._config_allows_override === true) {
+            return true;
+        }
+        else {
+            return false;
+        }
     }
     all_themes() {
         return [...theme_mapping.keys()]; // constructor sets this to "default" otherwise
@@ -2198,7 +2244,14 @@ function sm(template_strings, ...remainder /* , arguments */) {
 function from(MachineAsString, ExtraConstructorFields) {
     const to_decorate = make(MachineAsString);
     if (ExtraConstructorFields !== undefined) {
-        Object.keys(ExtraConstructorFields).map(key => to_decorate[key] = ExtraConstructorFields[key]);
+        Object.keys(ExtraConstructorFields).map(key => {
+            if (key === 'allows_override') {
+                to_decorate['config_allows_override'] = ExtraConstructorFields['allows_override'];
+            }
+            else {
+                to_decorate[key] = ExtraConstructorFields[key];
+            }
+        });
     }
     return new Machine(to_decorate);
 }

package/dist/es6/jssm_compiler.js

@@ -192,9 +192,10 @@ function compile_rule_handler(rule) {
         'graph_layout', 'start_states', 'end_states', 'machine_name', 'machine_version',
         'machine_comment', 'machine_author', 'machine_contributor', 'machine_definition',
         'machine_reference', 'machine_license', 'fsl_version', 'state_config', 'theme',
-        'flow', 'dot_preamble', 'default_state_config', 'default_start_state_config',
-        'default_end_state_config', 'default_hooked_state_config',
-        'default_active_state_config', 'default_terminal_state_config'
+        'flow', 'dot_preamble', 'allows_override', 'default_state_config',
+        'default_start_state_config', 'default_end_state_config',
+        'default_hooked_state_config', 'default_active_state_config',
+        'default_terminal_state_config'
     ];
     if (tautologies.includes(rule.key)) {
         return { agg_as: rule.key, val: rule.value };
@@ -284,6 +285,7 @@ function compile(tree) {
         default_terminal_state_config: [],
         default_start_state_config: [],
         default_end_state_config: [],
+        allows_override: []
     };
     tree.map((tr) => {
         const rule = compile_rule_handler(tr), agg_as = rule.agg_as, val = rule.val; // TODO FIXME no any
@@ -303,7 +305,7 @@ function compile(tree) {
     const oneOnlyKeys = [
         'graph_layout', 'machine_name', 'machine_version', 'machine_comment',
         'fsl_version', 'machine_license', 'machine_definition', 'machine_language',
-        'flow', 'dot_preamble'
+        'flow', 'dot_preamble', 'allows_override'
     ];
     oneOnlyKeys.map((oneOnlyKey) => {
         if (results[oneOnlyKey].length > 1) {

package/dist/es6/jssm_types.d.ts

@@ -24,6 +24,7 @@ declare type JssmArrowKind = 'none' | 'legal' | 'main' | 'forced';
 declare type JssmLayout = 'dot' | 'circo' | 'twopi' | 'fdp';
 declare type JssmCorner = 'regular' | 'rounded' | 'lined';
 declare type JssmLineStyle = 'solid' | 'dashed' | 'dotted';
+declare type JssmAllowsOverride = true | false | undefined;
 declare const FslDirections: readonly ["up", "right", "down", "left"];
 declare type FslDirection = typeof FslDirections[number];
 declare const FslThemes: readonly ["default", "ocean", "modern", "plain", "bold"];
@@ -190,6 +191,8 @@ declare type JssmGenericConfig<StateType, DataType> = {
     allow_force?: false;
     actions?: JssmPermittedOpt;
     simplify_bidi?: boolean;
+    allows_override?: JssmAllowsOverride;
+    config_allows_override?: JssmAllowsOverride;
     dot_preamble?: string;
     start_states: Array<StateType>;
     end_states?: Array<StateType>;
@@ -354,4 +357,4 @@ declare type JssmErrorExtendedInfo = {
     requested_state?: StateType | undefined;
 };
 declare type JssmHistory<mDT> = circular_buffer<[StateType, mDT]>;
-export { JssmColor, JssmShape, JssmTransition, JssmTransitions, JssmTransitionList, JssmTransitionRule, JssmArrow, JssmArrowKind, JssmArrowDirection, JssmGenericConfig, JssmGenericState, JssmGenericMachine, JssmParseTree, JssmCompileSe, JssmCompileSeStart, JssmCompileRule, JssmPermitted, JssmPermittedOpt, JssmResult, JssmStateDeclaration, JssmStateDeclarationRule, JssmStateConfig, JssmStateStyleKey, JssmStateStyleKeyList, JssmBaseTheme, JssmTheme, JssmLayout, JssmHistory, JssmSerialization, JssmPropertyDefinition, JssmParseFunctionType, JssmMachineInternalState, JssmErrorExtendedInfo, FslDirections, FslDirection, FslThemes, FslTheme, HookDescription, HookHandler, HookContext, HookResult, HookComplexResult };
+export { JssmColor, JssmShape, JssmTransition, JssmTransitions, JssmTransitionList, JssmTransitionRule, JssmArrow, JssmArrowKind, JssmArrowDirection, JssmGenericConfig, JssmGenericState, JssmGenericMachine, JssmParseTree, JssmCompileSe, JssmCompileSeStart, JssmCompileRule, JssmPermitted, JssmPermittedOpt, JssmResult, JssmStateDeclaration, JssmStateDeclarationRule, JssmStateConfig, JssmStateStyleKey, JssmStateStyleKeyList, JssmBaseTheme, JssmTheme, JssmLayout, JssmHistory, JssmSerialization, JssmPropertyDefinition, JssmAllowsOverride, JssmParseFunctionType, JssmMachineInternalState, JssmErrorExtendedInfo, FslDirections, FslDirection, FslThemes, FslTheme, HookDescription, HookHandler, HookContext, HookResult, HookComplexResult };

package/dist/es6/version.js

@@ -1,2 +1,2 @@
-const version = "5.86.0", build_time = 1668217213797;
+const version = "5.86.2", build_time = 1668285414765;
 export { version, build_time };