@dotdev/harmony-sdk 1.29.1 → 1.30.1

package/dist/helpers/index.js

@@ -28,7 +28,7 @@ export class ApiHelper {
                     size: +(response?.headers?.["content-length"] || 0),
                     status: response?.status,
                 },
-            }, `Received Harmony response 🔽`);
+            }, `Received Harmony response for ${endpoint} endpoint 🔽`);
             // Throw an error if the response is not in XML format
             if (response?.headers["content-type"] !== "text/xml" &&
                 response?.headers["content-type"] !== "text/xml;charset=utf-8" &&
@@ -93,7 +93,7 @@ export class ApiHelper {
         const child = logger.child({
             request: requestBody,
         });
-        child.debug(`Sending API request`);
+        child.debug(`Sending API request to ${serviceName} endpoint`);
         const response = await ApiHelper.sendSoapRequest(serviceName, axios, requestBody);
         return response[responseMethodName][0];
     }

package/dist/helpers/utils.js

@@ -1,6 +1,7 @@
 import { promisify } from "util";
 import xml2js, { parseString } from "xml2js";
 const parseXml = promisify(parseString);
+import { XMLValidator } from "fast-xml-parser";
 export class Utils {
     /**
      * Check if an object is an empty array or not an array
@@ -143,20 +144,8 @@ export class Utils {
      * @returns
      */
     static isValidXml(xmlString) {
-        let stack = [];
-        const regex = /<([^>]+)>/g;
-        let match;
-        while ((match = regex.exec(xmlString)) !== null) {
-            if (match[1].charAt(0) === "/") {
-                if (stack.length === 0 || stack.pop() !== match[1].slice(1)) {
-                    return false;
-                }
-            }
-            else {
-                stack.push(match[1]);
-            }
-        }
-        return stack.length === 0;
+        const validationResult = XMLValidator.validate(xmlString);
+        return validationResult === true;
     }
     static removeTabsAndNewLines(str) {
         if (!str)

package/dist/helpers/utils.spec.js

@@ -112,10 +112,12 @@ describe("Misc", () => {
         // Check if Accept-Encoding is set to gzip, deflate, br for compression support (currently enabled for S2)
         expect(harmonyApi.axiosInstance.defaults.headers["Accept-Encoding"]).toEqual("gzip, deflate, br");
     });
-    test("validateXml() should validate XML correctly", () => {
-        expect(Utils.isValidXml("<root><child></child></root>")).toBe(true);
-        expect(Utils.isValidXml("<root><child></root>")).toBe(false);
-        expect(Utils.isValidXml("<root><child></child>")).toBe(false);
-        expect(Utils.isValidXml("<root><child></child></root><root>")).toBe(false);
+    test("validateXml() should validate XML correctly", async () => {
+        expect(await Utils.isValidXml("<root><child></child></root>")).toBe(true);
+        expect(await Utils.isValidXml("<root><child></root>")).toBe(false);
+        expect(await Utils.isValidXml("<root><child></child>")).toBe(false);
+        expect(await Utils.isValidXml("<root><child></child></root><root>")).toBe(false);
+        const harmonyExampleResponse = `<?xml version='1.0' encoding='UTF-8'?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope"><faultcode>S:Server</faultcode><faultstring>Failed GiftVoucherReservation</faultstring><detail><ns2:ServiceFault xmlns:ns2="http://gv.ws.fbsaust.com.au"><errorDetails>[205-106-2508050909-0000727429]  (Reservation Amount exceeds Unused Amount.)</errorDetails></ns2:ServiceFault></detail></S:Fault></S:Body></S:Envelope>`;
+        expect(await Utils.isValidXml(harmonyExampleResponse)).toBe(true);
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdev/harmony-sdk",
-  "version": "1.29.1",
+  "version": "1.30.1",
   "description": "Harmony API SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,6 +20,7 @@
     "@google-cloud/pino-logging-gcp-config": "^1.0.4",
     "axios": "^1.7.2",
     "axios-retry": "^4.5.0",
+    "fast-xml-parser": "^5.2.5",
     "pino": "^9.7.0",
     "xml2js": "0.6.2"
   },