chore(common): xml2js -> fast-xml-parser

common/schemas/kvks/kvks.schema.json

@@ -75,27 +75,18 @@
             "$ref": "#/definitions/kvk-layer"
           }
         },
-        "$": {
-          "type": "object",
-          "properties": {
-            "name": {
-              "$ref": "#/definitions/kvk-encoding-name"
-            },
-            "fontname": {
-              "type": "string"
-            },
-            "fontsize": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "name"
-          ],
-          "additionalProperties": false
+        "name": {
+          "$ref": "#/definitions/kvk-encoding-name"
+        },
+        "fontname": {
+          "type": "string"
+        },
+        "fontsize": {
+          "type": "string"
         }
       },
       "required": [
-        "$"
+        "name"
       ],
       "additionalProperties": false
     },
@@ -108,21 +99,12 @@
             "$ref": "#/definitions/kvk-key"
           }
         },
-        "$": {
-          "type": "object",
-          "properties": {
-            "shift": {
-              "$ref": "#/definitions/kvk-layer-shift"
-            }
-          },
-          "required": [
-            "shift"
-          ],
-          "additionalProperties": false
+        "shift": {
+          "$ref": "#/definitions/kvk-layer-shift"
         }
       },
       "required": [
-        "$"
+        "shift"
       ],
       "additionalProperties": false
     },
@@ -132,24 +114,15 @@
         "bitmap": {
           "type": "string"
         },
-        "$": {
-          "type": "object",
-          "properties": {
-            "vkey": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "vkey"
-          ],
-          "additionalProperties": false
+        "vkey": {
+          "type": "string"
         },
-        "_": {
+        "#text": {
           "type": "string"
         }
       },
       "required": [
-        "$"
+        "vkey"
       ],
       "additionalProperties": false
     },
@@ -179,4 +152,4 @@
       "pattern": "(\\d+\\.)+(\\d+)"
     }
   }
-}
+}

common/web/types/src/util/util.ts

@@ -2,7 +2,9 @@ import { MATCH_HEX_ESCAPE, CONTAINS_QUAD_ESCAPE, MATCH_QUAD_ESCAPE } from './con
 export { MATCH_HEX_ESCAPE, CONTAINS_QUAD_ESCAPE, MATCH_QUAD_ESCAPE };
 
 /**
- * xml2js will not place single-entry objects into arrays. Easiest way to fix
+ * fast-xml-parser will not place single-entry objects into arrays.
+ * We could set a list of items expected to be arrays,
+ * but the easiest way to fix
  * this is to box them ourselves as needed. Ensures that o.x is an array.
  *
  * @param o Object with property to box

developer/src/common/web/utils/package.json

@@ -9,19 +9,18 @@
     "/build/"
   ],
   "dependencies": {
-    "@sentry/node": "^7.57.0",
     "@keymanapp/common-types": "*",
+    "@sentry/node": "^7.57.0",
     "eventemitter3": "^5.0.0",
     "restructure": "^3.0.1",
-    "semver": "^7.5.4",
     "sax": ">=0.6.0",
+    "semver": "^7.5.4",
     "xmlbuilder": "~11.0.0"
   },
   "devDependencies": {
     "@types/git-diff": "^2.0.3",
     "@types/node": "^20.4.1",
     "@types/semver": "^7.3.12",
-    "@types/xml2js": "^0.4.5",
     "c8": "^7.12.0",
     "git-diff": "^2.0.6",
     "mocha": "^8.4.0",

developer/src/common/web/utils/src/common-events.ts

@@ -43,4 +43,16 @@ export class CommonTypesMessages {
   static Error_TestDataUnexpectedArray = (o: {subtag: string}) =>
     m(this.ERROR_TestDataUnexpectedArray,
       `Problem reading test data: expected single ${def(o.subtag)} element, found multiple`);
+
+  static ERROR_InvalidXML = SevError | 0x0008;
+  static Error_InvalidXML = (o: { code?: string, msg: string, line?: number, col?: number }) => {
+    // may or may not have extended details
+    if (o.code && o.line && o.msg) {
+      return m(this.ERROR_InvalidXML,
+        `Error reading XML at ${def(o.line)}:${def(o.col)}: ${def(o.code)} ${def(o.msg)}`
+      );
+    } else {
+      return m(this.ERROR_InvalidXML, `Error reading XML: ${def(o.msg)}`);
+    }
+  };
 };