jssm 5.85.6 → 5.85.9

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-1051 merges; 167 releases; Changlogging the last 10 commits; Full changelog at [CHANGELOG.long.md](CHANGELOG.long.md)
+1056 merges; 167 releases; Changlogging the last 10 commits; Full changelog at [CHANGELOG.long.md](CHANGELOG.long.md)
 
 
 
@@ -22,13 +22,14 @@ Published tags:
 
  
 
-## [Untagged] - 9/12/2022 3:27:58 PM
+## [Untagged] - 9/12/2022 8:18:05 PM
 
-Commit [4b9fefde004f1c1ac5f36ad760105109475af95a](https://github.com/StoneCypher/jssm/commit/4b9fefde004f1c1ac5f36ad760105109475af95a)
+Commit [013999a77ce43ceed5eb982754ffe480fdddf159](https://github.com/StoneCypher/jssm/commit/013999a77ce43ceed5eb982754ffe480fdddf159)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * expose build date directly on module (also -viz and -demo,) support logging in -demo
+  * Pull arrows out into modules
+  * Fixes StoneCypher/fsl#1206
 
 
 
@@ -37,15 +38,14 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__85__5" />
+## [Untagged] - 9/12/2022 7:19:21 PM
 
-## [5.85.5] - 9/12/2022 3:10:10 PM
-
-Commit [35ad7228d5bb15d963a2e4d9e6e35721cce36b33](https://github.com/StoneCypher/jssm/commit/35ad7228d5bb15d963a2e4d9e6e35721cce36b33)
+Commit [771f4c8d67274b40451ae6dfef168fe3c15949df](https://github.com/StoneCypher/jssm/commit/771f4c8d67274b40451ae6dfef168fe3c15949df)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Add build time to module
+  * Add tests for unicode labels (atom and string)
+  * Fixes StoneCypher/fsl#1193, fixes StoneCypher/fsl#1194
 
 
 
@@ -54,15 +54,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__85__4" />
-
-## [5.85.4] - 9/12/2022 1:55:57 PM
+## [Untagged] - 9/12/2022 6:52:26 PM
 
-Commit [293e2cb9c07734fef562b455d786b7c63ea7647b](https://github.com/StoneCypher/jssm/commit/293e2cb9c07734fef562b455d786b7c63ea7647b)
+Commit [3eb246ddb992372ceca4c0adc9dc45295a0a7177](https://github.com/StoneCypher/jssm/commit/3eb246ddb992372ceca4c0adc9dc45295a0a7177)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Clean up the gh action a skosh
+  * Return twitter envvar to GHA yaml
 
 
 
@@ -71,18 +69,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__85__3" />
-
-## [5.85.3] - 9/12/2022 11:25:36 AM
+## [Untagged] - 9/12/2022 6:52:26 PM
 
-Commit [87ec233d3511d30358660ad161f932e13eb1738e](https://github.com/StoneCypher/jssm/commit/87ec233d3511d30358660ad161f932e13eb1738e)
+Commit [3a01b8d7ae2cee185e4f36c90a95338bf30002cb](https://github.com/StoneCypher/jssm/commit/3a01b8d7ae2cee185e4f36c90a95338bf30002cb)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-Merges [98b7b14, 6475296]
-
-  * Merge pull request #540 from StoneCypher/ReintroduceDisplayText
-  * Reintroduce display text, lost in a bad merge
+  * that wasn't supposed to be removed...
 
 
 
@@ -91,13 +84,14 @@ Merges [98b7b14, 6475296]
 
 &nbsp;
 
-## [Untagged] - 9/12/2022 11:24:38 AM
+## [Untagged] - 9/12/2022 6:39:19 PM
 
-Commit [6475296d979dab3d227828b80319d60c4f6ab2f5](https://github.com/StoneCypher/jssm/commit/6475296d979dab3d227828b80319d60c4f6ab2f5)
+Commit [37c0bdf33263bf4b9dd60ba329108297cf5ea68f](https://github.com/StoneCypher/jssm/commit/37c0bdf33263bf4b9dd60ba329108297cf5ea68f)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Reintroduce display text, lost in a bad merge
+  * Prevent request of illegal state as start state
+  * Fixes StoneCypher/fsl#1203, fixes StoneCypher/fsl#1204, fixes StoneCypher/fsl#1205
 
 
 
@@ -106,18 +100,13 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__85__2" />
-
-## [5.85.2] - 9/12/2022 10:03:27 AM
+## [Untagged] - 9/12/2022 3:27:58 PM
 
-Commit [98b7b14217ea7e83550e4ed15b6b6be80799e246](https://github.com/StoneCypher/jssm/commit/98b7b14217ea7e83550e4ed15b6b6be80799e246)
+Commit [4b9fefde004f1c1ac5f36ad760105109475af95a](https://github.com/StoneCypher/jssm/commit/4b9fefde004f1c1ac5f36ad760105109475af95a)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-Merges [461a287, 0f3025a]
-
-  * Merge pull request #539 from StoneCypher/TrimTweet
-  * Shorten the tweet notice
+  * expose build date directly on module (also -viz and -demo,) support logging in -demo
 
 
 
@@ -126,13 +115,15 @@ Merges [461a287, 0f3025a]
 
 &nbsp;
 
-## [Untagged] - 9/12/2022 9:59:52 AM
+<a name="5__85__5" />
 
-Commit [0f3025ae2e484afbda57b5f39f5485c4831e7ce7](https://github.com/StoneCypher/jssm/commit/0f3025ae2e484afbda57b5f39f5485c4831e7ce7)
+## [5.85.5] - 9/12/2022 3:10:10 PM
+
+Commit [35ad7228d5bb15d963a2e4d9e6e35721cce36b33](https://github.com/StoneCypher/jssm/commit/35ad7228d5bb15d963a2e4d9e6e35721cce36b33)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Shorten the tweet notice
+  * Add build time to module
 
 
 
@@ -141,18 +132,15 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__85__1" />
+<a name="5__85__4" />
 
-## [5.85.1] - 9/12/2022 9:49:05 AM
+## [5.85.4] - 9/12/2022 1:55:57 PM
 
-Commit [461a2874583d08da6db68e40b75047682625c73d](https://github.com/StoneCypher/jssm/commit/461a2874583d08da6db68e40b75047682625c73d)
+Commit [293e2cb9c07734fef562b455d786b7c63ea7647b](https://github.com/StoneCypher/jssm/commit/293e2cb9c07734fef562b455d786b7c63ea7647b)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-Merges [2eec2c8, 76d6729]
-
-  * Merge pull request #538 from StoneCypher/RemoveYmlEcho
-  * Remove noisy echo in the YML
+  * Clean up the gh action a skosh
 
 
 
@@ -161,13 +149,18 @@ Merges [2eec2c8, 76d6729]
 
 &nbsp;
 
-## [Untagged] - 9/12/2022 9:35:11 AM
+<a name="5__85__3" />
+
+## [5.85.3] - 9/12/2022 11:25:36 AM
 
-Commit [76d6729a35a3f4eba666ff2d78cd284ed0668edd](https://github.com/StoneCypher/jssm/commit/76d6729a35a3f4eba666ff2d78cd284ed0668edd)
+Commit [87ec233d3511d30358660ad161f932e13eb1738e](https://github.com/StoneCypher/jssm/commit/87ec233d3511d30358660ad161f932e13eb1738e)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-  * Remove noisy echo in the YML
+Merges [98b7b14, 6475296]
+
+  * Merge pull request #540 from StoneCypher/ReintroduceDisplayText
+  * Reintroduce display text, lost in a bad merge
 
 
 
@@ -176,15 +169,10 @@ Author: `John Haugeland <stonecypher@gmail.com>`
 
 &nbsp;
 
-<a name="5__85__0" />
-
-## [5.85.0] - 9/12/2022 9:22:37 AM
+## [Untagged] - 9/12/2022 11:24:38 AM
 
-Commit [2eec2c8b69d3e59cb06d7b0efc34b336e9ecc29a](https://github.com/StoneCypher/jssm/commit/2eec2c8b69d3e59cb06d7b0efc34b336e9ecc29a)
+Commit [6475296d979dab3d227828b80319d60c4f6ab2f5](https://github.com/StoneCypher/jssm/commit/6475296d979dab3d227828b80319d60c4f6ab2f5)
 
 Author: `John Haugeland <stonecypher@gmail.com>`
 
-Merges [a7b92f9, a0b9fb5]
-
-  * Merge pull request #537 from StoneCypher/DisplayText
-  * simple display text function to resolve labels and node names
+  * Reintroduce display text, lost in a bad merge

package/README.md

@@ -18,7 +18,7 @@ Please edit the file it's derived from, instead: `./src/md/readme_base.md`
 
 
 
-* Generated for version 5.85.6 at 9/12/2022, 6:34:35 PM
+* Generated for version 5.85.9 at 9/12/2022, 9:03:57 PM
 
 -->
 # jssm
@@ -29,7 +29,7 @@ share online.  Easy to embed.
 
 Readable, useful state machines as one-liner strings.
 
-***4,864 tests*** run 5,755 times.  4,855 specs with 100.0% coverage, 9 fuzz tests with 13.0% coverage.  With 2,714 lines, that's about 1.8 tests per line, or 2.1 generated tests per line.
+***4,866 tests*** run 5,757 times.  4,857 specs with 100.0% coverage, 9 fuzz tests with 13.6% coverage.  With 2,754 lines, that's about 1.8 tests per line, or 2.1 generated tests per line.
 
 ***Meet your new state machine library.***
 

package/dist/es6/jssm.d.ts

@@ -1,183 +1,12 @@
 declare type StateType = string;
 import { JssmGenericState, JssmGenericConfig, JssmStateConfig, JssmTransition, JssmTransitionList, // JssmTransitionRule,
-JssmMachineInternalState, JssmParseTree, JssmStateDeclaration, JssmStateStyleKeyList, JssmArrow, JssmArrowDirection, JssmArrowKind, JssmLayout, JssmHistory, JssmSerialization, FslDirection, FslDirections, FslTheme, HookDescription, HookHandler, HookContext, HookResult, HookComplexResult } from './jssm_types';
+JssmMachineInternalState, 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';
 import * as constants from './jssm_constants';
 declare const shapes: string[], gviz_shapes: string[], named_colors: string[];
 import { version, build_time } from './version';
-/*********
- *
- *  Return the direction of an arrow - `right`, `left`, or `both`.
- *
- *  ```typescript
- *  import { arrow_direction } from 'jssm';
- *
- *  arrow_direction('->');    // 'right'
- *  arrow_direction('<~=>');  // 'both'
- *  ```
- *
- *  @param arrow The arrow to be evaluated
- *
- */
-declare function arrow_direction(arrow: JssmArrow): JssmArrowDirection;
-/*********
- *
- *  Return the direction of an arrow - `right`, `left`, or `both`.
- *
- *  ```typescript
- *  import { arrow_left_kind } from 'jssm';
- *
- *  arrow_left_kind('<-');    // 'legal'
- *  arrow_left_kind('<=');    // 'main'
- *  arrow_left_kind('<~');    // 'forced'
- *  arrow_left_kind('<->');   // 'legal'
- *  arrow_left_kind('->');    // 'none'
- *  ```
- *
- *  @param arrow The arrow to be evaluated
- *
- */
-declare function arrow_left_kind(arrow: JssmArrow): JssmArrowKind;
-/*********
- *
- *  Return the direction of an arrow - `right`, `left`, or `both`.
- *
- *  ```typescript
- *  import { arrow_left_kind } from 'jssm';
- *
- *  arrow_left_kind('->');    // 'legal'
- *  arrow_left_kind('=>');    // 'main'
- *  arrow_left_kind('~>');    // 'forced'
- *  arrow_left_kind('<->');   // 'legal'
- *  arrow_left_kind('<-');    // 'none'
- *  ```
- *
- *  @param arrow The arrow to be evaluated
- *
- */
-declare function arrow_right_kind(arrow: JssmArrow): JssmArrowKind;
-/*********
- *
- *  This method wraps the parser call that comes from the peg grammar,
- *  {@link parse}.  Generally neither this nor that should be used directly
- *  unless you mean to develop plugins or extensions for the machine.
- *
- *  Parses the intermediate representation of a compiled string down to a
- *  machine configuration object.  If you're using this (probably don't,) you're
- *  probably also using {@link compile} and {@link Machine.constructor}.
- *
- *  ```typescript
- *  import { parse, compile, Machine } from 'jssm';
- *
- *  const intermediate = wrap_parse('a -> b;', {});
- *  // [ {key:'transition', from:'a', se:{kind:'->',to:'b'}} ]
- *
- *  const cfg = compile(intermediate);
- *  // { start_states:['a'], transitions: [{ from:'a', to:'b', kind:'legal', forced_only:false, main_path:false }] }
- *
- *  const machine = new Machine(cfg);
- *  // Machine { _instance_name: undefined, _state: 'a', ...
- *  ```
- *
- *  This method is mostly for plugin and intermediate tool authors, or people
- *  who need to work with the machine's intermediate representation.
- *
- *  # Hey!
- *
- *  Most people looking at this want either the `sm` operator or method `from`,
- *  which perform all the steps in the chain.  The library's author mostly uses
- *  operator `sm`, and mostly falls back to `.from` when needing to parse
- *  strings dynamically instead of from template literals.
- *
- *  Operator {@link sm}:
- *
- *  ```typescript
- *  import { sm } from 'jssm';
- *
- *  const lswitch = sm`on <=> off;`;
- *  ```
- *
- *  Method {@link from}:
- *
- *  ```typescript
- *  import * as jssm from 'jssm';
- *
- *  const toggle = jssm.from('up <=> down;');
- *  ```
- *
- *  `wrap_parse` itself is an internal convenience method for alting out an
- *  object as the options call.  Not generally meant for external use.
- *
- *  @param input The FSL code to be evaluated
- *
- *  @param options Things to control about the instance
- *
- */
-declare function wrap_parse(input: string, options?: Object): any;
-/*********
- *
- *  Compile a machine's JSON intermediate representation to a config object.  If
- *  you're using this (probably don't,) you're probably also using
- *  {@link parse} to get the IR, and the object constructor
- *  {@link Machine.construct} to turn the config object into a workable machine.
- *
- *  ```typescript
- *  import { parse, compile, Machine } from 'jssm';
- *
- *  const intermediate = parse('a -> b;');
- *  // [ {key:'transition', from:'a', se:{kind:'->',to:'b'}} ]
- *
- *  const cfg = compile(intermediate);
- *  // { start_states:['a'], transitions: [{ from:'a', to:'b', kind:'legal', forced_only:false, main_path:false }] }
- *
- *  const machine = new Machine(cfg);
- *  // Machine { _instance_name: undefined, _state: 'a', ...
- *  ```
- *
- *  This method is mostly for plugin and intermediate tool authors, or people
- *  who need to work with the machine's intermediate representation.
- *
- *  # Hey!
- *
- *  Most people looking at this want either the `sm` operator or method `from`,
- *  which perform all the steps in the chain.  The library's author mostly uses
- *  operator `sm`, and mostly falls back to `.from` when needing to parse
- *  strings dynamically instead of from template literals.
- *
- *  Operator {@link sm}:
- *
- *  ```typescript
- *  import { sm } from 'jssm';
- *
- *  const lswitch = sm`on <=> off;`;
- *  ```
- *
- *  Method {@link from}:
- *
- *  ```typescript
- *  import * as jssm from 'jssm';
- *
- *  const toggle = jssm.from('up <=> down;');
- *  ```
- *
- *  @typeparam mDT The type of the machine data member; usually omitted
- *
- *  @param tree The parse tree to be boiled down into a machine config
- *
- */
-declare function compile<mDT>(tree: JssmParseTree): JssmGenericConfig<mDT>;
-/*********
- *
- *  An internal convenience wrapper for parsing then compiling a machine string.
- *  Not generally meant for external use.  Please see {@link compile} or
- *  {@link sm}.
- *
- *  @typeparam mDT The type of the machine data member; usually omitted
- *
- *  @param plan The FSL code to be evaluated and built into a machine config
- *
- */
-declare function make<mDT>(plan: string): JssmGenericConfig<mDT>;
 /*********
  *
  *  An internal method meant to take a series of declarations and fold them into
@@ -192,7 +21,7 @@ declare function state_style_condense(jssk: JssmStateStyleKeyList): JssmStateCon
 declare class Machine<mDT> {
     _state: StateType;
     _states: Map<StateType, JssmGenericState>;
-    _edges: Array<JssmTransition<mDT>>;
+    _edges: Array<JssmTransition<StateType, mDT>>;
     _edge_map: Map<StateType, Map<StateType, number>>;
     _named_transitions: Map<StateType, number>;
     _actions: Map<StateType, Map<StateType, number>>;
@@ -267,7 +96,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<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 }: JssmGenericConfig<StateType, mDT>);
     /********
      *
      *  Internal method for fabricating states.  Not meant for external use.
@@ -648,7 +477,7 @@ declare class Machine<mDT> {
      *  @typeparam mDT The type of the machine data member; usually omitted
      *
      */
-    list_edges(): Array<JssmTransition<mDT>>;
+    list_edges(): Array<JssmTransition<StateType, mDT>>;
     list_named_transitions(): Map<StateType, number>;
     list_actions(): Array<StateType>;
     get uses_actions(): boolean;
@@ -657,7 +486,7 @@ declare class Machine<mDT> {
     set themes(to: FslTheme | FslTheme[]);
     flow(): FslDirection;
     get_transition_by_state_names(from: StateType, to: StateType): number;
-    lookup_transition_for(from: StateType, to: StateType): JssmTransition<mDT>;
+    lookup_transition_for(from: StateType, to: StateType): JssmTransition<StateType, mDT>;
     /********
      *
      *  List all transitions attached to the current state, sorted by entrance and
@@ -719,7 +548,7 @@ declare class Machine<mDT> {
      *
      */
     list_exits(whichState?: StateType): Array<StateType>;
-    probable_exits_for(whichState: StateType): Array<JssmTransition<mDT>>;
+    probable_exits_for(whichState: StateType): Array<JssmTransition<StateType, mDT>>;
     probabilistic_transition(): boolean;
     probabilistic_walk(n: number): Array<StateType>;
     probabilistic_histo_walk(n: number): Map<StateType, number>;
@@ -812,7 +641,7 @@ declare class Machine<mDT> {
     post_hook_any_transition(handler: HookHandler<mDT>): Machine<mDT>;
     post_hook_entry(to: string, handler: HookHandler<mDT>): Machine<mDT>;
     post_hook_exit(from: string, handler: HookHandler<mDT>): Machine<mDT>;
-    edges_between(from: string, to: string): JssmTransition<mDT>[];
+    edges_between(from: string, to: string): JssmTransition<StateType, mDT>[];
     transition_impl(newStateOrAction: StateType, newData: mDT | undefined, wasForced: boolean, wasAction: boolean): boolean;
     /*********
      *
@@ -1180,7 +1009,7 @@ declare class Machine<mDT> {
      */
     force_transition(newState: StateType, newData?: mDT): boolean;
     current_action_for(action: StateType): number;
-    current_action_edge_for(action: StateType): JssmTransition<mDT>;
+    current_action_edge_for(action: StateType): JssmTransition<StateType, mDT>;
     valid_action(action: StateType, _newData?: mDT): boolean;
     valid_transition(newState: StateType, _newData?: mDT): boolean;
     valid_force_transition(newState: StateType, _newData?: mDT): boolean;
@@ -1233,7 +1062,7 @@ declare function sm<mDT>(template_strings: TemplateStringsArray, ...remainder: a
  *  @param ExtraConstructorFields Extra non-code configuration to pass at creation time
  *
  */
-declare function from<mDT>(MachineAsString: string, ExtraConstructorFields?: Partial<JssmGenericConfig<mDT>> | undefined): Machine<mDT>;
+declare function from<mDT>(MachineAsString: string, ExtraConstructorFields?: Partial<JssmGenericConfig<StateType, mDT>> | undefined): Machine<mDT>;
 declare function is_hook_complex_result<mDT>(hr: unknown): hr is HookComplexResult<mDT>;
 declare function is_hook_rejection<mDT>(hr: HookResult<mDT>): boolean;
 declare function abstract_hook_step<mDT>(maybe_hook: HookHandler<mDT> | undefined, hook_args: HookContext<mDT>): HookComplexResult<mDT>;