jssm 5.75.1 → 5.77.0

package/dist/es6/jssm.d.ts

@@ -685,7 +685,7 @@ declare class Machine<mDT> {
     action(actionName: StateType, newData?: mDT): boolean;
     /********
      *
-     *  Instruct the machine to complete a transition.
+     *  Instruct the machine to complete a transition.  Synonym for {@link go}.
      *
      *  ```typescript
      *  const light = sm`red -> green -> yellow -> red; [red yellow green] 'shutdown' ~> off 'start' -> red;`;
@@ -703,6 +703,26 @@ declare class Machine<mDT> {
      *
      */
     transition(newState: StateType, newData?: mDT): boolean;
+    /********
+     *
+     *  Instruct the machine to complete a transition.  Synonym for {@link transition}.
+     *
+     *  ```typescript
+     *  const light = sm`red -> green -> yellow -> red; [red yellow green] 'shutdown' ~> off 'start' -> red;`;
+     *
+     *  light.state();       // 'red'
+     *  light.go('green');   // true
+     *  light.state();       // 'green'
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     *  @param newState The state to switch to
+     *
+     *  @param newData The data change to insert during the transition
+     *
+     */
+    go(newState: StateType, newData?: mDT): boolean;
     /********
      *
      *  Instruct the machine to complete a forced transition (which will reject if

package/dist/es6/jssm.js

@@ -1052,7 +1052,8 @@ class Machine {
         if (!(wstate)) {
             throw new JssmError(this, `No such state ${JSON.stringify(whichState)} in probable_exits_for`);
         }
-        const wstate_to = wstate.to, wtf = wstate_to
+        const wstate_to = wstate.to, wtf // wstate_to_filtered -> wtf
+         = wstate_to
             .map((ws) => this.lookup_transition_for(this.state(), ws))
             .filter(Boolean);
         return wtf;
@@ -1745,7 +1746,7 @@ class Machine {
     }
     /********
      *
-     *  Instruct the machine to complete a transition.
+     *  Instruct the machine to complete a transition.  Synonym for {@link go}.
      *
      *  ```typescript
      *  const light = sm`red -> green -> yellow -> red; [red yellow green] 'shutdown' ~> off 'start' -> red;`;
@@ -1765,6 +1766,28 @@ class Machine {
     transition(newState, newData) {
         return this.transition_impl(newState, newData, false, false);
     }
+    /********
+     *
+     *  Instruct the machine to complete a transition.  Synonym for {@link transition}.
+     *
+     *  ```typescript
+     *  const light = sm`red -> green -> yellow -> red; [red yellow green] 'shutdown' ~> off 'start' -> red;`;
+     *
+     *  light.state();       // 'red'
+     *  light.go('green');   // true
+     *  light.state();       // 'green'
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     *  @param newState The state to switch to
+     *
+     *  @param newData The data change to insert during the transition
+     *
+     */
+    go(newState, newData) {
+        return this.transition_impl(newState, newData, false, false);
+    }
     /********
      *
      *  Instruct the machine to complete a forced transition (which will reject if

package/dist/es6/jssm_types.d.ts

@@ -14,6 +14,9 @@ declare type JssmColor = string;
 declare type JssmPermitted = 'required' | 'disallowed';
 declare type JssmPermittedOpt = 'required' | 'disallowed' | 'optional';
 declare type JssmArrow = '->' | '<-' | '<->' | '<=->' | '<~->' | '=>' | '<=' | '<=>' | '<-=>' | '<~=>' | '~>' | '<~' | '<~>' | '<-~>' | '<=~>';
+/**
+ * A type teaching Typescript the various supported shapes for nodes, mostly inherited from GraphViz
+ */
 declare type JssmShape = "box" | "polygon" | "ellipse" | "oval" | "circle" | "point" | "egg" | "triangle" | "plaintext" | "plain" | "diamond" | "trapezium" | "parallelogram" | "house" | "pentagon" | "hexagon" | "septagon" | "octagon" | "doublecircle" | "doubleoctagon" | "tripleoctagon" | "invtriangle" | "invtrapezium" | "invhouse" | "Mdiamond" | "Msquare" | "Mcircle" | "rect" | "rectangle" | "square" | "star" | "none" | "underline" | "cylinder" | "note" | "tab" | "folder" | "box3d" | "component" | "promoter" | "cds" | "terminator" | "utr" | "primersite" | "restrictionsite" | "fivepoverhang" | "threepoverhang" | "noverhang" | "assembly" | "signature" | "insulator" | "ribosite" | "rnastab" | "proteasesite" | "proteinstab" | "rpromoter" | "rarrow" | "larrow" | "lpromoter" | "record";
 declare type JssmArrowDirection = 'left' | 'right' | 'both';
 declare type JssmArrowKind = 'none' | 'legal' | 'main' | 'forced';
@@ -252,10 +255,7 @@ declare type HookComplexResult<mDT> = {
     state?: StateType;
     data?: mDT;
 };
-/********
- * Documents whether a hook succeeded, either with a primitive or a reference to the hook complex object
- */
-declare type HookResult<mDT> = true | false | undefined | void | HookComplexResult<mDT>;
+declare type HookResult<mDT> = true | false | undefined | void | HookComplexResult<mDT>; /** Documents whether a hook succeeded, either with a primitive or a reference to the hook complex object */
 declare type HookContext<mDT> = {
     data: mDT;
 };
@@ -264,4 +264,4 @@ declare type PostHookHandler<mDT> = (hook_context: HookContext<mDT>) => void;
 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, 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, JssmLayout, JssmParseFunctionType, JssmMachineInternalState, JssmErrorExtendedInfo, FslDirection, FslTheme, HookDescription, HookHandler, HookContext, HookResult, HookComplexResult };

package/dist/es6/jssm_util.d.ts

@@ -49,4 +49,12 @@ 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 };
+/*******
+ *
+ *  Creates a Mulberry32 random generator.  Used by the randomness test suite.
+ *
+ *  Sourced from `bryc` at StackOverflow: https://stackoverflow.com/a/47593316/763127
+ *
+ */
+declare const make_mulberry_rand: (a?: number | undefined) => () => number;
+export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string, hook_name, named_hook_name, make_mulberry_rand };

package/dist/es6/jssm_util.js

@@ -84,4 +84,20 @@ 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 };
+/*******
+ *
+ *  Creates a Mulberry32 random generator.  Used by the randomness test suite.
+ *
+ *  Sourced from `bryc` at StackOverflow: https://stackoverflow.com/a/47593316/763127
+ *
+ */
+const make_mulberry_rand = (a) => () => {
+    if (a === undefined) {
+        a = new Date().getTime();
+    }
+    let t = a += 0x6D2B79F5;
+    t = Math.imul(t ^ t >>> 15, t | 1);
+    t ^= t + Math.imul(t ^ t >>> 7, t | 61);
+    return ((t ^ t >>> 14) >>> 0) / 4294967296;
+};
+export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string, hook_name, named_hook_name, make_mulberry_rand };

package/dist/es6/version.js

@@ -1,2 +1,2 @@
-const version = "5.75.1";
+const version = "5.77.0";
 export { version };