jssm 5.74.0 → 5.76.0

package/jest-dragon.config.js

@@ -0,0 +1,33 @@
+
+module.exports = {
+
+  testEnvironment            : 'node',
+
+  moduleFileExtensions       : ['js', 'ts'],
+  coveragePathIgnorePatterns : ["/node_modules/", "/src/ts/tests/"],
+  testMatch                  : ['**/*.maximal.ts'],
+
+  transform                  : { '^.+\\.ts$': 'ts-jest' },
+
+  verbose                    : false,
+  collectCoverage            : true,
+  coverageDirectory          : "coverage/ksd/",
+
+  coverageThreshold : {
+    global : {
+      branches   : 0,
+      functions  : 0,
+      lines      : 0,
+      statements : 0,
+    },
+  },
+
+  collectCoverageFrom: ["src/ts/**/{!(jssm-dot),}.{js,ts}"],
+
+  reporters: [
+    ['default',             {}],
+    ['jest-json-reporter2', { outputDir: './coverage/ksd', outputFile: 'metrics.json',          fullOutput: false }],
+//  ['jest-json-reporter2', { outputDir: './coverage/ksd', outputFile: 'extended-metrics.json', fullOutput: true  }],
+  ]
+
+};

package/jest-stoch.config.js

@@ -15,13 +15,19 @@ module.exports = {
 
   coverageThreshold : {
     global : {
-      branches   : 1,
-      functions  : 1,
-      lines      : 1,
-      statements : 1,
+      branches   : 0,
+      functions  : 0,
+      lines      : 0,
+      statements : 0,
     },
   },
 
-  collectCoverageFrom: ["src/ts/**/{!(jssm-dot),}.{js,ts}"]
+  collectCoverageFrom: ["src/ts/**/{!(jssm-dot),}.{js,ts}"],
+
+  reporters: [
+    ['default',             {}],
+    ['jest-json-reporter2', { outputDir: './coverage/stoch', outputFile: 'metrics.json',          fullOutput: false }],
+//  ['jest-json-reporter2', { outputDir: './coverage/stoch', outputFile: 'extended-metrics.json', fullOutput: true  }],
+  ]
 
 };

package/jssm_types.d.ts

@@ -1,19 +1,22 @@
 declare type StateType = string;
 declare type JssmSuccess = {
     success: true;
-};
+}; /** Composite type indicating success as part of a result */
 declare type JssmFailure = {
     success: false;
     error: any;
-};
+}; /** Composite type indicating an error, and why, as part of a result */
 declare type JssmIncomplete = {
     success: 'incomplete';
-};
-declare type JssmResult = JssmSuccess | JssmFailure | JssmIncomplete;
+}; /** Composite type indicating that a result isn't finished */
+declare type JssmResult = JssmSuccess | JssmFailure | JssmIncomplete; /** Composite type composing whether or not a result was successful */
 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,7 +255,7 @@ declare type HookComplexResult<mDT> = {
     state?: StateType;
     data?: mDT;
 };
-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;
 };
@@ -261,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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jssm",
-  "version": "5.74.0",
+  "version": "5.76.0",
   "engines": {
     "node": ">=10.0.0"
   },
@@ -28,15 +28,12 @@
   "browser": "dist/jssm.es5.iife.js",
   "types": "./jssm.d.ts",
   "scripts": {
-    "jest-spec": "jest -c jest-spec.config.js --color --verbose",
     "jest-stoch": "jest -c jest-stoch.config.js --color --verbose",
+    "jest-dragon": "jest -c jest-dragon.config.js --color --verbose",
+    "jest-spec": "jest -c jest-spec.config.js --color --verbose",
     "jest": "npm run jest-spec",
-    "jjest": "npm run jest-spec && npm run jest-stoch",
     "test": "npm run make && npm run jest",
-    "rmgenerated": "rm -f src/ts/jssm-dot.ts && rm -f src/ts/version.ts && rm -f *.d.ts",
-    "removedir": "rm -rf dist && rm -rf docs",
-    "createdir": "mkdir dist && mkdir docs",
-    "clean": "npm run removedir && npm run rmgenerated && npm run createdir",
+    "clean": "rm -rf dist && rm -rf docs && cd coverage && rm -rf cloc && cd .. && rm -f src/ts/jssm-dot.ts && rm -f src/ts/version.ts && rm -f *.d.ts && mkdir dist && mkdir docs && cd coverage && mkdir cloc && cd ..",
     "peg": "rm -f src/ts/jssm-dot.js && pegjs src/ts/jssm-dot.peg && node src/buildjs/fixparser.js && rm src/ts/jssm-dot.js",
     "make_cjs": "rollup -c",
     "make_iife": "rollup -c rollup.config.iife.js",
@@ -47,7 +44,7 @@
     "audit": "text_audit -r -t major MAJOR wasteful WASTEFUL any mixed fixme FIXME checkme CHECKME testme TESTME stochable STOCHABLE todo TODO comeback COMEBACK whargarbl WHARGARBL -g ./src/ts/**/*.{js,ts}",
     "vet": "npm run eslint && npm run audit",
     "benny": "node ./src/buildjs/benchmark.js",
-    "build": "npm run vet && npm run test && npm run site && npm run changelog && npm run docs && npm run readme",
+    "build": "npm run vet && npm run test && npm run site && npm run changelog && npm run docs && npm run cloc && npm run readme",
     "clean_bench": "npm run test && npm run benny",
     "qbuild": "npm run test",
     "ci_build": "npm run vet && npm run test",
@@ -55,8 +52,9 @@
     "min_iife": "mv dist/jssm.es5.iife.js dist/jssm.es5.iife.nonmin.js && terser dist/jssm.es5.iife.nonmin.js > dist/jssm.es5.iife.js",
     "min_cjs": "mv dist/jssm.es5.cjs.js dist/jssm.es5.cjs.nonmin.js && terser dist/jssm.es5.cjs.nonmin.js > dist/jssm.es5.cjs.js",
     "site": "cp src/site/* docs/ && cp -r src/assets docs/assets/",
-    "docs": "typedoc src/ts/jssm.ts --options typedoc-options.js",
-    "readme": "rm ./README.md && node ./src/buildjs/make_readme.js",
+    "docs": "typedoc src/ts/jssm.ts src/ts/jssm_types.ts src/ts/jssm_constants.ts src/ts/jssm_error.ts src/ts/jssm_util.ts src/ts/version.ts --options typedoc-options.js",
+    "cloc": "cloc --quiet ./src/** --exclude-list-file=./.clocignore --3 --json --out=./coverage/cloc/report_wt.json && cloc --quiet ./src/** --exclude-list-file=./.clocignore --exclude-dir=tests --3 --json --out=./coverage/cloc/report_nt.json && node ./src/buildjs/cloc_report.js",
+    "readme": "rm -f ./README.md && node ./src/buildjs/make_readme.js",
     "changelog": "rm -f CHANGELOG.md && rm -f ./src/doc_md/CHANGELOG.md && better_git_changelog -b && cp CHANGELOG.* ./src/doc_md/"
   },
   "repository": {
@@ -107,9 +105,10 @@
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-replace": "^4.0.0",
     "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.13.0",
-    "@typescript-eslint/parser": "^4.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.30.4",
+    "@typescript-eslint/parser": "^5.30.4",
     "benny": "^3.7.1",
+    "cloc": "^2.9.0",
     "coveralls": "^3.0.11",
     "eslint": "^7.32.0",
     "eslint-plugin-fp": "^2.3.0",
@@ -127,12 +126,14 @@
     "terser": "^5.13.1",
     "text_audit": "^0.9.3",
     "ts-jest": "^27.0.7",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.6.4"
+    "typedoc": "^0.22.18",
+    "typescript": "^4.7.4",
+    "xml2js": "^0.4.23"
   },
   "dependencies": {
-    "circular_buffer_js": "^1.10.0",
     "better_git_changelog": "^1.6.1",
-    "reduce-to-639-1": "^1.0.4"
+    "circular_buffer_js": "^1.10.0",
+    "reduce-to-639-1": "^1.0.4",
+    "typedoc-plugin-missing-exports": "^0.23.0"
   }
 }