@dotdev/harmony-sdk 1.19.0 → 1.21.0

package/dist/HarmonyAPI.d.ts

@@ -1,9 +1,11 @@
+import { AxiosInstance } from "axios";
 import { IAxiosRetryConfig } from "axios-retry";
 import { AuthenticationToken, Carrier, CarrierShipment, CreateDiaryQueryParams, Diary, DispatchData, GetCarrierShipmentByTimeQueryParams, GetDiaryQueryParams, GetDispatchDataByTimeQueryParams, ProcessInvoiceQueryParams, ProcessReturnsQueryParams, ProcessSaleOrderQueryParams, ProcessSaleOrderWithoutPaymentQueryParams, SizeGrid, Stock, StockBarcode, StockCategory, StockClassification, StockClassificationType, StockColor, StockLevel, StockLevelLookupQueryParams, StockLookupRequestParams, Warehouse } from "./modules";
 import { GiftVoucher, GiftVoucherLookupQueryParams, GiftVoucherReservationQueryParams, GiftVoucherUsedQueryParams, GiftVoucherVerificationKeyQueryParams } from "./modules/gift-voucher/types";
+import { RequestConfig } from "./types";
 export declare class HarmonyAPI {
     private baseUrl;
-    private axiosInstance;
+    axiosInstance: AxiosInstance;
     private authModule;
     private stockLookupModule;
     private stockLevelLookupModule;
@@ -11,7 +13,7 @@ export declare class HarmonyAPI {
     private carrierModule;
     private diaryModule;
     private giftVoucherModule;
-    constructor(url: string, axiosRetryConfig?: IAxiosRetryConfig);
+    constructor(url: string, axiosRetryConfig?: IAxiosRetryConfig, config?: RequestConfig);
     authenticate(authToken: AuthenticationToken): Promise<string>;
     stockLookup(params: StockLookupRequestParams, sessionId: string): Promise<Stock[]>;
     stockCategoryLookup(sessionId: string): Promise<StockCategory[]>;

package/dist/HarmonyAPI.js

@@ -16,12 +16,14 @@ export class HarmonyAPI {
     carrierModule;
     diaryModule;
     giftVoucherModule;
-    constructor(url, axiosRetryConfig) {
+    constructor(url, axiosRetryConfig, config) {
         this.baseUrl = url;
         this.axiosInstance = axios.create({
             baseURL: this.baseUrl,
             headers: {
+                ...config?.headers,
                 "Content-Type": "text/xml;charset=UTF-8",
+                "Accept-Encoding": "gzip, deflate, br", // Override default Accept-Encoding
             },
             httpsAgent: new https.Agent({
                 rejectUnauthorized: false,

package/dist/helpers/index.js

@@ -2,6 +2,7 @@ import axios from "axios";
 import { promisify } from "util";
 import { parseString } from "xml2js";
 import { RequestError } from "../errors";
+import logger from "./logger";
 import { Utils } from "./utils";
 export * from "./utils";
 const parseXml = promisify(parseString);
@@ -9,36 +10,41 @@ export class ApiHelper {
     static async sendSoapRequest(endpoint, axiosInstance, requestBody, type = "POST") {
         const url = `${endpoint}?wsdl`;
         let response;
-        let defaultConfig = {
-            headers: {
-                'Accept-Encoding': 'gzip, deflate, br' //Override default Accept-Encoding
-            }
-        };
         try {
             let response;
             switch (type) {
                 case "GET":
-                    response = await axiosInstance.get(url, {
-                        ...defaultConfig,
-                        params: {},
+                    response = await axiosInstance.get(url).catch((error) => {
+                        logger.error(error.toJSON(), `Error while sending request to ${endpoint} endpoint`);
+                        throw error;
                     });
                     break;
                 case "POST":
                 default:
-                    response = await axiosInstance.post(url, requestBody, {
-                        ...defaultConfig
-                        // headers: {
-                        //   'SOAPAction': request.action
-                        // }
+                    response = await axiosInstance
+                        .post(url, requestBody)
+                        .catch((error) => {
+                        logger.error(error.toJSON(), `Error while sending request to ${endpoint} endpoint`);
+                        throw error;
                     });
                     break;
             }
-            console.debug(`Harmony response (success) - size [${+response?.headers?.['content-length']}]: `, { response: response?.data });
+            const logs = logger.child({
+                request: requestBody,
+                response: response?.data,
+                size: +response?.headers?.["content-length"],
+                status: response?.status,
+            });
+            logs.debug(`Received Harmony response: `);
             const result = (await parseXml(response?.data)); // fix type
             return result["S:Envelope"]["S:Body"][0];
         }
         catch (error) {
-            console.error(`Harmony reponse (fail): `, { response });
+            const logs = logger.child({
+                request: requestBody,
+                error: error,
+            });
+            logs.error(`Error while when sending request to Harmony`);
             throw await ApiHelper.parseError(error);
         }
     }
@@ -89,7 +95,10 @@ export class ApiHelper {
             ? `ns2:${methodName[0]}Response`
             : `ns2:${methodName}Response`;
         const requestBody = ApiHelper.createServiceRequestBody(methodName, sessionId, serviceAlias, body);
-        console.debug(`Harmony request body`, { request: requestBody });
+        const child = logger.child({
+            request: requestBody,
+        });
+        child.debug(`Sending API request`);
         const response = await ApiHelper.sendSoapRequest(serviceName, axios, requestBody);
         return response[responseMethodName][0];
     }
@@ -100,8 +109,6 @@ export class ApiHelper {
                 return new RequestError(`API request failed with status ${error.response.status}: {code: ${parsedError?.code}, name: ${parsedError?.name}, message: ${parsedError?.message}}`);
             }
             else if (error?.request) {
-                console.log(`The following request was sent to server`);
-                console.log(error?.toJSON());
                 return new RequestError("No response received from the server during API call");
             }
             else {

package/dist/helpers/logger.d.ts

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

package/dist/helpers/logger.js

@@ -0,0 +1,3 @@
+import pino from "pino";
+const logger = pino();
+export default logger;

package/dist/helpers/utils.spec.js

@@ -1,4 +1,6 @@
+import { HarmonyAPI } from "../HarmonyAPI";
 import { Utils } from "./utils";
+jest.unmock("axios");
 describe("Utils", () => {
     test("isEmptyArray", () => {
         expect.assertions(7);
@@ -94,3 +96,15 @@ describe("Utils", () => {
         });
     });
 });
+describe("Misc", () => {
+    test("Axios should pass through request headers correctly", () => {
+        const harmonyApi = new HarmonyAPI("test", undefined, {
+            headers: { "test-header": "test-value" },
+        });
+        expect(harmonyApi.axiosInstance.defaults.headers["test-header"]).toEqual("test-value");
+        // Default header for Content-Type should be set to text/xml;charset=UTF-8
+        expect(harmonyApi.axiosInstance.defaults.headers["Content-Type"]).toEqual("text/xml;charset=UTF-8");
+        // 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");
+    });
+});

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

@@ -22,7 +22,6 @@ export class AuthModule {
         <S:Body>${loginBody}</S:Body>
       </S:Envelope>
     `;
-        console.debug(`Authenticating with Harmony. Request body: ${soapEnvelope}`);
         try {
             const response = await ApiHelper.sendSoapRequest("/AuthenticationService/AuthenticationService", this.axiosInstance, soapEnvelope);
             const token = response["ns2:LoginResponse"][0]["token"][0];

package/dist/types/index.d.ts

@@ -4,3 +4,6 @@ export * from "../modules/carrier/types";
 export * from "../modules/point-of-sale/types";
 export * from "../modules/stock-level-lookup/types";
 export * from "../modules/stock-lookup/types";
+export type RequestConfig = {
+    headers?: Record<string, string>;
+};

package/dist/types/index.js

@@ -3,4 +3,3 @@ export * from "../modules/carrier/types";
 export * from "../modules/point-of-sale/types";
 export * from "../modules/stock-level-lookup/types";
 export * from "../modules/stock-lookup/types";
-// other types could be added here

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdev/harmony-sdk",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "description": "Harmony API SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,6 +19,7 @@
   "dependencies": {
     "axios": "^1.7.2",
     "axios-retry": "^4.5.0",
+    "pino": "^9.7.0",
     "xml2js": "0.6.2"
   },
   "devDependencies": {