state-machine-cat 10.1.8 → 10.1.9

package/dist/esm/cli/attributes-parser.mjs

@@ -36,16 +36,19 @@ peg$SyntaxError.prototype.format = function (sources) {
             }
         }
         var s = this.location.start;
-        var loc = this.location.source + ":" + s.line + ":" + s.column;
+        var offset_s = (this.location.source && (typeof this.location.source.offset === "function"))
+            ? this.location.source.offset(s)
+            : s;
+        var loc = this.location.source + ":" + offset_s.line + ":" + offset_s.column;
         if (src) {
             var e = this.location.end;
-            var filler = peg$padEnd("", s.line.toString().length, ' ');
+            var filler = peg$padEnd("", offset_s.line.toString().length, ' ');
             var line = src[s.line - 1];
             var last = s.line === e.line ? e.column : line.length + 1;
             var hatLen = (last - s.column) || 1;
             str += "\n --> " + loc + "\n"
                 + filler + " |\n"
-                + s.line + " | " + line + "\n"
+                + offset_s.line + " | " + line + "\n"
                 + filler + " | " + peg$padEnd("", s.column - 1, ' ')
                 + peg$padEnd("", hatLen, "^");
         }
@@ -270,10 +273,10 @@ function peg$parse(input, options) {
             return details;
         }
     }
-    function peg$computeLocation(startPos, endPos) {
+    function peg$computeLocation(startPos, endPos, offset) {
         var startPosDetails = peg$computePosDetails(startPos);
         var endPosDetails = peg$computePosDetails(endPos);
-        return {
+        var res = {
             source: peg$source,
             start: {
                 offset: startPos,
@@ -286,6 +289,11 @@ function peg$parse(input, options) {
                 column: endPosDetails.column
             }
         };
+        if (offset && peg$source && (typeof peg$source.offset === "function")) {
+            res.start = peg$source.offset(res.start);
+            res.end = peg$source.offset(res.end);
+        }
+        return res;
     }
     function peg$fail(expected) {
         if (peg$currPos < peg$maxFailPos) {

package/dist/esm/parse/scxml/index.mjs

@@ -1,6 +1,7 @@
 import fastxml from "fast-xml-parser";
 import he from "he";
 import castArray from "lodash/castArray.js";
+import traverse from "traverse";
 import utl from "../../transform/utl.mjs";
 import parserHelpers from "../parser-helpers.mjs";
 import { normalizeMachine } from "./normalize-machine.mjs";
@@ -118,19 +119,40 @@ function mapMachine(pSCXMLStateMachine) {
     }
     return lReturnValue;
 }
+function deDuplicateAttributesAndTags(pObject, pAttributeNamePrefix) {
+    return traverse(pObject).map(function deDuplicate() {
+        if (this.key?.startsWith(pAttributeNamePrefix)) {
+            const pUnprefixedAttributeName = this.key.slice(pAttributeNamePrefix.length);
+            if (this.parent.keys.includes(pUnprefixedAttributeName)) {
+                this.remove();
+            }
+            else {
+                this.parent.node[pUnprefixedAttributeName] = this.node;
+                this.remove();
+            }
+        }
+    });
+}
 export function parse(pSCXMLString) {
     const lTrimmedSCXMLString = pSCXMLString.trim();
-    if (fastxml.validate(lTrimmedSCXMLString) === true) {
-        const lXMLAsJSON = fastxml.parse(lTrimmedSCXMLString, {
-            attributeNamePrefix: "",
-            ignoreAttributes: false,
-            tagValueProcessor: (pTagValue) => he.decode(pTagValue),
-            stopNodes: ["onentry", "onexit", "transition"],
-        });
-        return mapMachine(lXMLAsJSON?.scxml ?? {
-            xmlns: "http://www.w3.org/2005/07/scxml",
-            version: "1.0",
-        });
+    const lAttributeNamePrefix = "@_";
+    let lXMLAsJSON = {};
+    const lXMLParser = new fastxml.XMLParser({
+        attributeNamePrefix: lAttributeNamePrefix,
+        ignoreAttributes: false,
+        parseTagValue: true,
+        processEntities: false,
+        tagValueProcessor: (_pTagName, pTagValue) => he.decode(pTagValue),
+        stopNodes: ["*.onentry", "*.onexit", "*.transition"],
+    });
+    try {
+        lXMLAsJSON = deDuplicateAttributesAndTags(lXMLParser.parse(lTrimmedSCXMLString, true), lAttributeNamePrefix);
+    }
+    catch (pError) {
+        throw new Error("That doesn't look like valid xml ...\n");
     }
-    throw new Error("That doesn't look like valid xml ...\n");
+    return mapMachine(lXMLAsJSON?.scxml ?? {
+        xmlns: "http://www.w3.org/2005/07/scxml",
+        version: "1.0",
+    });
 }

package/dist/esm/parse/smcat/smcat-parser.mjs

@@ -37,16 +37,19 @@ peg$SyntaxError.prototype.format = function (sources) {
             }
         }
         var s = this.location.start;
-        var loc = this.location.source + ":" + s.line + ":" + s.column;
+        var offset_s = (this.location.source && (typeof this.location.source.offset === "function"))
+            ? this.location.source.offset(s)
+            : s;
+        var loc = this.location.source + ":" + offset_s.line + ":" + offset_s.column;
         if (src) {
             var e = this.location.end;
-            var filler = peg$padEnd("", s.line.toString().length, ' ');
+            var filler = peg$padEnd("", offset_s.line.toString().length, ' ');
             var line = src[s.line - 1];
             var last = s.line === e.line ? e.column : line.length + 1;
             var hatLen = (last - s.column) || 1;
             str += "\n --> " + loc + "\n"
                 + filler + " |\n"
-                + s.line + " | " + line + "\n"
+                + offset_s.line + " | " + line + "\n"
                 + filler + " | " + peg$padEnd("", s.column - 1, ' ')
                 + peg$padEnd("", hatLen, "^");
         }
@@ -339,15 +342,15 @@ function peg$parse(input, options) {
         parserHelpers.setIfNotEmpty(trans, 'note', notes);
         return trans;
     };
-    var peg$f20 = function (from, to) {
+    var peg$f20 = function (from_, to) {
         return {
-            from: from,
+            from: from_,
             to: to
         };
     };
-    var peg$f21 = function (to, from) {
+    var peg$f21 = function (to, from_) {
         return {
-            from: from,
+            from: from_,
             to: to
         };
     };
@@ -481,10 +484,10 @@ function peg$parse(input, options) {
             return details;
         }
     }
-    function peg$computeLocation(startPos, endPos) {
+    function peg$computeLocation(startPos, endPos, offset) {
         var startPosDetails = peg$computePosDetails(startPos);
         var endPosDetails = peg$computePosDetails(endPos);
-        return {
+        var res = {
             source: peg$source,
             start: {
                 offset: startPos,
@@ -497,6 +500,11 @@ function peg$parse(input, options) {
                 column: endPosDetails.column
             }
         };
+        if (offset && peg$source && (typeof peg$source.offset === "function")) {
+            res.start = peg$source.offset(res.start);
+            res.end = peg$source.offset(res.end);
+        }
+        return res;
     }
     function peg$fail(expected) {
         if (peg$currPos < peg$maxFailPos) {

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const version = "10.1.6";
+export const version = "10.1.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "state-machine-cat",
-  "version": "10.1.8",
+  "version": "10.1.9",
   "description": "write beautiful state charts",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.mjs",
@@ -23,6 +23,7 @@
   "scripts": {
     "build": "make clean dist pages",
     "build:cli": "make cli-build && rm -rf dist/esm && tsc",
+    "build:fromscratch": "make clean dist pages cli-build && rm -rf dist/esm && tsc",
     "check": "wireit",
     "cachefolder": "wireit",
     "depcruise": "wireit",
@@ -70,7 +71,7 @@
     "upem-outdated": "npm outdated --json --long | upem --dry-run",
     "upem:install": "npm install",
     "upem:update": "npm outdated --json --long | upem | pbcopy && pbpaste",
-    "version": "run-s build depcruise:graph scm:stage"
+    "version": "run-s build:fromscratch depcruise:graph scm:stage"
   },
   "files": [
     "bin/",
@@ -85,11 +86,6 @@
   ],
   "upem": {
     "policies": [
-      {
-        "package": "fast-xml-parser",
-        "policy": "wanted",
-        "because": "fast-xml-parser 4 has some breaking changes we still need to grok (why? how?)"
-      },
       {
         "package": "viz.js",
         "policy": "pin",
@@ -375,13 +371,14 @@
     "ajv": "8.12.0",
     "chalk": "5.2.0",
     "commander": "10.0.0",
-    "fast-xml-parser": "3.21.1",
+    "fast-xml-parser": "4.1.2",
     "get-stream": "6.0.1",
     "handlebars": "4.7.7",
     "he": "1.2.0",
     "indent-string": "5.0.0",
     "lodash": "4.17.21",
     "semver": "^7.3.8",
+    "traverse": "0.6.7",
     "viz.js": "1.8.2",
     "wrap-ansi": "8.1.0"
   },
@@ -391,15 +388,15 @@
     "@types/he": "1.2.0",
     "@types/lodash": "4.14.191",
     "@types/mocha": "10.0.1",
-    "@typescript-eslint/eslint-plugin": "5.52.0",
-    "@typescript-eslint/parser": "5.52.0",
+    "@typescript-eslint/eslint-plugin": "5.53.0",
+    "@typescript-eslint/parser": "5.53.0",
     "c8": "7.13.0",
     "chai": "4.3.7",
     "chai-as-promised": "7.1.1",
     "chai-json-schema": "1.5.1",
     "chai-xml": "0.4.0",
-    "dependency-cruiser": "12.9.0",
-    "esbuild": "0.17.8",
+    "dependency-cruiser": "12.10.0",
+    "esbuild": "0.17.10",
     "eslint": "8.34.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.6.0",
@@ -416,13 +413,13 @@
     "lint-staged": "13.1.2",
     "mocha": "10.2.0",
     "npm-run-all": "4.1.5",
-    "peggy": "2.0.1",
+    "peggy": "3.0.0",
     "prettier": "2.8.4",
     "query-string": "8.1.0",
     "ts-node": "10.9.1",
     "typescript": "4.9.5",
     "upem": "7.3.2",
-    "watskeburt": "0.9.2",
+    "watskeburt": "0.10.0",
     "wireit": "0.9.5",
     "xml-name-validator": "4.0.0"
   },

package/src/cli/attributes-parser.mjs

@@ -1,4 +1,4 @@
-// Generated by Peggy 2.0.1.
+// Generated by Peggy 3.0.0.
 //
 // https://peggyjs.org/
 
@@ -43,16 +43,19 @@ peg$SyntaxError.prototype.format = function(sources) {
       }
     }
     var s = this.location.start;
-    var loc = this.location.source + ":" + s.line + ":" + s.column;
+    var offset_s = (this.location.source && (typeof this.location.source.offset === "function"))
+      ? this.location.source.offset(s)
+      : s;
+    var loc = this.location.source + ":" + offset_s.line + ":" + offset_s.column;
     if (src) {
       var e = this.location.end;
-      var filler = peg$padEnd("", s.line.toString().length, ' ');
+      var filler = peg$padEnd("", offset_s.line.toString().length, ' ');
       var line = src[s.line - 1];
       var last = s.line === e.line ? e.column : line.length + 1;
       var hatLen = (last - s.column) || 1;
       str += "\n --> " + loc + "\n"
           + filler + " |\n"
-          + s.line + " | " + line + "\n"
+          + offset_s.line + " | " + line + "\n"
           + filler + " | " + peg$padEnd("", s.column - 1, ' ')
           + peg$padEnd("", hatLen, "^");
     } else {
@@ -327,11 +330,11 @@ function peg$parse(input, options) {
     }
   }
 
-  function peg$computeLocation(startPos, endPos) {
+  function peg$computeLocation(startPos, endPos, offset) {
     var startPosDetails = peg$computePosDetails(startPos);
     var endPosDetails = peg$computePosDetails(endPos);
 
-    return {
+    var res = {
       source: peg$source,
       start: {
         offset: startPos,
@@ -344,6 +347,11 @@ function peg$parse(input, options) {
         column: endPosDetails.column
       }
     };
+    if (offset && peg$source && (typeof peg$source.offset === "function")) {
+      res.start = peg$source.offset(res.start);
+      res.end = peg$source.offset(res.end);
+    }
+    return res;
   }
 
   function peg$fail(expected) {

package/src/parse/scxml/index.mjs

@@ -1,7 +1,9 @@
+/* eslint-disable no-invalid-this */
 /* eslint-disable security/detect-object-injection */
 import fastxml from "fast-xml-parser";
 import he from "he";
 import castArray from "lodash/castArray.js";
+import traverse from "traverse";
 import utl from "../../transform/utl.mjs";
 import parserHelpers from "../parser-helpers.mjs";
 import { normalizeMachine } from "./normalize-machine.mjs";
@@ -26,11 +28,6 @@ function extractActionsFromInvokes(pInvokeTriggers) {
   });
 }
 
-/**
- * @param {import("./scxml").INormalizedSCXMLState} pState
- * @returns {{type: string; body: string;}[]}
- */
-
 /**
  * @param {import("./scxml").INormalizedSCXMLState} pState
  * @returns {any[]}
@@ -54,7 +51,7 @@ function deriveActions(pState) {
 
 /**
  * @param {import("../../..").StateType} pType
- * param {import("./scxml").ISCXMLHistoryState} pState
+ * @param {import("./scxml").ISCXMLHistoryState} pState
  * @param {any} pState
  * @returns {import("../../..").StateType}
  */
@@ -64,7 +61,6 @@ function deriveStateType(pType, pState) {
 
 /**
  * @param {import("../../../types/state-machine-cat").StateType} pType
- * returns {(pState: import("./scxml").INormalizedSCXMLState) => import("../../..").IState}
  * @returns {(any) => import("../../..").IState}
  */
 function mapState(pType) {
@@ -121,7 +117,6 @@ function extractTransitionAttributesFromObject(pTransition) {
 }
 
 /**
- *
  * @param {import("./scxml").ISCXMLTransition} pTransition
  * @returns {{action?: string; label?: string;event?: string; cond?: string; type?: string}}
  */
@@ -223,6 +218,41 @@ function mapMachine(pSCXMLStateMachine) {
   return lReturnValue;
 }
 
+/**
+ * This funky looking replace  exists to make the output of the fast-xml-parser
+ * backwards compatible with its version 3 that in case of conflicts between
+ * attribute names and tag names gave preference to the attribute name (version 4
+ * does the opposite). The previous behaviour was undocumented and for fast-xml-parser
+ * likely a kind of edge case (normal people probably don't pass an empty attributeNamePrefix).
+ *
+ * @param {any} pObject
+ * @param {string} pAttributeNamePrefix
+ * @returns {any} the object, but
+ * - with attributes that have the same name as tags in the same parent removed,
+ * - attributes that don't have an equally named tag get their key renamed back
+ *   to the one without the pAttributeNamePrefix
+ */
+function deDuplicateAttributesAndTags(pObject, pAttributeNamePrefix) {
+  // - 'traverse' relies on the 'this' property a 'normal' function provides,
+  //   so this is not an arrow function.
+  // - while it looks iffy to have a map function without a return statement
+  //   it's canonical traverse use (as per https://github.com/ljharb/js-traverse/blob/v0.6.7/README.md)
+  // eslint-disable-next-line array-callback-return
+  return traverse(pObject).map(function deDuplicate() {
+    if (this.key?.startsWith(pAttributeNamePrefix)) {
+      const pUnprefixedAttributeName = this.key.slice(
+        pAttributeNamePrefix.length
+      );
+      if (this.parent.keys.includes(pUnprefixedAttributeName)) {
+        this.remove();
+      } else {
+        this.parent.node[pUnprefixedAttributeName] = this.node;
+        this.remove();
+      }
+    }
+  });
+}
+
 /**
  * Parses SCXML into a state machine AST.
  *
@@ -231,22 +261,31 @@ function mapMachine(pSCXMLStateMachine) {
  */
 export function parse(pSCXMLString) {
   const lTrimmedSCXMLString = pSCXMLString.trim();
+  const lAttributeNamePrefix = "@_";
+  /** @type {import("./scxml").ISCXMLAsJSON} */
+  let lXMLAsJSON = {};
 
-  if (fastxml.validate(lTrimmedSCXMLString) === true) {
-    /** @type {import("./scxml").ISCXMLAsJSON} */
-    const lXMLAsJSON = fastxml.parse(lTrimmedSCXMLString, {
-      attributeNamePrefix: "",
-      ignoreAttributes: false,
-      tagValueProcessor: (pTagValue) => he.decode(pTagValue),
-      stopNodes: ["onentry", "onexit", "transition"],
-    });
-
-    return mapMachine(
-      lXMLAsJSON?.scxml ?? {
-        xmlns: "http://www.w3.org/2005/07/scxml",
-        version: "1.0",
-      }
+  const lXMLParser = new fastxml.XMLParser({
+    attributeNamePrefix: lAttributeNamePrefix,
+    ignoreAttributes: false,
+    parseTagValue: true,
+    processEntities: false,
+    tagValueProcessor: (_pTagName, pTagValue) => he.decode(pTagValue),
+    stopNodes: ["*.onentry", "*.onexit", "*.transition"],
+  });
+
+  try {
+    lXMLAsJSON = deDuplicateAttributesAndTags(
+      lXMLParser.parse(lTrimmedSCXMLString, true),
+      lAttributeNamePrefix
     );
+  } catch (pError) {
+    throw new Error("That doesn't look like valid xml ...\n");
   }
-  throw new Error("That doesn't look like valid xml ...\n");
+  return mapMachine(
+    lXMLAsJSON?.scxml ?? {
+      xmlns: "http://www.w3.org/2005/07/scxml",
+      version: "1.0",
+    }
+  );
 }

package/src/parse/smcat/smcat-parser.mjs

@@ -1,4 +1,4 @@
-// Generated by Peggy 2.0.1.
+// Generated by Peggy 3.0.0.
 //
 // https://peggyjs.org/
 
@@ -45,16 +45,19 @@ peg$SyntaxError.prototype.format = function(sources) {
       }
     }
     var s = this.location.start;
-    var loc = this.location.source + ":" + s.line + ":" + s.column;
+    var offset_s = (this.location.source && (typeof this.location.source.offset === "function"))
+      ? this.location.source.offset(s)
+      : s;
+    var loc = this.location.source + ":" + offset_s.line + ":" + offset_s.column;
     if (src) {
       var e = this.location.end;
-      var filler = peg$padEnd("", s.line.toString().length, ' ');
+      var filler = peg$padEnd("", offset_s.line.toString().length, ' ');
       var line = src[s.line - 1];
       var last = s.line === e.line ? e.column : line.length + 1;
       var hatLen = (last - s.column) || 1;
       str += "\n --> " + loc + "\n"
           + filler + " |\n"
-          + s.line + " | " + line + "\n"
+          + offset_s.line + " | " + line + "\n"
           + filler + " | " + peg$padEnd("", s.column - 1, ' ')
           + peg$padEnd("", hatLen, "^");
     } else {
@@ -386,15 +389,15 @@ function peg$parse(input, options) {
 
       return trans;
     };
-  var peg$f20 = function(from, to) {
+  var peg$f20 = function(from_, to) {
               return {
-                  from: from,
+                  from: from_,
                   to: to
               }
           };
-  var peg$f21 = function(to, from) {
+  var peg$f21 = function(to, from_) {
           return {
-              from: from,
+              from: from_,
               to: to
           }
       };
@@ -554,11 +557,11 @@ function peg$parse(input, options) {
     }
   }
 
-  function peg$computeLocation(startPos, endPos) {
+  function peg$computeLocation(startPos, endPos, offset) {
     var startPosDetails = peg$computePosDetails(startPos);
     var endPosDetails = peg$computePosDetails(endPos);
 
-    return {
+    var res = {
       source: peg$source,
       start: {
         offset: startPos,
@@ -571,6 +574,11 @@ function peg$parse(input, options) {
         column: endPosDetails.column
       }
     };
+    if (offset && peg$source && (typeof peg$source.offset === "function")) {
+      res.start = peg$source.offset(res.start);
+      res.end = peg$source.offset(res.end);
+    }
+    return res;
   }
 
   function peg$fail(expected) {