jssm 5.71.1 → 5.72.2

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-917 merges; 114 releases; Changlogging the last 10 commits; Full changelog at [CHANGELOG.long.md](CHANGELOG.long.md)
+920 merges; 114 releases; Changlogging the last 10 commits; Full changelog at [CHANGELOG.long.md](CHANGELOG.long.md)
 
 
 
@@ -22,13 +22,13 @@ Published tags:
 
  
 
-## [Untagged] - 6/23/2022 1:41:18 PM
+## [Untagged] - 6/24/2022 4:55:33 PM
 
-Commit [67c3240798d31933413aab27db7ea9fbb5de3b2a](https://github.com/StoneCypher/jssm/commit/67c3240798d31933413aab27db7ea9fbb5de3b2a)
+Commit [547e35599ed312bf5300d3f1685e2cb16b80a73e](https://github.com/StoneCypher/jssm/commit/547e35599ed312bf5300d3f1685e2cb16b80a73e)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Normalize arguments to hooks, fixes StoneCypher/fsl#895; more docs
+  * Can read data from outside, fixes StoneCypher/fsl#929
 
 
 
@@ -37,15 +37,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__36" />
+## [Untagged] - 6/24/2022 4:08:35 PM
 
-## [5.70.36] - 6/21/2022 6:53:36 PM
-
-Commit [093db23b719161e35e477cc0fe7d9f1132bc28b8](https://github.com/StoneCypher/jssm/commit/093db23b719161e35e477cc0fe7d9f1132bc28b8)
+Commit [a1c43e9f65f2fd8e856a2544f7c3056b4c06d9d3](https://github.com/StoneCypher/jssm/commit/a1c43e9f65f2fd8e856a2544f7c3056b4c06d9d3)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Another trivial build - this one to cause chain publishment
+  * First steps towards being a Moore machine - initial data in constructor fixes StoneCypher/fsl#923 , can read in hooks fixes StoneCypher/fsl#924
 
 
 
@@ -54,15 +52,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__35" />
+## [Untagged] - 6/23/2022 6:34:38 PM
 
-## [5.70.35] - 6/19/2022 10:56:41 AM
-
-Commit [13ee9eb71ca9ab868699e535abf6ba30c8ad5829](https://github.com/StoneCypher/jssm/commit/13ee9eb71ca9ab868699e535abf6ba30c8ad5829)
+Commit [1dc7c24bfb651eec57fddc902f78db796f71a6c5](https://github.com/StoneCypher/jssm/commit/1dc7c24bfb651eec57fddc902f78db796f71a6c5)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * new trigger with replaced token - this time with a bump
+  * Small documentation tweaks.  First attempt to lodge on deno.land
 
 
 
@@ -71,13 +67,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-## [Untagged] - 6/19/2022 10:37:04 AM
+## [Untagged] - 6/23/2022 1:41:18 PM
 
-Commit [b3e69d9745b92d845bedcfbc08f342997137af3d](https://github.com/StoneCypher/jssm/commit/b3e69d9745b92d845bedcfbc08f342997137af3d)
+Commit [67c3240798d31933413aab27db7ea9fbb5de3b2a](https://github.com/StoneCypher/jssm/commit/67c3240798d31933413aab27db7ea9fbb5de3b2a)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * new trigger with replaced token
+  * Normalize arguments to hooks, fixes StoneCypher/fsl#895; more docs
 
 
 
@@ -86,15 +82,15 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__34" />
+<a name="5__70__36" />
 
-## [5.70.34] - 6/18/2022 9:40:31 PM
+## [5.70.36] - 6/21/2022 6:53:36 PM
 
-Commit [a0f295f060c7f08a8b10b2208dd1c95dc7f3c97a](https://github.com/StoneCypher/jssm/commit/a0f295f060c7f08a8b10b2208dd1c95dc7f3c97a)
+Commit [093db23b719161e35e477cc0fe7d9f1132bc28b8](https://github.com/StoneCypher/jssm/commit/093db23b719161e35e477cc0fe7d9f1132bc28b8)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * another trigger commit with mild doc extension
+  * Another trivial build - this one to cause chain publishment
 
 
 
@@ -103,15 +99,15 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__33" />
+<a name="5__70__35" />
 
-## [5.70.33] - 6/18/2022 8:57:42 PM
+## [5.70.35] - 6/19/2022 10:56:41 AM
 
-Commit [ca254f455f2c19f21e77834e993c310e05272822](https://github.com/StoneCypher/jssm/commit/ca254f455f2c19f21e77834e993c310e05272822)
+Commit [13ee9eb71ca9ab868699e535abf6ba30c8ad5829](https://github.com/StoneCypher/jssm/commit/13ee9eb71ca9ab868699e535abf6ba30c8ad5829)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * holy another facile build for triggering, batman
+  * new trigger with replaced token - this time with a bump
 
 
 
@@ -120,15 +116,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__32" />
-
-## [5.70.32] - 6/18/2022 8:48:07 PM
+## [Untagged] - 6/19/2022 10:37:04 AM
 
-Commit [8115e8b62d8ac1cff3c7eb07afabced097f1be42](https://github.com/StoneCypher/jssm/commit/8115e8b62d8ac1cff3c7eb07afabced097f1be42)
+Commit [b3e69d9745b92d845bedcfbc08f342997137af3d](https://github.com/StoneCypher/jssm/commit/b3e69d9745b92d845bedcfbc08f342997137af3d)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * yet another small commit as a trigger, this time to get the extended diff
+  * new trigger with replaced token
 
 
 
@@ -137,15 +131,15 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__31" />
+<a name="5__70__34" />
 
-## [5.70.31] - 6/18/2022 8:00:06 PM
+## [5.70.34] - 6/18/2022 9:40:31 PM
 
-Commit [de3d8a105aa85045a9f19ed46b4b3c5e5fb1e235](https://github.com/StoneCypher/jssm/commit/de3d8a105aa85045a9f19ed46b4b3c5e5fb1e235)
+Commit [a0f295f060c7f08a8b10b2208dd1c95dc7f3c97a](https://github.com/StoneCypher/jssm/commit/a0f295f060c7f08a8b10b2208dd1c95dc7f3c97a)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * another small commit as a trigger, this time to get the diff
+  * another trigger commit with mild doc extension
 
 
 
@@ -154,15 +148,15 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__30" />
+<a name="5__70__33" />
 
-## [5.70.30] - 6/18/2022 10:54:02 AM
+## [5.70.33] - 6/18/2022 8:57:42 PM
 
-Commit [3211f94bb943a63ae07f202eb168916d73f94f90](https://github.com/StoneCypher/jssm/commit/3211f94bb943a63ae07f202eb168916d73f94f90)
+Commit [ca254f455f2c19f21e77834e993c310e05272822](https://github.com/StoneCypher/jssm/commit/ca254f455f2c19f21e77834e993c310e05272822)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * missing closing div tag was breaking examples page
+  * holy another facile build for triggering, batman
 
 
 
@@ -171,12 +165,12 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__70__29" />
+<a name="5__70__32" />
 
-## [5.70.29] - 6/18/2022 8:40:30 AM
+## [5.70.32] - 6/18/2022 8:48:07 PM
 
-Commit [7373cfa90383dc2adbe0649be86cb89bef1c0518](https://github.com/StoneCypher/jssm/commit/7373cfa90383dc2adbe0649be86cb89bef1c0518)
+Commit [8115e8b62d8ac1cff3c7eb07afabced097f1be42](https://github.com/StoneCypher/jssm/commit/8115e8b62d8ac1cff3c7eb07afabced097f1be42)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * One more build to trigger remote.
+  * yet another small commit as a trigger, this time to get the extended diff

package/dist/es6/jssm.d.ts

@@ -208,6 +208,7 @@ declare class Machine<mDT> {
     _raw_state_declaration?: Array<Object>;
     _state_declarations: Map<StateType, JssmStateDeclaration>;
     _instance_name: string;
+    _data?: mDT;
     _graph_layout: JssmLayout;
     _dot_preamble: string;
     _arrange_declaration: Array<Array<StateType>>;
@@ -227,12 +228,12 @@ declare class Machine<mDT> {
     _entry_hooks: Map<string, Function>;
     _exit_hooks: Map<string, Function>;
     _global_action_hooks: Map<string, Function>;
-    _any_action_hook: HookHandler | undefined;
-    _standard_transition_hook: HookHandler | undefined;
-    _main_transition_hook: HookHandler | undefined;
-    _forced_transition_hook: HookHandler | undefined;
-    _any_transition_hook: HookHandler | undefined;
-    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, instance_name }: JssmGenericConfig<mDT>);
+    _any_action_hook: HookHandler<mDT> | undefined;
+    _standard_transition_hook: HookHandler<mDT> | undefined;
+    _main_transition_hook: HookHandler<mDT> | undefined;
+    _forced_transition_hook: HookHandler<mDT> | undefined;
+    _any_transition_hook: HookHandler<mDT> | undefined;
+    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, instance_name, data }: JssmGenericConfig<mDT>);
     /********
      *
      *  Internal method for fabricating states.  Not meant for external use.
@@ -259,6 +260,21 @@ declare class Machine<mDT> {
      *
      */
     state(): StateType;
+    /*********
+     *
+     *  Get the current data of a machine.
+     *
+     *  ```typescript
+     *  import * as jssm from 'jssm';
+     *
+     *  const switch = jssm.from('on <=> off;', {data: 1});
+     *  console.log( switch.data() );              // 1
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     */
+    data(): mDT;
     /********
      *
      *  Check whether a given state is final (either has no exits or is marked
@@ -522,17 +538,17 @@ 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>;
-    hook_action(from: string, to: string, action: string, handler: HookHandler): Machine<mDT>;
-    hook_global_action(action: string, handler: HookHandler): Machine<mDT>;
-    hook_any_action(handler: HookHandler): Machine<mDT>;
-    hook_standard_transition(handler: HookHandler): Machine<mDT>;
-    hook_main_transition(handler: HookHandler): Machine<mDT>;
-    hook_forced_transition(handler: HookHandler): Machine<mDT>;
-    hook_any_transition(handler: HookHandler): Machine<mDT>;
-    hook_entry(to: string, handler: HookHandler): Machine<mDT>;
-    hook_exit(from: string, handler: HookHandler): Machine<mDT>;
+    set_hook(HookDesc: HookDescription<mDT>): void;
+    hook(from: string, to: string, handler: HookHandler<mDT>): Machine<mDT>;
+    hook_action(from: string, to: string, action: string, handler: HookHandler<mDT>): Machine<mDT>;
+    hook_global_action(action: string, handler: HookHandler<mDT>): Machine<mDT>;
+    hook_any_action(handler: HookHandler<mDT>): Machine<mDT>;
+    hook_standard_transition(handler: HookHandler<mDT>): Machine<mDT>;
+    hook_main_transition(handler: HookHandler<mDT>): Machine<mDT>;
+    hook_forced_transition(handler: HookHandler<mDT>): Machine<mDT>;
+    hook_any_transition(handler: HookHandler<mDT>): Machine<mDT>;
+    hook_entry(to: string, handler: HookHandler<mDT>): Machine<mDT>;
+    hook_exit(from: string, handler: HookHandler<mDT>): Machine<mDT>;
     edges_between(from: string, to: string): JssmTransition<mDT>[];
     transition_impl(newStateOrAction: StateType, newData: mDT | undefined, wasForced: boolean, wasAction: boolean): boolean;
     /********

package/dist/es6/jssm.js

@@ -534,7 +534,7 @@ function transfer_state_properties(state_decl) {
 // TODO add a lotta docblock here
 class Machine {
     // whargarbl this badly needs to be broken up, monolith master
-    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 = undefined, arrange_declaration = [], arrange_start_declaration = [], arrange_end_declaration = [], theme = 'default', flow = 'down', graph_layout = 'dot', instance_name }) {
+    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 = undefined, arrange_declaration = [], arrange_start_declaration = [], arrange_end_declaration = [], theme = 'default', flow = 'down', graph_layout = 'dot', instance_name, data }) {
         this._instance_name = instance_name;
         this._state = start_states[0];
         this._states = new Map();
@@ -581,6 +581,7 @@ class Machine {
         this._forced_transition_hook = undefined;
         this._any_transition_hook = undefined;
         this._standard_transition_hook = undefined;
+        this._data = data;
         if (state_declaration) {
             state_declaration.map((state_decl) => {
                 if (this._state_declarations.has(state_decl.state)) { // no repeats
@@ -718,6 +719,30 @@ class Machine {
         return true; // todo whargarbl
       }
     */
+    /*********
+     *
+     *  Get the current data of a machine.
+     *
+     *  ```typescript
+     *  import * as jssm from 'jssm';
+     *
+     *  const switch = jssm.from('on <=> off;', {data: 1});
+     *  console.log( switch.data() );              // 1
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     */
+    data() {
+        return this._data;
+    }
+    /* whargarbl todo major
+       when we reimplement this, reintroduce this change to the is_final call
+  
+      is_changing(): boolean {
+        return true; // todo whargarbl
+      }
+    */
     /********
      *
      *  Check whether a given state is final (either has no exits or is marked
@@ -1229,52 +1254,42 @@ class Machine {
         }
     }
     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;
     }
     hook_action(from, to, action, handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'named', from, to, action, handler });
         return this;
     }
     hook_global_action(action, handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'global action', action, handler });
         return this;
     }
     hook_any_action(handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'any action', handler });
         return this;
     }
     hook_standard_transition(handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'standard transition', handler });
         return this;
     }
     hook_main_transition(handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'main transition', handler });
         return this;
     }
     hook_forced_transition(handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'forced transition', handler });
         return this;
     }
     hook_any_transition(handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'any transition', handler });
         return this;
     }
     hook_entry(to, handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'entry', to, handler });
         return this;
     }
     hook_exit(from, handler) {
-        // TODO: should this throw if setting the hook fails, or ignore it and continue?
         this.set_hook({ kind: 'exit', from, handler });
         return this;
     }
@@ -1317,7 +1332,7 @@ class Machine {
         // todo major incomplete whargarbl comeback
         if (valid) {
             if (this._has_hooks) {
-                const hook_args = { action: fromAction, from: this._state, to: newState, forced: wasForced };
+                const hook_args = { data: this._data, action: fromAction, from: this._state, to: newState, forced: wasForced };
                 if (wasAction) {
                     // 1. any action hook
                     if (this._any_action_hook !== undefined) {

package/dist/es6/jssm_types.d.ts

@@ -149,57 +149,61 @@ declare type JssmCompileSeStart<DataType> = {
 };
 declare type JssmParseTree = Array<JssmCompileSeStart<StateType>>;
 declare type JssmParseFunctionType = (string: any) => JssmParseTree;
-declare type HookHandler = Function;
-declare type BasicHookDescription = {
+declare type BasicHookDescription<mDT> = {
     kind: 'hook';
     from: string;
     to: string;
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type HookDescriptionWithAction = {
+declare type HookDescriptionWithAction<mDT> = {
     kind: 'named';
     from: string;
     to: string;
     action: string;
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type StandardTransitionHook = {
+declare type StandardTransitionHook<mDT> = {
     kind: 'standard transition';
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type MainTransitionHook = {
+declare type MainTransitionHook<mDT> = {
     kind: 'main transition';
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type ForcedTransitionHook = {
+declare type ForcedTransitionHook<mDT> = {
     kind: 'forced transition';
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type AnyTransitionHook = {
+declare type AnyTransitionHook<mDT> = {
     kind: 'any transition';
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type GlobalActionHook = {
+declare type GlobalActionHook<mDT> = {
     kind: 'global action';
     action: string;
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type AnyActionHook = {
+declare type AnyActionHook<mDT> = {
     kind: 'any action';
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type EntryHook = {
+declare type EntryHook<mDT> = {
     kind: 'entry';
     to: string;
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type ExitHook = {
+declare type ExitHook<mDT> = {
     kind: 'exit';
     from: string;
-    handler: HookHandler;
+    handler: HookHandler<mDT>;
 };
-declare type HookDescription = BasicHookDescription | HookDescriptionWithAction | GlobalActionHook | AnyActionHook | StandardTransitionHook | MainTransitionHook | ForcedTransitionHook | AnyTransitionHook | EntryHook | ExitHook;
+declare type HookDescription<mDT> = BasicHookDescription<mDT> | HookDescriptionWithAction<mDT> | GlobalActionHook<mDT> | AnyActionHook<mDT> | StandardTransitionHook<mDT> | MainTransitionHook<mDT> | ForcedTransitionHook<mDT> | AnyTransitionHook<mDT> | EntryHook<mDT> | ExitHook<mDT>;
+declare type HookResult = true | false | undefined | void;
+declare type HookContext<mDT> = {
+    data: mDT;
+};
+declare type HookHandler<mDT> = (hook_context: HookContext<mDT>) => HookResult;
 declare type JssmErrorExtendedInfo = {
     requested_state?: StateType | undefined;
 };
-export { JssmColor, JssmTransition, JssmTransitions, JssmTransitionList, JssmTransitionRule, JssmArrow, JssmArrowKind, JssmArrowDirection, JssmGenericConfig, JssmGenericState, JssmGenericMachine, JssmParseTree, JssmCompileSe, JssmCompileSeStart, JssmCompileRule, JssmPermitted, JssmPermittedOpt, JssmResult, JssmStateDeclaration, JssmStateDeclarationRule, JssmLayout, JssmParseFunctionType, JssmMachineInternalState, JssmErrorExtendedInfo, FslDirection, FslTheme, HookDescription, HookHandler };
+export { JssmColor, JssmTransition, JssmTransitions, JssmTransitionList, JssmTransitionRule, JssmArrow, JssmArrowKind, JssmArrowDirection, JssmGenericConfig, JssmGenericState, JssmGenericMachine, JssmParseTree, JssmCompileSe, JssmCompileSeStart, JssmCompileRule, JssmPermitted, JssmPermittedOpt, JssmResult, JssmStateDeclaration, JssmStateDeclarationRule, JssmLayout, JssmParseFunctionType, JssmMachineInternalState, JssmErrorExtendedInfo, FslDirection, FslTheme, HookDescription, HookHandler, HookResult };

package/dist/es6/version.js

@@ -1,2 +1,2 @@
-const version = "5.71.1";
+const version = "5.72.2";
 export { version };