@dotdev/harmony-sdk 1.21.0 → 1.22.1

package/dist/HarmonyAPI.d.ts

@@ -13,7 +13,7 @@ export declare class HarmonyAPI {
     private carrierModule;
     private diaryModule;
     private giftVoucherModule;
-    constructor(url: string, axiosRetryConfig?: IAxiosRetryConfig, config?: RequestConfig);
+    constructor(url: string, axiosRetryConfig?: IAxiosRetryConfig, requestConfig?: RequestConfig);
     authenticate(authToken: AuthenticationToken): Promise<string>;
     stockLookup(params: StockLookupRequestParams, sessionId: string): Promise<Stock[]>;
     stockCategoryLookup(sessionId: string): Promise<StockCategory[]>;

package/dist/HarmonyAPI.js

@@ -3,6 +3,7 @@ import axiosRetry from "axios-retry";
 import * as https from "https";
 import { promisify } from "util";
 import { parseString } from "xml2js";
+import logger from "./helpers/logger";
 import { AuthModule, CarrierModule, DiaryModule, GiftVoucherModule, PointOfSaleModule, StockClassificationType, StockLevelLookupModule, StockLookupModule, } from "./modules";
 require("tls").DEFAULT_MIN_VERSION = "TLSv1";
 const parseXml = promisify(parseString);
@@ -16,12 +17,12 @@ export class HarmonyAPI {
     carrierModule;
     diaryModule;
     giftVoucherModule;
-    constructor(url, axiosRetryConfig, config) {
+    constructor(url, axiosRetryConfig, requestConfig) {
         this.baseUrl = url;
         this.axiosInstance = axios.create({
             baseURL: this.baseUrl,
             headers: {
-                ...config?.headers,
+                ...requestConfig?.headers,
                 "Content-Type": "text/xml;charset=UTF-8",
                 "Accept-Encoding": "gzip, deflate, br", // Override default Accept-Encoding
             },
@@ -35,7 +36,10 @@ export class HarmonyAPI {
             }
             if (!axiosRetryConfig.onRetry) {
                 axiosRetryConfig.onRetry = (retryCount, error, requestConfig) => {
-                    console.log(`Retrying request (attempt ${retryCount}): ${error}`);
+                    logger.debug(`Retrying request (attempt ${retryCount}): ${error}`, {
+                        requestConfig,
+                        error,
+                    });
                 };
             }
             axiosRetry(this.axiosInstance, axiosRetryConfig);

package/dist/helpers/index.js

@@ -9,7 +9,6 @@ const parseXml = promisify(parseString);
 export class ApiHelper {
     static async sendSoapRequest(endpoint, axiosInstance, requestBody, type = "POST") {
         const url = `${endpoint}?wsdl`;
-        let response;
         try {
             let response;
             switch (type) {
@@ -32,10 +31,16 @@ export class ApiHelper {
             const logs = logger.child({
                 request: requestBody,
                 response: response?.data,
-                size: +response?.headers?.["content-length"],
+                size: +(response?.headers?.["Content-Length"] || 0),
                 status: response?.status,
             });
             logs.debug(`Received Harmony response: `);
+            // Throw an error if the response is not in XML format
+            if (response?.headers?.["Content-Type"] !== "text/xml" &&
+                response?.headers?.["Content-Type"] !== "application/xml") {
+                throw new Error(`Returned response not in XML format. This is likely a gateway error - [${response?.status} - ${response?.statusText}]: ${JSON.stringify(response)}`);
+            }
+            // Parse the XML response
             const result = (await parseXml(response?.data)); // fix type
             return result["S:Envelope"]["S:Body"][0];
         }

package/dist/helpers/index.spec.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, checkParamLimits, Utils } from ".";
+import { ApiHelper, checkParamLimits, TEST_HEADERS, Utils } from ".";
 import { ServiceAlias } from "../modules/shared/types";
 // Increase timeout due to Harmony API having long response time
 jest.setTimeout(999999);
@@ -35,6 +35,7 @@ describe("ApiHelper", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            ...TEST_HEADERS,
         });
         const response = await ApiHelper.sendSoapRequest(endpoint, mAxios, requestBody);
         expect(response["ns2:StockClassificationLookupResponse"][0]

package/dist/helpers/logger.d.ts

@@ -1,2 +1,3 @@
-declare const logger: import("pino").Logger<never, boolean>;
+import * as pino from "pino";
+declare const logger: pino.Logger<never, boolean>;
 export default logger;

package/dist/helpers/logger.js

@@ -1,3 +1,4 @@
-import pino from "pino";
-const logger = pino();
+import { createGcpLoggingPinoConfig } from "@google-cloud/pino-logging-gcp-config";
+import * as pino from "pino";
+const logger = pino.pino(createGcpLoggingPinoConfig());
 export default logger;

package/dist/helpers/utils.d.ts

@@ -70,3 +70,8 @@ export declare abstract class Utils {
      */
     static getFirst(prop: any): string;
 }
+export declare const TEST_HEADERS: {
+    headers: {
+        "Content-Type": string;
+    };
+};

package/dist/helpers/utils.js

@@ -138,3 +138,8 @@ export class Utils {
         return (prop ?? [])[0];
     }
 }
+export const TEST_HEADERS = {
+    headers: {
+        "Content-Type": "text/xml",
+    },
+};

package/dist/modules/auth/auth.module.spec.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, Utils } from "../../helpers";
+import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { AuthModule } from "./auth.module";
 jest.mock("axios");
 const mAxios = axios;
@@ -30,6 +30,7 @@ describe("AuthModule", () => {
 					</S:Body>
 			</S:Envelope>
 			`,
+            ...TEST_HEADERS,
         };
         mAxios.post.mockResolvedValueOnce(mockedResponse);
         const token = await authModule.authenticate(authToken);

package/dist/modules/carrier/carrier.module.spec.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, Utils } from "../../helpers";
+import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { CarrierModule } from "./carrier.module";
 jest.mock("axios");
 const mAxios = axios;
@@ -24,6 +24,7 @@ describe("CarrierModule.getCarrier()", () => {
 		</S:Envelope>
 		`;
         const mockedResp = {
+            ...TEST_HEADERS,
             data: `
 				<?xml version='1.0' encoding='UTF-8'?>
 				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -81,6 +82,7 @@ describe("CarrierModule.getCarrierByOrderNumber()", () => {
 		</S:Envelope>
 		`;
         const mockedResp = {
+            ...TEST_HEADERS,
             data: `
 				<?xml version='1.0' encoding='UTF-8'?>
 				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -148,6 +150,7 @@ describe("CarrierModule.getCarrierShipmentBySysTime()", () => {
 		</S:Envelope>
 		`;
         const mockedResp = {
+            ...TEST_HEADERS,
             data: `
 				<?xml version='1.0' encoding='UTF-8'?>
 				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -212,6 +215,7 @@ describe("CarrierModule.getDispatchDataByOrderNo()", () => {
 		</S:Envelope>
 		`;
         const mockedResp = {
+            ...TEST_HEADERS,
             data: `
         <?xml version='1.0' encoding='UTF-8'?>
         <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -241,20 +245,20 @@ describe("CarrierModule.getDispatchDataByOrderNo()", () => {
         };
         const expectedResult = {
             orderNo: orderNo,
-            customerOrderNo: 'ORDER',
-            reference: 'IFX0001103',
-            carrier: 'APOST',
-            consignmentNo: 'UTG1347015',
-            carrierTrackingNo: '',
-            dispatchDateTime: '23-08-2024 16:11:00',
-            dispatchLocation: '050',
-            stock: '5552001.KHAK',
-            size: '6',
+            customerOrderNo: "ORDER",
+            reference: "IFX0001103",
+            carrier: "APOST",
+            consignmentNo: "UTG1347015",
+            carrierTrackingNo: "",
+            dispatchDateTime: "23-08-2024 16:11:00",
+            dispatchLocation: "050",
+            stock: "5552001.KHAK",
+            size: "6",
             qdp: 0,
             pdp: 2,
             price: 90,
             shippedQty: 1,
-            sysModTime: '23-08-2024 16:11:24'
+            sysModTime: "23-08-2024 16:11:24",
         };
         mAxios.post.mockResolvedValueOnce(mockedResp);
         const response = await carrierModule.getDispatchDataByOrderNo(orderNo, token);
@@ -300,6 +304,7 @@ describe("CarrierModule.getDispatchDataByTime()", () => {
 		</S:Envelope>
 		`;
         const mockedResp = {
+            ...TEST_HEADERS,
             data: `
         <?xml version='1.0' encoding='UTF-8'?>
         <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -330,20 +335,20 @@ describe("CarrierModule.getDispatchDataByTime()", () => {
         };
         const expectedResult = {
             orderNo: orderNo,
-            customerOrderNo: 'ORDER',
-            reference: 'IFX0001103',
-            carrier: 'APOST',
-            consignmentNo: 'UTG1347015',
-            carrierTrackingNo: '',
-            dispatchDateTime: '23-08-2024 16:11:00',
-            dispatchLocation: '050',
-            stock: '5552001.KHAK',
-            size: '6',
+            customerOrderNo: "ORDER",
+            reference: "IFX0001103",
+            carrier: "APOST",
+            consignmentNo: "UTG1347015",
+            carrierTrackingNo: "",
+            dispatchDateTime: "23-08-2024 16:11:00",
+            dispatchLocation: "050",
+            stock: "5552001.KHAK",
+            size: "6",
             qdp: 0,
             pdp: 2,
             price: 90,
             shippedQty: 1,
-            sysModTime: '23-08-2024 16:11:24'
+            sysModTime: "23-08-2024 16:11:24",
         };
         mAxios.post.mockResolvedValueOnce(mockedResp);
         const response = await carrierModule.getDispatchDataByTime(params, token);

package/dist/modules/diary/diary.module.spec.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, Utils } from "../../helpers";
+import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
 import { DiaryModule } from "./diary.module";
 import { DiaryTitle } from "./types";
@@ -107,7 +107,7 @@ describe("DiaryModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = true;
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({ data: mockedResp, ...TEST_HEADERS });
         const response = await diaryModule.createDiary(params, token);
         console.log(response);
         // Test that expected response is correct

package/dist/modules/gift-voucher/gift-voucher.module.spec.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, Utils } from "../../helpers";
+import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
 import { GiftVoucherModule } from "./gift-voucher.module";
 jest.mock("axios");
@@ -106,7 +106,10 @@ describe("GiftVoucherModule", () => {
             countryCode: "",
             currency: "",
         };
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({
+            data: mockedResp,
+            ...TEST_HEADERS,
+        });
         const response = await gvModule.giftVoucherLookup(params, token);
         // Test that expected response is correct
         expect(Array.isArray(response)).toBe(true);
@@ -148,7 +151,10 @@ describe("GiftVoucherModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = "9426153259";
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({
+            data: mockedResp,
+            ...TEST_HEADERS,
+        });
         const response = await gvModule.giftVoucherVerificationKey(params, token);
         // Test that expected response is correct
         expect(typeof response === "string").toBe(true);
@@ -193,7 +199,10 @@ describe("GiftVoucherModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = "8951138685";
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({
+            data: mockedResp,
+            ...TEST_HEADERS,
+        });
         const response = await gvModule.giftVoucherReservation(params, token);
         // Test that expected response is correct
         expect(typeof response === "string").toBe(true);
@@ -238,7 +247,10 @@ describe("GiftVoucherModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = 111;
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({
+            data: mockedResp,
+            ...TEST_HEADERS,
+        });
         const response = await gvModule.giftVoucherUsed(params, token);
         // Test that expected response is correct
         expect(typeof response === "number").toBe(true);
@@ -283,7 +295,7 @@ describe("GiftVoucherModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = true;
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({ data: mockedResp, ...TEST_HEADERS });
         const response = await gvModule.giftVoucherReservationCancel(params, token);
         // Test that expected response is correct
         expect(typeof response === "boolean").toBe(true);

package/dist/modules/point-of-sale/point-of-sale.module.spec.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, Utils } from "../../helpers";
+import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
 import { PointOfSaleModule } from "./point-of-sale.module";
 import { AccountSaleFlag, CardName, PosPaymentType, PosQueryMode, } from "./types";
@@ -192,7 +192,7 @@ describe("PointOfSaleModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = true;
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({ data: mockedResp, ...TEST_HEADERS });
         const response = await posModule.processSalesOrder(params, token);
         // Test that expected response is correct
         expect(typeof response).toEqual("boolean");
@@ -353,7 +353,7 @@ describe("PointOfSaleModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = true;
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({ data: mockedResp, ...TEST_HEADERS });
         const response = await posModule.processSalesOrderWithoutPayment(params, token);
         // Test that expected response is correct
         expect(typeof response).toEqual("boolean");
@@ -502,7 +502,7 @@ describe("PointOfSaleModule", () => {
                 invoicePriceInc: 100.1,
                 rounding: 1.1,
                 totalTax: 2.1,
-                cashDrawerId: 'BIONLINE'
+                cashDrawerId: "BIONLINE",
             },
             extra: {
                 deliveryAddress1: "37",
@@ -554,7 +554,7 @@ describe("PointOfSaleModule", () => {
 		</S:Envelope>
 	`;
         const expectedResult = true;
-        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        mAxios.post.mockResolvedValueOnce({ data: mockedResp, ...TEST_HEADERS });
         const response = await posModule.processInvoice(params, token);
         // Test that expected response is correct
         expect(typeof response).toEqual("boolean");

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

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { ApiHelper, Utils } from "../../helpers";
+import { ApiHelper, TEST_HEADERS, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
 import { StockSearchType } from "../stock-lookup";
 import { StockLevelLookupModule } from "./stock-level-lookup.module";
@@ -46,6 +46,7 @@ describe("StockLevelLookupModule.warehouseLookup()", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            ...TEST_HEADERS,
         };
         const expectedResponse = {
             namekey: "000",
@@ -152,6 +153,7 @@ describe("StockLevelLookupModule.stockLevelLookup()", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            ...TEST_HEADERS,
         };
         const expectedResult = {
             stock: "4001003.BLK",
@@ -272,6 +274,7 @@ describe("StockLevelLookupModule.stockLevelLookup()", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            ...TEST_HEADERS,
         };
         const expectedResult = {
             stock: "4001003.BLK",

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

@@ -43,6 +43,9 @@ describe("SizeGridLookup", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         const expected = {
             namekey: "01",
@@ -96,6 +99,9 @@ describe("StockClassificationLookup", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         const mockedOutput = [
             { code: "BACK", description: "BACK PACK" },
@@ -127,6 +133,9 @@ describe("StockBarcodeLookup", () => {
 						</ns2:StockBarcodeLookupResponse>
     		</S:Body>
 			</S:Envelope>`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         const mockedOutput = [
             {
@@ -167,6 +176,9 @@ describe("StockBarcodeLookup", () => {
 						</ns2:StockBarcodeLookupResponse>
     		</S:Body>
 			</S:Envelope>`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         mAxios.post.mockResolvedValueOnce(resp);
         const response = await stockLookupModule.stockBarcodeLookup({
@@ -239,6 +251,9 @@ describe("StockColorLookup", () => {
 				</S:Body>
 				</S:Envelope>
 			`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         const mockedOutput = [
             {
@@ -272,6 +287,9 @@ describe("StockCatergoryLookup", () => {
 				</S:Body>
 				</S:Envelope>
 			`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         const mockedOutput = [
             {
@@ -356,6 +374,9 @@ describe("StockLookup", () => {
 						</S:Body>
 				</S:Envelope>
 			`,
+            headers: {
+                "Content-Type": "text/xml",
+            },
         };
         const mockedOutput = [
             {
@@ -412,6 +433,7 @@ describe("StockLookup", () => {
         ];
         mAxios.post.mockResolvedValueOnce(resp);
         const response = await stockLookupModule.stockLookup(params, `"${sessionId}"`);
+        console.log(response);
         expect(Array.isArray(response)).toEqual(true);
         expect(response.length).toEqual(1);
         expect(response).toEqual(mockedOutput);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdev/harmony-sdk",
-  "version": "1.21.0",
+  "version": "1.22.1",
   "description": "Harmony API SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,6 +17,7 @@
   "author": "DotApparel",
   "license": "ISC",
   "dependencies": {
+    "@google-cloud/pino-logging-gcp-config": "^1.0.4",
     "axios": "^1.7.2",
     "axios-retry": "^4.5.0",
     "pino": "^9.7.0",