jssm 5.44.0 → 5.46.0

package/dist/es6/jssm.d.ts

@@ -1,6 +1,6 @@
 declare type StateType = string;
 import { JssmGenericState, JssmGenericConfig, JssmTransition, JssmTransitionList, // JssmTransitionRule,
-JssmMachineInternalState, JssmParseTree, JssmStateDeclaration, JssmArrow, JssmArrowDirection, JssmArrowKind, JssmLayout, FslDirection, FslTheme } from './jssm_types';
+JssmMachineInternalState, JssmParseTree, JssmStateDeclaration, JssmArrow, JssmArrowDirection, JssmArrowKind, JssmLayout, FslDirection, FslTheme, HookDescription, HookHandler } from './jssm_types';
 import { seq, weighted_rand_select, weighted_sample_select, histograph, weighted_histo_key } from './jssm_util';
 import { version } from './version';
 declare function arrow_direction(arrow: JssmArrow): JssmArrowDirection;
@@ -37,6 +37,9 @@ declare class Machine<mDT> {
     _arrange_end_declaration: Array<Array<StateType>>;
     _theme: FslTheme;
     _flow: FslDirection;
+    _has_hooks: boolean;
+    _hooks: Map<string, Function>;
+    _named_hooks: Map<string, Function>;
     constructor({ start_states, complete, transitions, machine_author, machine_comment, machine_contributor, machine_definition, machine_language, machine_license, machine_name, machine_version, state_declaration, fsl_version, dot_preamble, arrange_declaration, arrange_start_declaration, arrange_end_declaration, theme, flow, graph_layout }: JssmGenericConfig<mDT>);
     _new_state(state_config: JssmGenericState): StateType;
     state(): StateType;
@@ -86,6 +89,8 @@ declare class Machine<mDT> {
     is_complete(): boolean;
     state_is_complete(whichState: StateType): boolean;
     has_completes(): boolean;
+    set_hook(HookDesc: HookDescription): void;
+    hook(from: string, to: string, handler: HookHandler): Machine<mDT>;
     action(name: StateType, newData?: mDT): boolean;
     transition(newState: StateType, newData?: mDT): boolean;
     force_transition(newState: StateType, newData?: mDT): boolean;

package/dist/es6/jssm.js

@@ -1,8 +1,8 @@
 // whargarbl lots of these return arrays could/should be sets
 import { reduce as reduce_to_639 } from 'reduce-to-639-1';
-import { seq, weighted_rand_select, weighted_sample_select, histograph, weighted_histo_key, array_box_if_string } from './jssm_util';
+import { seq, weighted_rand_select, weighted_sample_select, histograph, weighted_histo_key, array_box_if_string, hook_name, named_hook_name } from './jssm_util';
 import { parse } from './jssm-dot'; // TODO FIXME WHARGARBL this could be post-typed
-import { version } from './version'; // replaced from package.js in build // TODO FIXME currently broken
+import { version } from './version'; // replaced from package.js in build
 /* eslint-disable complexity */
 function arrow_direction(arrow) {
     switch (String(arrow)) {
@@ -345,6 +345,9 @@ class Machine {
         this._theme = theme;
         this._flow = flow;
         this._graph_layout = graph_layout;
+        this._has_hooks = false;
+        this._hooks = new Map();
+        this._named_hooks = new Map();
         if (state_declaration) {
             state_declaration.map((state_decl) => {
                 if (this._state_declarations.has(state_decl.state)) { // no repeats
@@ -401,7 +404,7 @@ class Machine {
             // set up the action mapping, so that actions can be looked up by origin
             if (tr.action) {
                 // forward mapping first by action name
-                let actionMap = this._actions.get(tr.action); // TODO FIXME ?Map equiv
+                let actionMap = this._actions.get(tr.action);
                 if (!(actionMap)) {
                     actionMap = new Map();
                     this._actions.set(tr.action, actionMap);
@@ -413,7 +416,7 @@ class Machine {
                     actionMap.set(tr.from, thisEdgeId);
                 }
                 // reverse mapping first by state origin name
-                let rActionMap = this._reverse_actions.get(tr.from); // TODO FIXME ?Map equiv
+                let rActionMap = this._reverse_actions.get(tr.from);
                 if (!(rActionMap)) {
                     rActionMap = new Map();
                     this._reverse_actions.set(tr.from, rActionMap);
@@ -694,14 +697,64 @@ class Machine {
     has_completes() {
         return this.states().some((x) => this.state_is_complete(x));
     }
+    // basic toolable hook call.  convenience wrappers will follow, like
+    // hook(from, to, handler) and exit_hook(from, handler) and etc
+    set_hook(HookDesc) {
+        switch (HookDesc.kind) {
+            case 'hook':
+                this._hooks.set(hook_name(HookDesc.from, HookDesc.to), HookDesc.handler);
+                this._has_hooks = true;
+                break;
+            case 'named':
+                this._named_hooks.set(named_hook_name(HookDesc.from, HookDesc.to, HookDesc.action), HookDesc.handler);
+                this._has_hooks = true;
+                break;
+            // case 'entry':
+            //   console.log('TODO: Should add entry hook here');
+            //   throw 'TODO: Should add entry hook here';
+            // case 'exit':
+            //   console.log('TODO: Should add exit hook here');
+            //   throw 'TODO: Should add exit hook here';
+            default:
+                console.log(`Unknown hook type ${HookDesc.kind}, should be impossible`);
+                throw new RangeError(`Unknown hook type ${HookDesc.kind}, should be impossible`);
+        }
+    }
+    hook(from, to, handler) {
+        // TODO: should this throw if setting the hook fails, or ignore it and continue?
+        this.set_hook({ kind: 'hook', from, to, handler });
+        return this;
+    }
+    // remove_hook(HookDesc: HookDescription) {
+    //   throw 'TODO: Should remove hook here';
+    // }
     action(name, newData) {
         // todo whargarbl implement hooks
         // todo whargarbl implement data stuff
         // todo major incomplete whargarbl comeback
         if (this.valid_action(name, newData)) {
             const edge = this.current_action_edge_for(name);
-            this._state = edge.to;
-            return true;
+            if (this._has_hooks) {
+                let hook_permits = undefined;
+                const nhn = named_hook_name(this._state, edge.to, name), maybe_hook = this._named_hooks.get(nhn);
+                if (maybe_hook === undefined) {
+                    hook_permits = true;
+                }
+                else {
+                    hook_permits = maybe_hook({ from: this._state, to: edge.to, action: name });
+                }
+                if (hook_permits !== false) {
+                    this._state = edge.to;
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+            else {
+                this._state = edge.to;
+                return true;
+            }
         }
         else {
             return false;
@@ -712,8 +765,27 @@ class Machine {
         // todo whargarbl implement data stuff
         // todo major incomplete whargarbl comeback
         if (this.valid_transition(newState, newData)) {
-            this._state = newState;
-            return true;
+            if (this._has_hooks) {
+                let hook_permits = undefined;
+                const hn = hook_name(this._state, newState), maybe_hook = this._hooks.get(hn);
+                if (maybe_hook === undefined) {
+                    hook_permits = true;
+                }
+                else {
+                    hook_permits = maybe_hook({ from: this._state, to: newState });
+                }
+                if (hook_permits !== false) {
+                    this._state = newState;
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+            else {
+                this._state = newState;
+                return true;
+            }
         }
         else {
             return false;
@@ -725,8 +797,27 @@ class Machine {
         // todo whargarbl implement data stuff
         // todo major incomplete whargarbl comeback
         if (this.valid_force_transition(newState, newData)) {
-            this._state = newState;
-            return true;
+            if (this._has_hooks) {
+                let hook_permits = undefined;
+                const hn = hook_name(this._state, newState), maybe_hook = this._hooks.get(hn);
+                if (maybe_hook === undefined) {
+                    hook_permits = true;
+                }
+                else {
+                    hook_permits = maybe_hook({ from: this._state, to: newState, forced: true });
+                }
+                if (hook_permits !== false) {
+                    this._state = newState;
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+            else {
+                this._state = newState;
+                return true;
+            }
         }
         else {
             return false;
@@ -734,7 +825,9 @@ class Machine {
     }
     current_action_for(action) {
         const action_base = this._actions.get(action);
-        return action_base ? action_base.get(this.state()) : undefined;
+        return action_base
+            ? action_base.get(this.state())
+            : undefined;
     }
     current_action_edge_for(action) {
         const idx = this.current_action_for(action);
@@ -744,13 +837,11 @@ class Machine {
         return this._edges[idx];
     }
     valid_action(action, _newData) {
-        // todo whargarbl implement hooks
         // todo whargarbl implement data stuff
         // todo major incomplete whargarbl comeback
         return this.current_action_for(action) !== undefined;
     }
     valid_transition(newState, _newData) {
-        // todo whargarbl implement hooks
         // todo whargarbl implement data stuff
         // todo major incomplete whargarbl comeback
         const transition_for = this.lookup_transition_for(this.state(), newState);
@@ -763,7 +854,6 @@ class Machine {
         return true;
     }
     valid_force_transition(newState, _newData) {
-        // todo whargarbl implement hooks
         // todo whargarbl implement data stuff
         // todo major incomplete whargarbl comeback
         return (this.lookup_transition_for(this.state(), newState) !== undefined);

package/dist/es6/jssm_types.d.ts

@@ -148,4 +148,29 @@ declare type JssmCompileSeStart<DataType> = {
 };
 declare type JssmParseTree = Array<JssmCompileSeStart<StateType>>;
 declare type JssmParseFunctionType = (string: any) => JssmParseTree;
-export { JssmColor, JssmTransition, JssmTransitions, JssmTransitionList, JssmTransitionRule, JssmArrow, JssmArrowKind, JssmArrowDirection, JssmGenericConfig, JssmGenericState, JssmGenericMachine, JssmParseTree, JssmCompileSe, JssmCompileSeStart, JssmCompileRule, JssmPermitted, JssmPermittedOpt, JssmResult, JssmStateDeclaration, JssmStateDeclarationRule, JssmLayout, JssmParseFunctionType, JssmMachineInternalState, FslDirection, FslTheme };
+declare type HookHandler = Function;
+declare type BasicHookDescription = {
+    kind: 'hook';
+    from: string;
+    to: string;
+    handler: HookHandler;
+};
+declare type HookDescriptionWithAction = {
+    kind: 'named';
+    from: string;
+    to: string;
+    action: string;
+    handler: HookHandler;
+};
+declare type EntryHook = {
+    kind: 'entry';
+    to: string;
+    handler: HookHandler;
+};
+declare type ExitHook = {
+    kind: 'exit';
+    from: string;
+    handler: HookHandler;
+};
+declare type HookDescription = BasicHookDescription | HookDescriptionWithAction | EntryHook | ExitHook;
+export { JssmColor, JssmTransition, JssmTransitions, JssmTransitionList, JssmTransitionRule, JssmArrow, JssmArrowKind, JssmArrowDirection, JssmGenericConfig, JssmGenericState, JssmGenericMachine, JssmParseTree, JssmCompileSe, JssmCompileSeStart, JssmCompileRule, JssmPermitted, JssmPermittedOpt, JssmResult, JssmStateDeclaration, JssmStateDeclarationRule, JssmLayout, JssmParseFunctionType, JssmMachineInternalState, FslDirection, FslTheme, HookDescription, HookHandler };

package/dist/es6/jssm_util.d.ts

@@ -5,4 +5,6 @@ declare const seq: Function;
 declare const histograph: Function;
 declare const weighted_sample_select: Function;
 declare const weighted_histo_key: Function;
-export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string };
+declare const hook_name: (from: string, to: string) => string;
+declare const named_hook_name: (from: string, to: string, action: string) => string;
+export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string, hook_name, named_hook_name };

package/dist/es6/jssm_util.js

@@ -31,4 +31,6 @@ const weighted_histo_key = (n, opts, prob_prop, extract) => // TODO FIXME no any
  histograph(weighted_sample_select(n, opts, prob_prop)
     .map((s) => s[extract] // TODO FIXME eslint-disable-line flowtype/no-weak-types
 ));
-export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string };
+const hook_name = (from, to) => JSON.stringify([from, to]);
+const named_hook_name = (from, to, action) => JSON.stringify([from, to, action]);
+export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string, hook_name, named_hook_name };

package/dist/es6/version.js

@@ -1,2 +1,2 @@
-const version = "5.44.0";
+const version = "5.46.0";
 export { version };