@dotdev/harmony-sdk 1.3.0 → 1.4.0

package/dist/helpers/utils.d.ts

@@ -57,6 +57,7 @@ export declare abstract class Utils {
      * @returns {string}
      */
     static toXml(obj: object, parent?: string): string;
+    static objectToXml(obj: any): string;
     static deleteUndefinedProps(obj: any): any;
     static deleteEmptyProps(obj: any): any;
     /**

package/dist/helpers/utils.js

@@ -1,5 +1,5 @@
 import { promisify } from "util";
-import { parseString } from "xml2js";
+import xml2js, { parseString } from "xml2js";
 const parseXml = promisify(parseString);
 export class Utils {
     /**
@@ -94,23 +94,30 @@ export class Utils {
         const open = parent ? `<${parent}>` : "";
         const close = parent ? `</${parent}>` : "";
         if (Array.isArray(obj)) {
-            str += obj.map((o) => open + Utils.toXml(o) + close).join("");
+            str += obj
+                .map((o) => [open, Utils.toXml(o), close].join("\n"))
+                .join("\n");
         }
         else if (typeof obj === "object") {
             let valStr = "";
             for (const k in obj) {
                 const val = obj[k];
                 if (!(val == null)) {
-                    valStr += `${Utils.toXml(val, k)}`;
+                    valStr += `${Utils.toXml(val, k)}\n`;
                 }
             }
-            str += open + valStr + close;
+            str += [open, valStr, close].join("\n");
         }
         else {
             str += open + obj + close;
         }
         return str;
     }
+    // Function to convert object to xml using xml2js library
+    static objectToXml(obj) {
+        const builder = new xml2js.Builder({ headless: true });
+        return builder.buildObject(obj);
+    }
     static deleteUndefinedProps(obj) {
         Object.keys(obj).forEach((key) => obj[key] === undefined && delete obj[key]);
         return obj;

package/dist/modules/carrier/types/index.d.ts

@@ -8,8 +8,8 @@ export declare enum CarrierCode {
     ARAMEX = "ARAME",
     BORDER_EXPRESS_WHOLESALE = "BORD",
     BORDER_EXPRESS_RETAIL = "BORDR",
-    DIRECT_FRIEGHT_EXPRESS = "DFE",
-    DIRECT_FRIEGHT_EXPRESS_RETAIL = "DFER",
+    DIRECT_FREIGHT_EXPRESS = "DFE",
+    DIRECT_FREIGHT_EXPRESS_RETAIL = "DFER",
     NONE = "",
     STAR_TRACK = "STAR",
     TNT_ROAD_EXPRESS = "TNT",

package/dist/modules/carrier/types/index.js

@@ -6,8 +6,8 @@ export var CarrierCode;
     CarrierCode["ARAMEX"] = "ARAME";
     CarrierCode["BORDER_EXPRESS_WHOLESALE"] = "BORD";
     CarrierCode["BORDER_EXPRESS_RETAIL"] = "BORDR";
-    CarrierCode["DIRECT_FRIEGHT_EXPRESS"] = "DFE";
-    CarrierCode["DIRECT_FRIEGHT_EXPRESS_RETAIL"] = "DFER";
+    CarrierCode["DIRECT_FREIGHT_EXPRESS"] = "DFE";
+    CarrierCode["DIRECT_FREIGHT_EXPRESS_RETAIL"] = "DFER";
     CarrierCode["NONE"] = "";
     CarrierCode["STAR_TRACK"] = "STAR";
     CarrierCode["TNT_ROAD_EXPRESS"] = "TNT";

package/dist/modules/point-of-sale/mappings/process-sale-order.mapper.js

@@ -56,7 +56,7 @@ export function mapProcessSaleOrderQueryHeaders(params) {
         account_sale_flag: params?.accountSaleFlag,
         web_order_type: params?.webOrderType,
     };
-    return Utils.toXml(Utils.deleteEmptyProps(body));
+    return Utils.deleteEmptyProps(body);
 }
 export function mapProcessSaleOrderQueryExtra(params) {
     // XML body in JSON format, to be converted to XML string
@@ -85,7 +85,7 @@ export function mapProcessSaleOrderQueryExtra(params) {
         billing_telephone_work: params?.billingTelephoneWork,
         customised_info: params?.customisedInfo,
     };
-    return Utils.toXml(Utils.deleteEmptyProps(body));
+    return Utils.deleteEmptyProps(body);
 }
 export function mapProcessSaleOrderQueryStock(params) {
     // XML body in JSON format, to be converted to XML string
@@ -116,7 +116,7 @@ export function mapProcessSaleOrderQueryStock(params) {
         packs_per_carton: params?.packsPerCarton,
         size_pack_name: params?.sizePackName,
     };
-    return Utils.toXml(Utils.deleteEmptyProps(body));
+    return Utils.deleteEmptyProps(body);
 }
 export function mapProcessSaleOrderQueryDebtor(params) {
     // XML body in JSON format, to be converted to XML string
@@ -138,5 +138,5 @@ export function mapProcessSaleOrderQueryDebtor(params) {
         gift_voucher_serial_no: params?.giftVoucherSerialNo,
         reservation_history_no: params?.reservationHistoryNo,
     };
-    return Utils.toXml(Utils.deleteEmptyProps(body));
+    return Utils.deleteEmptyProps(body);
 }

package/dist/modules/point-of-sale/point-of-sale.module.d.ts

@@ -13,6 +13,15 @@ export declare class PointOfSaleModule {
      * @returns {Promise<boolean>}
      */
     processSalesOrder(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<boolean>;
+    /**
+     * Function to map ProcessSaleOrderQueryParams to XML for sending to the Point Of Sale service
+     * This is a TEMPORARY workaround to have the XML payload returned to be saved to the database
+     * TODO: combine this into the returned value of the `processSalesOrder` function
+     *
+     * @param {ProcessSaleOrderQueryParams} params
+     * @param {string} sessionId
+     */
+    mapOrderPayloadToXml(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<string>;
     /**
      * Function to call the ProcessReturns endpoint in Harmony Point Of Sale service
      *

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

@@ -1,6 +1,9 @@
-import { ApiHelper } from "../../helpers";
+import { ApiHelper, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
-import { mapProcessSaleOrderQueryParams } from "./mappings/process-sale-order.mapper";
+import { mapProcessSaleOrderQueryDebtor, mapProcessSaleOrderQueryExtra, mapProcessSaleOrderQueryHeaders, mapProcessSaleOrderQueryParams, mapProcessSaleOrderQueryStock, } from "./mappings/process-sale-order.mapper";
+import { promisify } from "util";
+import { parseString } from "xml2js";
+const parseXml = promisify(parseString);
 export class PointOfSaleModule {
     axiosInstance;
     SERVICE_URL = "PointOfSaleService/PointOfSaleService";
@@ -25,6 +28,48 @@ export class PointOfSaleModule {
             throw await ApiHelper.parseError(error);
         }
     }
+    /**
+     * Function to map ProcessSaleOrderQueryParams to XML for sending to the Point Of Sale service
+     * This is a TEMPORARY workaround to have the XML payload returned to be saved to the database
+     * TODO: combine this into the returned value of the `processSalesOrder` function
+     *
+     * @param {ProcessSaleOrderQueryParams} params
+     * @param {string} sessionId
+     */
+    async mapOrderPayloadToXml(params, sessionId) {
+        const methodName = ["ProcessSalesOrder", "Request"];
+        const soapNamespace = "S";
+        // Extract method name and construct corresponding properties for the body of the SOAP request and the response from the API
+        const bodyMethodName = Array.isArray(methodName)
+            ? methodName.join("")
+            : methodName;
+        const body = {
+            mode: params?.mode,
+            audit_no: params?.auditNo,
+            export_no: params?.exportNo,
+            header: mapProcessSaleOrderQueryHeaders(params?.header),
+            extra: mapProcessSaleOrderQueryExtra(params?.extra),
+            stock: params?.stock.map(mapProcessSaleOrderQueryStock),
+            debtor: mapProcessSaleOrderQueryDebtor((params?.debtor ?? [])[0]),
+        };
+        const soapBodyJson = {};
+        soapBodyJson[`${ServiceAlias.POINT_OF_SALE}:${bodyMethodName}`] =
+            body;
+        const soapBody = Utils.objectToXml(soapBodyJson);
+        const soapHeader = `
+				<${ServiceAlias.POINT_OF_SALE}:SessionId>${sessionId}</${ServiceAlias.POINT_OF_SALE}:SessionId>
+			`;
+        const fullXml = `
+				<${soapNamespace}:Envelope xmlns:${soapNamespace}="http://schemas.xmlsoap.org/soap/envelope/" xmlns:${ServiceAlias.POINT_OF_SALE}="http://${ServiceAlias.POINT_OF_SALE}.ws.fbsaust.com.au">
+					<${soapNamespace}:Header>${soapHeader}</${soapNamespace}:Header>
+					<${soapNamespace}:Body>
+						${soapBody}
+					</${soapNamespace}:Body>
+				</${soapNamespace}:Envelope>
+			`;
+        const parsedJson = await parseXml(fullXml);
+        return Utils.objectToXml(parsedJson);
+    }
     /**
      * Function to call the ProcessReturns endpoint in Harmony Point Of Sale service
      *

package/package.json

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