@dotdev/harmony-sdk 1.0.1

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

@@ -0,0 +1,317 @@
+import axios from "axios";
+import { ApiHelper, Utils } from "../../helpers";
+import { ServiceAlias } from "../shared";
+import { StockSearchType } from "../stock-lookup";
+import { StockLevelLookupModule } from "./stock-level-lookup.module";
+import { OnlyNonZero, QtyType, Summarised, } from "./types";
+jest.mock("axios");
+const mAxios = axios;
+describe("StockLevelLookupModule.warehouseLookup()", () => {
+    const sessionId = "test-sid"; // process.env.SESSION_ID as string;
+    let stockLookupLevelModule;
+    let mockApiHelperSendRequest;
+    beforeAll(() => {
+        stockLookupLevelModule = new StockLevelLookupModule(mAxios);
+        mockApiHelperSendRequest = jest.spyOn(ApiHelper, "sendSoapRequest");
+    });
+    it("should return a list of warehouses", async () => {
+        const ns = "S";
+        const expectedPayload = `
+			<${ns}:Envelope xmlns:${ns}="http://schemas.xmlsoap.org/soap/envelope/" xmlns:${ServiceAlias.STOCK_LEVEL_LOOKUP}="http://${ServiceAlias.STOCK_LEVEL_LOOKUP}.ws.fbsaust.com.au">
+					<${ns}:Header>
+						<${ServiceAlias.STOCK_LEVEL_LOOKUP}:SessionId>${sessionId}</${ServiceAlias.STOCK_LEVEL_LOOKUP}:SessionId>
+					</${ns}:Header>
+					<${ns}:Body>
+						<${ServiceAlias.STOCK_LEVEL_LOOKUP}:WarehouseLookup></${ServiceAlias.STOCK_LEVEL_LOOKUP}:WarehouseLookup>
+					</${ns}:Body>
+			</${ns}:Envelope>
+		`;
+        const mockedResp = {
+            data: `
+				<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+						<S:Body>
+								<ns2:WarehouseLookupResponse xmlns:ns2="http://${ServiceAlias.STOCK_LEVEL_LOOKUP}.ws.fbsaust.com.au">
+										<Warehouse>
+												<namekey>000</namekey>
+												<description_1>TEST WAREHOUSE</description_1>
+												<description_2>TEST DESCRIPTION</description_2>
+												<class_1>a</class_1>
+												<class_2>b</class_2>
+												<class_3>c</class_3>
+												<class_4>d</class_4>
+												<class_5>e</class_5>
+										</Warehouse>
+								</ns2:WarehouseLookupResponse>
+						</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const expectedResponse = {
+            namekey: "000",
+            description1: "TEST WAREHOUSE",
+            description2: "TEST DESCRIPTION",
+            class1: "a",
+            class2: "b",
+            class3: "c",
+            class4: "d",
+            class5: "e",
+        };
+        mAxios.post.mockResolvedValueOnce(mockedResp);
+        const response = await stockLookupLevelModule.warehouseLookup(sessionId);
+        // Test that expected response is correct
+        expect(Array.isArray(response)).toBe(true);
+        expect(response.length).toBe(1);
+        expect(response[0]).toEqual(expectedResponse);
+        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.mockClear();
+    });
+});
+describe("StockLevelLookupModule.stockLevelLookup()", () => {
+    const sessionId = "test-sid"; // process.env.SESSION_ID as string;
+    let stockLookupLevelModule;
+    let mockApiHelperSendRequest;
+    beforeAll(() => {
+        stockLookupLevelModule = new StockLevelLookupModule(mAxios);
+        mockApiHelperSendRequest = jest.spyOn(ApiHelper, "sendSoapRequest");
+    });
+    it("should send correct request for stockLevelLookup and return a list of stock level objets", async () => {
+        const params = {
+            searchType: {
+                type: StockSearchType.STOCK_KEYWORD,
+                value: "TEST",
+            },
+            qtyType: QtyType.STK,
+            summarised: Summarised.EXPANDED,
+            onlyNonZero: OnlyNonZero.NO,
+            warehouse1: "123",
+        };
+        const ns = "S";
+        const expectedPayload = `
+		<${ns}:Envelope xmlns:${ns}="http://schemas.xmlsoap.org/soap/envelope/" xmlns:${ServiceAlias.STOCK_LEVEL_LOOKUP}="http://${ServiceAlias.STOCK_LEVEL_LOOKUP}.ws.fbsaust.com.au">
+				<${ns}:Header>
+						<${ServiceAlias.STOCK_LEVEL_LOOKUP}:SessionId>${sessionId}</${ServiceAlias.STOCK_LEVEL_LOOKUP}:SessionId>
+				</${ns}:Header>
+				<${ns}:Body>
+						<${ServiceAlias.STOCK_LEVEL_LOOKUP}:StockLevelLookupRequest>
+								<SearchType>
+										<Type>${params.searchType.type}</Type>
+										<Value>${params.searchType.value}</Value>
+								</SearchType>
+								<QtyType>
+										<Type>${params.qtyType}</Type>
+								</QtyType>
+								<Summarised>${params.summarised}</Summarised>
+								<OnlyNonZero>${params.onlyNonZero}</OnlyNonZero>
+								<Warehouse1>${params.warehouse1}</Warehouse1>
+						</${ServiceAlias.STOCK_LEVEL_LOOKUP}:StockLevelLookupRequest>
+				</${ns}:Body>
+		</${ns}:Envelope>
+		`;
+        const mockedResp = {
+            data: `
+				<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+						<S:Body>
+								<ns2:StockLevelLookupResponse xmlns:ns2="http://${ServiceAlias.STOCK_LEVEL_LOOKUP}.ws.fbsaust.com.au">
+										<SystemTime>05-08-2024 11:21:28</SystemTime>
+										<StockLevel>
+												<stock>4001003.BLK</stock>
+												<stock_type>Pack</stock_type>
+												<pack>ED7</pack>
+												<warehouse>114</warehouse>
+												<sales_code>@MA</sales_code>
+												<qty_type>FRE</qty_type>
+												<qdp>0</qdp>
+												<pack_qty>0.0</pack_qty>
+												<qty>0.0</qty>
+												<sizeQty1>0.0</sizeQty1>
+												<sizeQty2>0.0</sizeQty2>
+												<sizeQty3>0.0</sizeQty3>
+												<sizeQty4>0.0</sizeQty4>
+												<sizeQty5>0.0</sizeQty5>
+												<sizeQty6>0.0</sizeQty6>
+												<sizeQty7>0.0</sizeQty7>
+												<sizeQty8>0.0</sizeQty8>
+												<sizeQty9>0.0</sizeQty9>
+												<sizeQty10>0.0</sizeQty10>
+												<sizeQty11>0.0</sizeQty11>
+												<sizeQty12>0.0</sizeQty12>
+												<sizeQty13>0.0</sizeQty13>
+												<sizeQty14>0.0</sizeQty14>
+												<sizeQty15>0.0</sizeQty15>
+												<sizeQty16>0.0</sizeQty16>
+												<sizeQty17>0.0</sizeQty17>
+												<sizeQty18>0.0</sizeQty18>
+												<sizeQty19>0.0</sizeQty19>
+												<sizeQty20>0.0</sizeQty20>
+										</StockLevel>
+								</ns2:StockLevelLookupResponse>
+						</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const expectedResult = {
+            stock: "4001003.BLK",
+            stockType: "Pack",
+            pack: "ED7",
+            warehouse: "114",
+            salesCode: "@MA",
+            qtyType: "FRE",
+            qdp: 0,
+            packQty: 0,
+            qty: 0,
+            sizeQty1: 0,
+            sizeQty2: 0,
+            sizeQty3: 0,
+            sizeQty4: 0,
+            sizeQty5: 0,
+            sizeQty6: 0,
+            sizeQty7: 0,
+            sizeQty8: 0,
+            sizeQty9: 0,
+            sizeQty10: 0,
+            sizeQty11: 0,
+            sizeQty12: 0,
+            sizeQty13: 0,
+            sizeQty14: 0,
+            sizeQty15: 0,
+            sizeQty16: 0,
+            sizeQty17: 0,
+            sizeQty18: 0,
+            sizeQty19: 0,
+            sizeQty20: 0,
+        };
+        mAxios.post.mockResolvedValueOnce(mockedResp);
+        const response = await stockLookupLevelModule.stockLevelLookup(params, sessionId);
+        // 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();
+    });
+    it("should send correct request for stockLevelLookupByWarehouseQuickView and return a list of stock level objets", async () => {
+        const params = {
+            searchType: {
+                type: StockSearchType.STOCK_KEYWORD,
+                value: "TEST",
+            },
+            qtyType: QtyType.STK,
+            onlyNonZero: OnlyNonZero.NO,
+            warehouse: "123",
+            sysModTimeFr: "2020-02-02 00:00:00",
+            sysModTimeTo: "2020-02-02 01:00:00",
+        };
+        const ns = "S";
+        const expectedPayload = `
+		<${ns}:Envelope xmlns:${ns}="http://schemas.xmlsoap.org/soap/envelope/" xmlns:${ServiceAlias.STOCK_LEVEL_LOOKUP}="http://${ServiceAlias.STOCK_LEVEL_LOOKUP}.ws.fbsaust.com.au">
+				<${ns}:Header>
+						<${ServiceAlias.STOCK_LEVEL_LOOKUP}:SessionId>${sessionId}</${ServiceAlias.STOCK_LEVEL_LOOKUP}:SessionId>
+				</${ns}:Header>
+				<${ns}:Body>
+				<${ServiceAlias.STOCK_LEVEL_LOOKUP}:StockLevelLookupByWarehouseQuickViewRequest>
+						<SysModTimeFr>${params.sysModTimeFr}</SysModTimeFr>
+						<SysModTimeTo>${params.sysModTimeTo}</SysModTimeTo>
+								<SearchType>
+										<Type>${params.searchType.type}</Type>
+										<Value>${params.searchType.value}</Value>
+								</SearchType>
+								<QtyType>
+										<Type>${params.qtyType}</Type>
+								</QtyType>
+								<OnlyNonZero>${params.onlyNonZero}</OnlyNonZero>
+								<Warehouse>${params.warehouse}</Warehouse>
+						</${ServiceAlias.STOCK_LEVEL_LOOKUP}:StockLevelLookupByWarehouseQuickViewRequest>
+				</${ns}:Body>
+		</${ns}:Envelope>
+		`;
+        const mockedResp = {
+            data: `
+				<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+						<S:Body>
+								<ns2:StockLevelLookupByWarehouseQuickViewResponse xmlns:ns2="http://${ServiceAlias.STOCK_LEVEL_LOOKUP}.ws.fbsaust.com.au">
+										<SystemTime>05-08-2024 11:21:28</SystemTime>
+										<StockLevel>
+												<stock>4001003.BLK</stock>
+												<stock_type>Pack</stock_type>
+												<pack>ED7</pack>
+												<warehouse>114</warehouse>
+												<sales_code>@MA</sales_code>
+												<qty_type>FRE</qty_type>
+												<qdp>0</qdp>
+												<pack_qty>0.0</pack_qty>
+												<qty>0.0</qty>
+												<sizeQty1>0.0</sizeQty1>
+												<sizeQty2>0.0</sizeQty2>
+												<sizeQty3>0.0</sizeQty3>
+												<sizeQty4>0.0</sizeQty4>
+												<sizeQty5>0.0</sizeQty5>
+												<sizeQty6>0.0</sizeQty6>
+												<sizeQty7>0.0</sizeQty7>
+												<sizeQty8>0.0</sizeQty8>
+												<sizeQty9>0.0</sizeQty9>
+												<sizeQty10>0.0</sizeQty10>
+												<sizeQty11>0.0</sizeQty11>
+												<sizeQty12>0.0</sizeQty12>
+												<sizeQty13>0.0</sizeQty13>
+												<sizeQty14>0.0</sizeQty14>
+												<sizeQty15>0.0</sizeQty15>
+												<sizeQty16>0.0</sizeQty16>
+												<sizeQty17>0.0</sizeQty17>
+												<sizeQty18>0.0</sizeQty18>
+												<sizeQty19>0.0</sizeQty19>
+												<sizeQty20>0.0</sizeQty20>
+										</StockLevel>
+								</ns2:StockLevelLookupByWarehouseQuickViewResponse>
+						</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const expectedResult = {
+            stock: "4001003.BLK",
+            stockType: "Pack",
+            pack: "ED7",
+            warehouse: "114",
+            salesCode: "@MA",
+            qtyType: "FRE",
+            qdp: 0,
+            packQty: 0,
+            qty: 0,
+            sizeQty1: 0,
+            sizeQty2: 0,
+            sizeQty3: 0,
+            sizeQty4: 0,
+            sizeQty5: 0,
+            sizeQty6: 0,
+            sizeQty7: 0,
+            sizeQty8: 0,
+            sizeQty9: 0,
+            sizeQty10: 0,
+            sizeQty11: 0,
+            sizeQty12: 0,
+            sizeQty13: 0,
+            sizeQty14: 0,
+            sizeQty15: 0,
+            sizeQty16: 0,
+            sizeQty17: 0,
+            sizeQty18: 0,
+            sizeQty19: 0,
+            sizeQty20: 0,
+        };
+        mAxios.post.mockResolvedValueOnce(mockedResp);
+        const response = await stockLookupLevelModule.stockLevelLookupByWarehouseQuickView(params, sessionId);
+        // 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));
+    });
+});

package/dist/modules/stock-level-lookup/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./stock-level-lookup.interface";

package/dist/modules/stock-level-lookup/types/index.js

@@ -0,0 +1 @@
+export * from "./stock-level-lookup.interface";

package/dist/modules/stock-level-lookup/types/stock-level-lookup.interface.d.ts

@@ -0,0 +1,162 @@
+import { CombinedSearchTypeValue, OptionalStockQueryParams, OptionalStockRequestBody } from "../../shared/types";
+export interface WarehouseRaw {
+    namekey: string[];
+    description_1?: string[];
+    description_2?: string[];
+    class_1?: string[];
+    class_2?: string[];
+    class_3?: string[];
+    class_4?: string[];
+    class_5?: string[];
+}
+export interface Warehouse {
+    namekey: string;
+    description1?: string;
+    description2?: string;
+    class1?: string;
+    class2?: string;
+    class3?: string;
+    class4?: string;
+    class5?: string;
+}
+export interface WarehouseResponse {
+    Warehouse: WarehouseRaw[];
+}
+export interface StockLevelResponse {
+    StockLevel: StockLevelRaw[];
+}
+export interface StockLevel {
+    stock: string;
+    stockType: string;
+    pack: string;
+    warehouse: string;
+    salesCode: string;
+    qtyType: string;
+    qdp: number;
+    packQty: number;
+    qty: number;
+    sizeQty1: number;
+    sizeQty2: number;
+    sizeQty3: number;
+    sizeQty4: number;
+    sizeQty5: number;
+    sizeQty6: number;
+    sizeQty7: number;
+    sizeQty8: number;
+    sizeQty9: number;
+    sizeQty10: number;
+    sizeQty11: number;
+    sizeQty12: number;
+    sizeQty13: number;
+    sizeQty14: number;
+    sizeQty15: number;
+    sizeQty16: number;
+    sizeQty17: number;
+    sizeQty18: number;
+    sizeQty19: number;
+    sizeQty20: number;
+}
+export interface StockLevelRaw {
+    stock: string[];
+    stock_type: string[];
+    pack: string[];
+    warehouse: string[];
+    sales_code: string[];
+    qty_type: string[];
+    qdp: string[];
+    pack_qty: string[];
+    qty: string[];
+    size_qty_01: string[];
+    size_qty_02: string[];
+    size_qty_03: string[];
+    size_qty_04: string[];
+    size_qty_05: string[];
+    size_qty_06: string[];
+    size_qty_07: string[];
+    size_qty_08: string[];
+    size_qty_09: string[];
+    size_qty_10: string[];
+    size_qty_11: string[];
+    size_qty_12: string[];
+    size_qty_13: string[];
+    size_qty_14: string[];
+    size_qty_15: string[];
+    size_qty_16: string[];
+    size_qty_17: string[];
+    size_qty_18: string[];
+    size_qty_19: string[];
+    size_qty_20: string[];
+}
+export declare class StockLevelLookupRequestBody extends OptionalStockRequestBody {
+    SearchType: string;
+    QtyType: string;
+    Summarised?: string;
+    OnlyNonZero?: string;
+    Warehouse?: string;
+    Warehouse1?: string;
+    Warehouse2?: string;
+    Warehouse3?: string;
+    Warehouse4?: string;
+    Warehouse5?: string;
+    Warehouse6?: string;
+    Warehouse7?: string;
+    Warehouse8?: string;
+    Warehouse9?: string;
+    Warehouse10?: string;
+    WarehouseClassFr1?: string;
+    WarehouseClassTo1?: string;
+    WarehouseClassFr2?: string;
+    WarehouseClassTo2?: string;
+    WarehouseClassFr3?: string;
+    WarehouseClassTo3?: string;
+    WarehouseClassFr4?: string;
+    WarehouseClassTo4?: string;
+    WarehouseClassFr5?: string;
+    WarehouseClassTo5?: string;
+    constructor(obj: Partial<StockLevelLookupRequestBody>);
+    toString(): string;
+}
+export interface StockLevelLookupQueryParams extends OptionalStockQueryParams {
+    searchType: CombinedSearchTypeValue;
+    qtyType: QtyType;
+    summarised?: Summarised;
+    onlyNonZero?: OnlyNonZero;
+    warehouse?: string;
+    warehouse1?: string;
+    warehouse2?: string;
+    warehouse3?: string;
+    warehouse4?: string;
+    warehouse5?: string;
+    warehouse6?: string;
+    warehouse7?: string;
+    warehouse8?: string;
+    warehouse9?: string;
+    warehouse10?: string;
+    warehouseClassFr1?: string;
+    warehouseClassTo1?: string;
+    warehouseClassFr2?: string;
+    warehouseClassTo2?: string;
+    warehouseClassFr3?: string;
+    warehouseClassTo3?: string;
+    warehouseClassFr4?: string;
+    warehouseClassTo4?: string;
+    warehouseClassFr5?: string;
+    warehouseClassTo5?: string;
+}
+export declare enum QtyType {
+    STK = "STK",
+    FRE = "FRE",
+    FUT = "FUT",
+    AVL = "AVL"
+}
+export declare enum Summarised {
+    EXPANDED = "E",
+    SUMMARISED = "S"
+}
+export declare enum OnlyNonZero {
+    YES = "Y",
+    NO = "N"
+}
+export interface StockLevelByWarehouseQuickViewResponse {
+    StockLevel: StockLevelRaw[];
+}

package/dist/modules/stock-level-lookup/types/stock-level-lookup.interface.js

@@ -0,0 +1,61 @@
+import { OptionalStockRequestBody, } from "../../shared/types";
+export class StockLevelLookupRequestBody extends OptionalStockRequestBody {
+    SearchType; // XML string with Te.g. <Type>StockKeyword</Type><Value>WEBSIL</Value>
+    QtyType;
+    Summarised;
+    OnlyNonZero;
+    Warehouse; // warehouse namekey
+    Warehouse1;
+    Warehouse2;
+    Warehouse3;
+    Warehouse4;
+    Warehouse5;
+    Warehouse6;
+    Warehouse7;
+    Warehouse8;
+    Warehouse9;
+    Warehouse10;
+    WarehouseClassFr1;
+    WarehouseClassTo1;
+    WarehouseClassFr2;
+    WarehouseClassTo2;
+    WarehouseClassFr3;
+    WarehouseClassTo3;
+    WarehouseClassFr4;
+    WarehouseClassTo4;
+    WarehouseClassFr5;
+    WarehouseClassTo5;
+    constructor(obj) {
+        if (!obj?.SearchType) {
+            throw new Error("SearchType is required when constructing StockLookup request body");
+        }
+        super(obj);
+        Object.assign(this, obj);
+    }
+    toString() {
+        let str = "";
+        for (const k in this) {
+            if (this[k]) {
+                str += `<${k}>${this[k]}</${k}>\n`;
+            }
+        }
+        return str;
+    }
+}
+export var QtyType;
+(function (QtyType) {
+    QtyType["STK"] = "STK";
+    QtyType["FRE"] = "FRE";
+    QtyType["FUT"] = "FUT";
+    QtyType["AVL"] = "AVL";
+})(QtyType || (QtyType = {}));
+export var Summarised;
+(function (Summarised) {
+    Summarised["EXPANDED"] = "E";
+    Summarised["SUMMARISED"] = "S";
+})(Summarised || (Summarised = {}));
+export var OnlyNonZero;
+(function (OnlyNonZero) {
+    OnlyNonZero["YES"] = "Y";
+    OnlyNonZero["NO"] = "N";
+})(OnlyNonZero || (OnlyNonZero = {}));

package/dist/modules/stock-lookup/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./mappings";
+export * from "./stock-lookup.module";
+export * from "./types";

package/dist/modules/stock-lookup/index.js

@@ -0,0 +1,3 @@
+export * from "./mappings";
+export * from "./stock-lookup.module";
+export * from "./types";

package/dist/modules/stock-lookup/mappings/index.d.ts

@@ -0,0 +1 @@
+export * from "./stock-lookup.mapper";

package/dist/modules/stock-lookup/mappings/index.js

@@ -0,0 +1 @@
+export * from "./stock-lookup.mapper";

package/dist/modules/stock-lookup/mappings/stock-lookup.mapper.d.ts

@@ -0,0 +1,22 @@
+import { SizeGrid, SizeGridRaw, Stock, StockBarcode, StockBarcodeRaw, StockCategory, StockCategoryRaw, StockColor, StockColorRaw, StockLookupRequestBody, StockLookupRequestParams, StockRaw } from "../types/stock-lookup.interface";
+/**
+ * Map response of SizeGridLookup API call from Harmony into internal SizeGrid interface
+ *
+ * @export
+ * @param {SizeGridRaw} src response in raw format from Harmony API
+ * @returns {SizeGrid} SizeGrid object which follows internal naming conventions
+ */
+export declare function mapSizeGrid(src: SizeGridRaw): SizeGrid;
+export declare function mapStockColor(src: StockColorRaw): StockColor;
+export declare function mapStockClassification(src: StockColorRaw): StockColor;
+export declare function mapStockBarcode(src: StockBarcodeRaw): StockBarcode;
+export declare function mapStockCategory(src: StockCategoryRaw): StockCategory;
+export declare function mapStock(src: StockRaw): Stock;
+/**
+ * Map request params for stock lookup to SOAP request body
+ *
+ * @export
+ * @param {StockLookupRequestParams} src request parameters from the SDK API
+ * @returns {StockLookupRequestBody}	SOAP request body object for Harmony SOAP API
+ */
+export declare function mapStockLookupRequestParams(src: StockLookupRequestParams): StockLookupRequestBody;