feat(xml-builder): restore fast-xml-parser in Node.js

Author: kuhe

packages/xml-builder/package.json

@@ -4,7 +4,7 @@
   "description": "XML builder for the AWS SDK",
   "dependencies": {
     "@smithy/types": "^4.5.0",
-    "@xmldom/xmldom": "0.8.11",
+    "fast-xml-parser": "5.2.5",
     "tslib": "^2.6.2"
   },
   "scripts": {

packages/xml-builder/src/xml-parser.spec.ts

@@ -89,11 +89,11 @@ describe("xml parsing", () => {
           </XmlEmptyMapsResult>
       </XmlEmptyMapsResponse>`;
         const object = parse(xml);
-        expect(object).toEqual({
+        expect(object).toMatchObject({
           XmlEmptyMapsResponse: {
             xmlns: "https://example.com/",
             XmlEmptyMapsResult: {
-              myMap: "\n              ",
+              myMap: /\s*/,
             },
           },
         });

packages/xml-builder/src/xml-parser.ts

@@ -1,98 +1,17 @@
-//
-//
-// const parser = new XMLParser({
-//   attributeNamePrefix: "",
-//   htmlEntities: true,
-//   ignoreAttributes: false,
-//   ignoreDeclaration: true,
-//   parseTagValue: false,
-//   trimValues: false,
-//   tagValueProcessor: (_: any, val: any) => (val.trim() === "" && val.includes("\n") ? "" : undefined),
-// });
-// parser.addEntity("#xD", "\r");
-// parser.addEntity("#10", "\n");
-
-// export function parseXML(xmlString: string): any {
-//   return parser.parse(xmlString, true);
-// }
-
-// temporary replacement for compatibility testing.
-import { DOMParser } from "@xmldom/xmldom";
-const parser = new DOMParser({
-  locator: {},
-  errorHandler: (err) => {
-    throw new Error(err);
-  },
+import { XMLParser } from "fast-xml-parser";
+
+const parser = new XMLParser({
+  attributeNamePrefix: "",
+  htmlEntities: true,
+  ignoreAttributes: false,
+  ignoreDeclaration: true,
+  parseTagValue: false,
+  trimValues: false,
+  tagValueProcessor: (_: any, val: any) => (val.trim() === "" && val.includes("\n") ? "" : undefined),
 });
+parser.addEntity("#xD", "\r");
+parser.addEntity("#10", "\n");
 
-/**
- * Cases where this differs from fast-xml-parser:
- *
- * 1. mixing text with nested tags
- * <mixed-text> hello, <bold>world</bold>, how are you?</mixed-text>
- *
- * @internal
- */
 export function parseXML(xmlString: string): any {
-  const xmlDocument = parser.parseFromString(xmlString, "application/xml");
-
-  if (xmlDocument.getElementsByTagName("parsererror").length > 0) {
-    throw new Error("DOMParser XML parsing error.");
-  }
-
-  // Recursive function to convert XML nodes to JS object
-  const xmlToObj = (node: Node): any => {
-    if (node.nodeType === 3) {
-      if (node.textContent?.trim()) {
-        return node.textContent;
-      }
-    }
-
-    if (node.nodeType === 1) {
-      const element = node as Element;
-      if (element.attributes.length === 0 && element.childNodes.length === 0) {
-        return "";
-      }
-
-      const obj: any = {};
-
-      const attributes = Array.from(element.attributes);
-      for (const attr of attributes) {
-        obj[`${attr.name}`] = attr.value;
-      }
-
-      const childNodes = Array.from(element.childNodes);
-      for (const child of childNodes) {
-        const childResult = xmlToObj(child);
-
-        if (childResult != null) {
-          const childName = child.nodeName;
-
-          if (childNodes.length === 1 && attributes.length === 0 && childName === "#text") {
-            return childResult;
-          }
-
-          if (obj[childName]) {
-            if (Array.isArray(obj[childName])) {
-              obj[childName].push(childResult);
-            } else {
-              obj[childName] = [obj[childName], childResult];
-            }
-          } else {
-            obj[childName] = childResult;
-          }
-        } else if (childNodes.length === 1 && attributes.length === 0) {
-          return element.textContent;
-        }
-      }
-
-      return obj;
-    }
-
-    return null;
-  };
-
-  return {
-    [xmlDocument.documentElement.nodeName]: xmlToObj(xmlDocument.documentElement),
-  };
+  return parser.parse(xmlString, true);
 }

yarn.lock

@@ -25007,9 +25007,9 @@ __metadata:
   dependencies:
     "@smithy/types": "npm:^4.5.0"
     "@tsconfig/recommended": "npm:1.0.1"
-    "@xmldom/xmldom": "npm:0.8.11"
     concurrently: "npm:7.0.0"
     downlevel-dts: "npm:0.10.1"
+    fast-xml-parser: "npm:5.2.5"
     rimraf: "npm:3.0.2"
     tslib: "npm:^2.6.2"
     typescript: "npm:~5.8.3"
@@ -30538,13 +30538,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@xmldom/xmldom@npm:0.8.11":
-  version: 0.8.11
-  resolution: "@xmldom/xmldom@npm:0.8.11"
-  checksum: 10c0/e768623de72c95d3dae6b5da8e33dda0d81665047811b5498d23a328d45b13feb5536fe921d0308b96a4a8dd8addf80b1f6ef466508051c0b581e63e0dc74ed5
-  languageName: node
-  linkType: hard
-
 "@xtuc/ieee754@npm:^1.2.0":
   version: 1.2.0
   resolution: "@xtuc/ieee754@npm:1.2.0"