@dotdev/harmony-sdk 1.27.1 → 1.28.0

package/dist/HarmonyAPI.js

@@ -3,7 +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 { 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);

package/dist/helpers/index.js

@@ -2,7 +2,7 @@ import axios from "axios";
 import { promisify } from "util";
 import { parseString } from "xml2js";
 import { RequestError } from "../errors";
-import logger from "./logger";
+import { logger } from "./logger";
 import { Utils } from "./utils";
 export * from "./utils";
 const parseXml = promisify(parseString);
@@ -20,28 +20,26 @@ export class ApiHelper {
                     response = await axiosInstance.post(url, requestBody);
                     break;
             }
-            const logs = logger.child({
-                request: requestBody,
-                response: response?.data,
-                size: +(response?.headers?.["Content-Length"] || 0),
-                status: response?.status,
-            });
-            logs.debug(`Received Harmony response: `);
+            logger.debug({
+                request: Utils.removeTabsAndNewLines(requestBody),
+                response: {
+                    data: response?.data,
+                    headers: response?.headers,
+                    size: +(response?.headers?.["content-length"] || 0),
+                    status: response?.status,
+                },
+            }, `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)}`);
+            if (response?.headers["content-type"] !== "text/xml" &&
+                response?.headers["content-type"] !== "text/xml;charset=utf-8" &&
+                response?.headers["content-type"] !== "application/xml") {
+                logger.error(new Error(`Returned response not in XML format. This is likely a gateway error - [${response?.status} - ${response?.statusText}]: ${response.data}`));
             }
             // Parse the XML response
             const result = (await parseXml(response?.data)); // fix type
             return result["S:Envelope"]["S:Body"][0];
         }
         catch (error) {
-            const logs = logger.child({
-                request: requestBody,
-                error: error,
-            });
-            logs.error(`Error while when sending request to Harmony`);
             throw await ApiHelper.parseError(error);
         }
     }
@@ -127,9 +125,10 @@ export class ApiHelper {
             }
         }
         else {
-            logger.error(`Unexpected error occurred during API request`);
-            throw JSON.stringify(error);
+            console.log(JSON.stringify(error));
+            logger.error(`=============== Unexpected error occurred during API request ===============`);
         }
+        return new RequestError(`Unexpected error occurred during API request`);
     }
     /**
      * Extract error response from Harmony in XML format and convert it to JSON format for ease of debugging

package/dist/helpers/logger.d.ts

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

package/dist/helpers/logger.js

@@ -1,4 +1,10 @@
 import { createGcpLoggingPinoConfig } from "@google-cloud/pino-logging-gcp-config";
-import * as pino from "pino";
-const logger = pino.pino(createGcpLoggingPinoConfig());
-export default logger;
+import pino from "pino";
+export const logger = pino(createGcpLoggingPinoConfig({
+    serviceContext: {
+        service: "harmony-sdk",
+    },
+}, {
+    // set Pino log level to 'debug'
+    level: "debug",
+}));

package/dist/helpers/utils.d.ts

@@ -75,6 +75,7 @@ export declare abstract class Utils {
      * @returns
      */
     static isValidXml(xmlString: string): boolean;
+    static removeTabsAndNewLines(str?: string): string;
 }
 export declare const TEST_HEADERS: {
     headers: {

package/dist/helpers/utils.js

@@ -158,6 +158,11 @@ export class Utils {
         }
         return stack.length === 0;
     }
+    static removeTabsAndNewLines(str) {
+        if (!str)
+            return "";
+        return str.replace(/  |\r\n|\n|\r/gm, "");
+    }
 }
 export const TEST_HEADERS = {
     headers: {

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

@@ -6,6 +6,7 @@ export class AuthModule {
         this.axiosInstance = axiosInstance;
     }
     async authenticate(authToken) {
+        console.log(`===========================================================================`);
         // @todo: TBC whether using `xmlbuilder` or template string
         const authHeader = `
       <ns2:AuthenticationToken xmlns:ns2="http://auth.ws.fbsaust.com.au" xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -15,6 +16,7 @@ export class AuthModule {
         <timeout>${authToken.timeout}${authToken.timeoutUnit}</timeout>
       </ns2:AuthenticationToken>
     `;
+        console.log(`authHeader`, authHeader);
         const loginBody = '<ns2:Login xmlns:ns2="http://auth.ws.fbsaust.com.au"/>';
         const soapEnvelope = `
       <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
@@ -22,6 +24,7 @@ export class AuthModule {
         <S:Body>${loginBody}</S:Body>
       </S:Envelope>
     `;
+        console.log(`soapEnvelope`, soapEnvelope);
         try {
             const response = await ApiHelper.sendSoapRequest("/AuthenticationService/AuthenticationService", this.axiosInstance, soapEnvelope);
             const token = response["ns2:LoginResponse"][0]["token"][0];
@@ -35,6 +38,8 @@ export class AuthModule {
                 throw error;
             }
             else {
+                console.error(`Auth error`);
+                console.error(error);
                 throw new AuthenticationError(`An unexpected error occurred: ${error.message}`);
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdev/harmony-sdk",
-  "version": "1.27.1",
+  "version": "1.28.0",
   "description": "Harmony API SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,6 +45,7 @@
     "watch": "tsc -w",
     "test": "jest",
     "release": "./release.sh",
-    "prettier": "prettier --write ."
+    "prettier": "prettier --write .",
+    "refreshLocal": "pnpm run build && yalc push --sig"
   }
 }