@dotdev/harmony-sdk 1.17.0 → 1.18.1

package/dist/HarmonyAPI.d.ts

@@ -1,5 +1,5 @@
 import { IAxiosRetryConfig } from "axios-retry";
-import { AuthenticationToken, Carrier, CarrierShipment, CreateDiaryQueryParams, Diary, GetCarrierShipmentByTimeQueryParams, GetDiaryQueryParams, ProcessInvoiceQueryParams, ProcessSaleOrderQueryParams, ProcessSaleOrderWithoutPaymentQueryParams, SizeGrid, Stock, StockBarcode, StockCategory, StockClassification, StockClassificationType, StockColor, StockLevel, StockLevelLookupQueryParams, StockLookupRequestParams, Warehouse } from "./modules";
+import { AuthenticationToken, Carrier, CarrierShipment, CreateDiaryQueryParams, Diary, DispatchData, GetCarrierShipmentByTimeQueryParams, GetDiaryQueryParams, GetDispatchDataByTimeQueryParams, ProcessInvoiceQueryParams, 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";
 export declare class HarmonyAPI {
     private baseUrl;
@@ -31,6 +31,8 @@ export declare class HarmonyAPI {
     cancelExistingSalesOrder(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<boolean>;
     getCarrier(sessionId: string): Promise<Carrier[]>;
     getCarrierShipmentByOrderNo(orderNo: string, sessionId: string): Promise<CarrierShipment[]>;
+    getDispatchDataByTime(params: GetDispatchDataByTimeQueryParams, sessionId: string): Promise<DispatchData[]>;
+    getDispatchDataByOrderNo(orderNo: string, sessionId: string): Promise<DispatchData[]>;
     getCarrierBySysTime(params: GetCarrierShipmentByTimeQueryParams, sessionId: string): Promise<CarrierShipment[]>;
     getDiaryBy(params: GetDiaryQueryParams, sessionId: string): Promise<Diary[]>;
     createDiary(params: CreateDiaryQueryParams, sessionId: string): Promise<boolean>;

package/dist/HarmonyAPI.js

@@ -111,6 +111,12 @@ export class HarmonyAPI {
     async getCarrierShipmentByOrderNo(orderNo, sessionId) {
         return await this.carrierModule.getCarrierShipmentByOrderNumber(orderNo, sessionId);
     }
+    async getDispatchDataByTime(params, sessionId) {
+        return await this.carrierModule.getDispatchDataByTime(params, sessionId);
+    }
+    async getDispatchDataByOrderNo(orderNo, sessionId) {
+        return await this.carrierModule.getDispatchDataByOrderNo(orderNo, sessionId);
+    }
     async getCarrierBySysTime(params, sessionId) {
         return await this.carrierModule.getCarrierShipmentBySysTime(params, sessionId);
     }

package/dist/modules/carrier/carrier.module.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { Carrier, CarrierShipment, GetCarrierShipmentByTimeQueryParams } from "./types";
+import { Carrier, CarrierShipment, DispatchData, GetCarrierShipmentByTimeQueryParams, GetDispatchDataByTimeQueryParams } from "./types";
 export declare class CarrierModule {
     private axiosInstance;
     private readonly SERVICE_URL;
@@ -7,4 +7,6 @@ export declare class CarrierModule {
     getCarrier(sessionId: string): Promise<Carrier[]>;
     getCarrierShipmentByOrderNumber(orderNo: string, sessionId: string): Promise<CarrierShipment[]>;
     getCarrierShipmentBySysTime(params: GetCarrierShipmentByTimeQueryParams, sessionId: string): Promise<CarrierShipment[]>;
+    getDispatchDataByOrderNo(orderNo: string, sessionId: string): Promise<DispatchData[]>;
+    getDispatchDataByTime(params: GetDispatchDataByTimeQueryParams, sessionId: string): Promise<DispatchData[]>;
 }

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

@@ -1,6 +1,6 @@
 import { ApiHelper } from "../../helpers";
 import { ServiceAlias } from "../shared";
-import { mapCarrier, mapCarrierShipment, mapGetCarrierShipmentByOrderNumber, mapGetCarrierShipmentByTimeQueryParams, } from "./mappings";
+import { mapCarrier, mapCarrierQueryByTimeParams, mapCarrierShipment, mapDispatchData, mapGetCarrierShipmentByOrderNumber, mapGetDispatchDataByOrderNoQueryParams, mapGetDispatchDataByTimeQueryParams, } from "./mappings";
 export class CarrierModule {
     axiosInstance;
     SERVICE_URL = `CarrierShipmentService/CarrierShipmentService`;
@@ -28,7 +28,7 @@ export class CarrierModule {
     }
     async getCarrierShipmentBySysTime(params, sessionId) {
         try {
-            const bodyStr = mapGetCarrierShipmentByTimeQueryParams(params);
+            const bodyStr = mapCarrierQueryByTimeParams(params);
             const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, ["GetCarrierShipmentBySysModTime", "Request"], sessionId, ServiceAlias.CARRIER, this.axiosInstance, bodyStr);
             return response?.CarrierShipment?.map(mapCarrierShipment);
         }
@@ -36,4 +36,24 @@ export class CarrierModule {
             throw await ApiHelper.parseError(error);
         }
     }
+    async getDispatchDataByOrderNo(orderNo, sessionId) {
+        const bodyStr = mapGetDispatchDataByOrderNoQueryParams(orderNo);
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, ["GetDispatchDataByOrderNumber", "Request"], sessionId, ServiceAlias.CARRIER, this.axiosInstance, bodyStr);
+            return response?.DispatchData?.map(mapDispatchData) ?? [];
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    async getDispatchDataByTime(params, sessionId) {
+        const bodyStr = mapGetDispatchDataByTimeQueryParams(params);
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, ["GetDispatchDataBySysModTime", "Request"], sessionId, ServiceAlias.CARRIER, this.axiosInstance, bodyStr);
+            return response?.DispatchData?.map(mapDispatchData) ?? [];
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
 }

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

@@ -185,3 +185,175 @@ describe("CarrierModule.getCarrierShipmentBySysTime()", () => {
         mAxios.post.mockReset();
     });
 });
+describe("CarrierModule.getDispatchDataByOrderNo()", () => {
+    const token = "test-sid"; // process.env.SESSION_ID as string;
+    let carrierModule;
+    let mockApiHelperSendRequest;
+    beforeAll(() => {
+        carrierModule = new CarrierModule(mAxios);
+        mockApiHelperSendRequest = jest.spyOn(ApiHelper, "sendSoapRequest");
+    });
+    it("should send correct request for getting dispatch data by order number and return a dispatch data object corresponding to the specified order", async () => {
+        const orderNo = "TEST";
+        const expectedPayload = `
+		<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:discs="http://discs.ws.fbsaust.com.au">
+				<S:Header>
+					<discs:SessionId>${token}</discs:SessionId>
+				</S:Header>
+				<S:Body>
+					
+				<discs:GetDispatchDataByOrderNumberRequest>
+					<parameter>
+						<OrderNo>${orderNo}</OrderNo>
+					</parameter>
+				</discs:GetDispatchDataByOrderNumberRequest>
+
+				</S:Body>
+		</S:Envelope>
+		`;
+        const mockedResp = {
+            data: `
+        <?xml version='1.0' encoding='UTF-8'?>
+        <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+            <S:Body>
+                <ns2:GetDispatchDataByOrderNumberResponse xmlns:ns2="http://discs.ws.fbsaust.com.au">
+                    <DispatchData>
+                        <customer_order_no>ORDER</customer_order_no>
+                        <order_no>${orderNo}</order_no>
+                        <reference>IFX0001103</reference>
+                        <carrier>APOST</carrier>
+                        <consignment_no>UTG1347015</consignment_no>
+                        <carrier_tracking_no></carrier_tracking_no>
+                        <dispatch_date_time>23-08-2024 16:11:00</dispatch_date_time>
+                        <dispatch_location>050</dispatch_location>
+                        <stock>5552001.KHAK</stock>
+                        <size>6</size>
+                        <qdp>0</qdp>
+                        <pdp>2</pdp>
+                        <price>90.00</price>
+                        <shipped_qty>1.0</shipped_qty>
+                        <sys_mod_time>23-08-2024 16:11:24</sys_mod_time>
+                    </DispatchData>
+                </ns2:GetDispatchDataByOrderNumberResponse>
+            </S:Body>
+         </S:Envelope>
+			`,
+        };
+        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',
+            qdp: 0,
+            pdp: 2,
+            price: 90,
+            shippedQty: 1,
+            sysModTime: '23-08-2024 16:11:24'
+        };
+        mAxios.post.mockResolvedValueOnce(mockedResp);
+        const response = await carrierModule.getDispatchDataByOrderNo(orderNo, token);
+        // Test that expected response is correct
+        expect(Array.isArray(response)).toBe(true);
+        expect(response.length).toBe(1);
+        expect(response[0]).toEqual(expectedResult);
+        const actualPayload = mAxios.post.mock.calls[0][1];
+        // Test that actual payload sent in the API matches expected payload
+        expect(Utils.removeEmptySpaces(actualPayload)).toEqual(Utils.removeEmptySpaces(expectedPayload));
+        mAxios.post.mockReset();
+    });
+});
+describe("CarrierModule.getDispatchDataByTime()", () => {
+    const token = "test-sid"; // process.env.SESSION_ID as string;
+    let carrierModule;
+    let mockApiHelperSendRequest;
+    beforeAll(() => {
+        carrierModule = new CarrierModule(mAxios);
+        mockApiHelperSendRequest = jest.spyOn(ApiHelper, "sendSoapRequest");
+    });
+    it("should send correct request for get dispatch data by time and return a list of dispatch data objects", async () => {
+        const params = {
+            sysModTimeFr: "01-01-2020 00:00:00",
+            sysModTimeTo: "01-01-2021 00:00:00",
+        };
+        const orderNo = "TEST";
+        const expectedPayload = `
+		<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:discs="http://discs.ws.fbsaust.com.au">
+				<S:Header>
+					<discs:SessionId>${token}</discs:SessionId>
+				</S:Header>
+				<S:Body>
+					
+				<discs:GetDispatchDataBySysModTimeRequest>
+					<parameter>
+						<SysModTimeFr>${params.sysModTimeFr}</SysModTimeFr>
+						<SysModTimeTo>${params.sysModTimeTo}</SysModTimeTo>
+					</parameter>
+				</discs:GetDispatchDataBySysModTimeRequest>
+
+				</S:Body>
+		</S:Envelope>
+		`;
+        const mockedResp = {
+            data: `
+        <?xml version='1.0' encoding='UTF-8'?>
+        <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+            <S:Body>
+                <ns2:GetDispatchDataBySysModTimeResponse xmlns:ns2="http://discs.ws.fbsaust.com.au">
+                    <SystemTime>07-04-2025 10:34:45</SystemTime>
+                    <DispatchData>
+                        <customer_order_no>ORDER</customer_order_no>
+                        <order_no>${orderNo}</order_no>
+                        <reference>IFX0001103</reference>
+                        <carrier>APOST</carrier>
+                        <consignment_no>UTG1347015</consignment_no>
+                        <carrier_tracking_no></carrier_tracking_no>
+                        <dispatch_date_time>23-08-2024 16:11:00</dispatch_date_time>
+                        <dispatch_location>050</dispatch_location>
+                        <stock>5552001.KHAK</stock>
+                        <size>6</size>
+                        <qdp>0</qdp>
+                        <pdp>2</pdp>
+                        <price>90.00</price>
+                        <shipped_qty>1.0</shipped_qty>
+                        <sys_mod_time>23-08-2024 16:11:24</sys_mod_time>
+                    </DispatchData>
+                </ns2:GetDispatchDataBySysModTimeResponse>
+            </S:Body>
+         </S:Envelope>
+			`,
+        };
+        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',
+            qdp: 0,
+            pdp: 2,
+            price: 90,
+            shippedQty: 1,
+            sysModTime: '23-08-2024 16:11:24'
+        };
+        mAxios.post.mockResolvedValueOnce(mockedResp);
+        const response = await carrierModule.getDispatchDataByTime(params, token);
+        // Test that expected response is correct
+        expect(Array.isArray(response)).toBe(true);
+        expect(response.length).toBe(1);
+        expect(response[0]).toEqual(expectedResult);
+        const actualPayload = mAxios.post.mock.calls[0][1];
+        // Test that actual payload sent in the API matches expected payload
+        expect(Utils.removeEmptySpaces(actualPayload)).toEqual(Utils.removeEmptySpaces(expectedPayload));
+        mAxios.post.mockReset();
+    });
+});

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

@@ -1,5 +1,8 @@
-import { Carrier, CarrierRaw, CarrierShipment, CarrierShipmentRaw, GetCarrierShipmentByTimeQueryParams } from "../types";
+import { Carrier, CarrierRaw, CarrierShipment, CarrierShipmentRaw, DispatchData, DispatchDataRaw, GetCarrierShipmentByTimeQueryParams, GetDispatchDataByTimeQueryParams } from "../types";
 export declare function mapCarrier(src: CarrierRaw): Carrier;
 export declare function mapCarrierShipment(src: CarrierShipmentRaw): CarrierShipment;
 export declare function mapGetCarrierShipmentByOrderNumber(orderNo: string): string;
-export declare function mapGetCarrierShipmentByTimeQueryParams(src: GetCarrierShipmentByTimeQueryParams): string;
+export declare function mapCarrierQueryByTimeParams(src: GetCarrierShipmentByTimeQueryParams): string;
+export declare function mapGetDispatchDataByTimeQueryParams(src: GetDispatchDataByTimeQueryParams): string;
+export declare function mapGetDispatchDataByOrderNoQueryParams(orderNo: string): string;
+export declare function mapDispatchData(src: DispatchDataRaw): DispatchData;

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

@@ -20,7 +20,7 @@ export function mapGetCarrierShipmentByOrderNumber(orderNo) {
     };
     return mapCarrierShipmentRequestBody(Utils.toXml(params));
 }
-export function mapGetCarrierShipmentByTimeQueryParams(src) {
+export function mapCarrierQueryByTimeParams(src) {
     const params = {
         SysModTimeFr: src?.sysModTimeFr,
         SysModTimeTo: src?.sysModTimeTo,
@@ -34,3 +34,29 @@ function mapCarrierShipmentRequestBody(body) {
 		</parameter>
 	`;
 }
+// ======================== Dispatch data / Partial shipment ========================
+export function mapGetDispatchDataByTimeQueryParams(src) {
+    return mapCarrierQueryByTimeParams(src);
+}
+export function mapGetDispatchDataByOrderNoQueryParams(orderNo) {
+    return mapGetCarrierShipmentByOrderNumber(orderNo);
+}
+export function mapDispatchData(src) {
+    return {
+        customerOrderNo: (src?.customer_order_no ?? [])[0] || '',
+        orderNo: (src?.order_no ?? [])[0] || '',
+        reference: (src?.reference ?? [])[0] || '',
+        carrier: (src?.carrier ?? [])[0] || '',
+        consignmentNo: (src?.consignment_no ?? [])[0] || '',
+        carrierTrackingNo: (src?.carrier_tracking_no ?? [])[0] || '',
+        dispatchDateTime: (src?.dispatch_date_time ?? [])[0] || '',
+        dispatchLocation: (src?.dispatch_location ?? [])[0] || '',
+        stock: (src?.stock ?? [])[0] || '',
+        size: (src?.size ?? [])[0] || '',
+        qdp: Utils.toNumber((src?.qdp ?? [])[0] || ''),
+        pdp: Utils.toNumber((src?.pdp ?? [])[0] || ''),
+        price: Utils.toNumber((src?.price ?? [])[0] || ''),
+        shippedQty: Utils.toNumber((src?.shipped_qty ?? [])[0] || ''),
+        sysModTime: (src?.sys_mod_time ?? [])[0] || '',
+    };
+}

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

@@ -1,3 +1,4 @@
+import { GenericTimestampQueryParams } from "../../shared";
 export interface CarrierRaw {
     namekey: CarrierCode[];
     name: string[];
@@ -39,17 +40,45 @@ export interface CarrierShipment {
 export interface CarrierShipmentResponse {
     CarrierShipment: CarrierShipmentRaw[];
 }
-export interface GetCarrierShipmentByTimeQueryParams {
-    /**
-     * From System Modify Time. Value must be in format dd-MM-yyyy hh:mm:SS
-     *
-     * @type {string}
-     */
-    sysModTimeFr?: string;
-    /**
-     * To System Modify Time. Value must be in format dd-MM-yyyy hh:mm:SS
-     *
-     * @type {string}
-     */
-    sysModTimeTo?: string;
+export type GetCarrierShipmentByTimeQueryParams = GenericTimestampQueryParams;
+export type GetDispatchDataByTimeQueryParams = GenericTimestampQueryParams;
+export interface GetDispatchDataByOrderNoQueryParams {
+    orderNo: string;
+}
+export interface DispatchDataResponse {
+    DispatchData: DispatchDataRaw[];
+}
+export interface DispatchDataRaw {
+    customer_order_no: string;
+    order_no: string;
+    reference: string;
+    carrier: string;
+    consignment_no: string;
+    carrier_tracking_no: string;
+    dispatch_date_time: string;
+    dispatch_location: string;
+    stock: string;
+    size: string;
+    qdp: string;
+    pdp: string;
+    price: string;
+    shipped_qty: string;
+    sys_mod_time: string;
+}
+export interface DispatchData {
+    customerOrderNo: string;
+    orderNo: string;
+    reference: string;
+    carrier: string;
+    consignmentNo: string;
+    carrierTrackingNo: string;
+    dispatchDateTime: string;
+    dispatchLocation: string;
+    stock: string;
+    size: string;
+    qdp: number;
+    pdp: number;
+    price: number;
+    shippedQty: number;
+    sysModTime: string;
 }

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

@@ -25,7 +25,7 @@ export declare enum ServiceAlias {
     DIARY = "dry",
     CARRIER = "discs"
 }
-export interface OptionalStockQueryParams {
+export interface OptionalStockQueryParams extends GenericTimestampQueryParams {
     stockCategoryFr?: string;
     stockCategoryTo?: string;
     stockClassFr1?: string;
@@ -44,8 +44,6 @@ export interface OptionalStockQueryParams {
     stockExtraClassTo4?: string;
     stockExtraClassFr5?: string;
     stockExtraClassTo5?: string;
-    sysModTimeFr?: string;
-    sysModTimeTo?: string;
     alternateNamekeyFr?: string;
     alternateNamekeyTo?: string;
     stockActive?: StockActive[];
@@ -91,3 +89,20 @@ export declare class OptionalStockRequestBody {
 export interface BooleanResponse {
     result: boolean[];
 }
+/**
+ * Generic interface for query parameters of endpoints that support querying using timestamps in Harmony
+ */
+export interface GenericTimestampQueryParams {
+    /**
+     * From System Modify Time. Value must be in format dd-MM-yyyy hh:mm:SS
+     *
+     * @type {string}
+     */
+    sysModTimeFr?: string;
+    /**
+     * To System Modify Time. Value must be in format dd-MM-yyyy hh:mm:SS
+     *
+     * @type {string}
+     */
+    sysModTimeTo?: string;
+}

package/package.json

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