@dotdev/harmony-sdk 1.22.1 → 1.24.0

package/dist/helpers/index.js

@@ -110,8 +110,15 @@ export class ApiHelper {
     static async parseError(error) {
         if (axios.isAxiosError(error)) {
             if (error?.response) {
-                const parsedError = await ApiHelper.parseHarmonyErrorResponse(error?.response?.data);
-                return new RequestError(`API request failed with status ${error.response.status}: {code: ${parsedError?.code}, name: ${parsedError?.name}, message: ${parsedError?.message}}`);
+                if (Utils.isValidXml(error?.response?.data)) {
+                    const parsedError = await ApiHelper.parseHarmonyErrorResponse(error?.response?.data);
+                    return new RequestError(`API request failed with status ${error.response.status}: {code: ${parsedError?.code}, name: ${parsedError?.name}, message: ${parsedError?.message}}`);
+                }
+                else {
+                    logger.error(`API request error`);
+                    logger.child({ error: error });
+                    return new RequestError(`API request failed but error response is not in Harmony XML format. Please check the logs for more details.`);
+                }
             }
             else if (error?.request) {
                 return new RequestError("No response received from the server during API call");

package/dist/helpers/utils.d.ts

@@ -69,6 +69,12 @@ export declare abstract class Utils {
      * @returns {*} first value in the array
      */
     static getFirst(prop: any): string;
+    /**
+     * Validate whether the provided string is a valid XML.
+     * @param xmlString
+     * @returns
+     */
+    static isValidXml(xmlString: string): boolean;
 }
 export declare const TEST_HEADERS: {
     headers: {

package/dist/helpers/utils.js

@@ -137,6 +137,27 @@ export class Utils {
     static getFirst(prop) {
         return (prop ?? [])[0];
     }
+    /**
+     * Validate whether the provided string is a valid XML.
+     * @param xmlString
+     * @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;
+    }
 }
 export const TEST_HEADERS = {
     headers: {

package/dist/helpers/utils.spec.js

@@ -107,4 +107,10 @@ 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);
+    });
 });

package/dist/modules/stock-level-lookup/mappings/stock-level-lookup.mapper.js

@@ -1,6 +1,6 @@
 import { Utils } from "../../../helpers";
 import { mapOptionalStockQueryParams } from "../../../helpers/mapper";
-import { OnlyNonZero, QtyType, StockLevelLookupRequestBody, } from "../types";
+import { IgnoreSizePacks, OnlyNonZero, QtyType, StockLevelLookupRequestBody, } from "../types";
 export function mapWarehouse(src) {
     return {
         namekey: (src?.namekey ?? [])[0],
@@ -73,6 +73,7 @@ export function mapStockLevelLookupQueryParams(src) {
         WarehouseClassFr4: src?.warehouseClassFr4 ?? "",
         WarehouseClassTo4: src?.warehouseClassTo4 ?? "",
         WarehouseClassFr5: src?.warehouseClassFr5 ?? "",
+        IgnoreSizePacks: src?.ignoreSizePacks ?? IgnoreSizePacks.YES,
         ...optional,
     });
 }

package/dist/modules/stock-level-lookup/stock-level-lookup.module.spec.js

@@ -3,7 +3,7 @@ import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
 import { StockSearchType } from "../stock-lookup";
 import { StockLevelLookupModule } from "./stock-level-lookup.module";
-import { OnlyNonZero, QtyType, Summarised, } from "./types";
+import { IgnoreSizePacks, OnlyNonZero, QtyType, Summarised, } from "./types";
 jest.mock("axios");
 const mAxios = axios;
 describe("StockLevelLookupModule.warehouseLookup()", () => {
@@ -88,6 +88,7 @@ describe("StockLevelLookupModule.stockLevelLookup()", () => {
             summarised: Summarised.EXPANDED,
             onlyNonZero: OnlyNonZero.NO,
             warehouse1: "123",
+            ignoreSizePacks: IgnoreSizePacks.NO,
         };
         const ns = "S";
         const expectedPayload = `
@@ -107,6 +108,7 @@ describe("StockLevelLookupModule.stockLevelLookup()", () => {
 								<Summarised>${params.summarised}</Summarised>
 								<OnlyNonZero>${params.onlyNonZero}</OnlyNonZero>
 								<Warehouse1>${params.warehouse1}</Warehouse1>
+								<IgnoreSizePacks>${params.ignoreSizePacks}</IgnoreSizePacks>
 						</${ServiceAlias.STOCK_LEVEL_LOOKUP}:StockLevelLookupRequest>
 				</${ns}:Body>
 		</${ns}:Envelope>
@@ -228,10 +230,11 @@ describe("StockLevelLookupModule.stockLevelLookup()", () => {
 								</QtyType>
 								<OnlyNonZero>${params.onlyNonZero}</OnlyNonZero>
 								<Warehouse>${params.warehouse}</Warehouse>
+								<IgnoreSizePacks>Y</IgnoreSizePacks>
 						</${ServiceAlias.STOCK_LEVEL_LOOKUP}:StockLevelLookupByWarehouseQuickViewRequest>
 				</${ns}:Body>
 		</${ns}:Envelope>
-		`;
+		`; // ignore size pack set to Y by default
         const mockedResp = {
             data: `
 				<?xml version='1.0' encoding='UTF-8'?>

package/dist/modules/stock-level-lookup/types/stock-level-lookup.interface.d.ts

@@ -113,6 +113,7 @@ export declare class StockLevelLookupRequestBody extends OptionalStockRequestBod
     WarehouseClassTo4?: string;
     WarehouseClassFr5?: string;
     WarehouseClassTo5?: string;
+    IgnoreSizePacks?: IgnoreSizePacks;
     constructor(obj: Partial<StockLevelLookupRequestBody>);
     toString(): string;
 }
@@ -142,6 +143,7 @@ export interface StockLevelLookupQueryParams extends OptionalStockQueryParams {
     warehouseClassTo4?: string;
     warehouseClassFr5?: string;
     warehouseClassTo5?: string;
+    ignoreSizePacks?: IgnoreSizePacks;
 }
 export declare enum QtyType {
     STK = "STK",
@@ -149,6 +151,10 @@ export declare enum QtyType {
     FUT = "FUT",
     AVL = "AVL"
 }
+export declare enum IgnoreSizePacks {
+    YES = "Y",
+    NO = "N"
+}
 export declare enum Summarised {
     EXPANDED = "E",
     SUMMARISED = "S"

package/dist/modules/stock-level-lookup/types/stock-level-lookup.interface.js

@@ -25,6 +25,7 @@ export class StockLevelLookupRequestBody extends OptionalStockRequestBody {
     WarehouseClassTo4;
     WarehouseClassFr5;
     WarehouseClassTo5;
+    IgnoreSizePacks;
     constructor(obj) {
         if (!obj?.SearchType) {
             throw new Error("SearchType is required when constructing StockLookup request body");
@@ -49,6 +50,11 @@ export var QtyType;
     QtyType["FUT"] = "FUT";
     QtyType["AVL"] = "AVL";
 })(QtyType || (QtyType = {}));
+export var IgnoreSizePacks;
+(function (IgnoreSizePacks) {
+    IgnoreSizePacks["YES"] = "Y";
+    IgnoreSizePacks["NO"] = "N";
+})(IgnoreSizePacks || (IgnoreSizePacks = {}));
 export var Summarised;
 (function (Summarised) {
     Summarised["EXPANDED"] = "E";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdev/harmony-sdk",
-  "version": "1.22.1",
+  "version": "1.24.0",
   "description": "Harmony API SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",