@dotdev/harmony-sdk 1.0.6

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

@@ -0,0 +1,156 @@
+import { checkParamLimits, Utils } from "../../../helpers";
+import { STOCK_LOOKUP_REQUEST_PARAMS_LIMIT, StockLookupRequestBody, } 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 function mapSizeGrid(src) {
+    return {
+        namekey: (src?.namekey ?? [])[0],
+        description1: (src?.description_1 ?? [])[0],
+        description2: (src?.description_2 ?? [])[0],
+        size1: (src?.size_1 ?? [])[0],
+        size2: (src?.size_2 ?? [])[0],
+        size3: (src?.size_3 ?? [])[0],
+        size4: (src?.size_4 ?? [])[0],
+        size5: (src?.size_5 ?? [])[0],
+        size6: (src?.size_6 ?? [])[0],
+        size7: (src?.size_7 ?? [])[0],
+        size8: (src?.size_8 ?? [])[0],
+        size9: (src?.size_9 ?? [])[0],
+        size10: (src?.size_10 ?? [])[0],
+        size11: (src?.size_11 ?? [])[0],
+        size12: (src?.size_12 ?? [])[0],
+        size13: (src?.size_13 ?? [])[0],
+        size14: (src?.size_14 ?? [])[0],
+        size15: (src?.size_15 ?? [])[0],
+        size16: (src?.size_16 ?? [])[0],
+        size17: (src?.size_17 ?? [])[0],
+        size18: (src?.size_18 ?? [])[0],
+        size19: (src?.size_19 ?? [])[0],
+        size20: (src?.size_20 ?? [])[0],
+    };
+}
+export function mapStockColor(src) {
+    return mapStockBaseInterface(src);
+}
+export function mapStockClassification(src) {
+    return mapStockBaseInterface(src);
+}
+export function mapStockBarcode(src) {
+    return {
+        stock: (src?.stock ?? [])[0],
+        barcode: (src?.barcode ?? [])[0],
+        size: (src?.size ?? [])[0],
+        pack: (src?.pack ?? [])[0],
+    };
+}
+export function mapStockCategory(src) {
+    return {
+        code: (src?.code ?? [])[0],
+        description1: (src?.description_1 ?? [])[0],
+        description2: (src?.description_2 ?? [])[0],
+    };
+}
+export function mapStock(src) {
+    return {
+        namekey: (src?.namekey ?? [])[0],
+        description1: (src?.description_1 ?? [])[0],
+        description2: (src?.description_2 ?? [])[0],
+        category: (src?.category ?? [])[0],
+        class1: (src?.class_1 ?? [])[0],
+        class2: (src?.class_2 ?? [])[0],
+        class3: (src?.class_3 ?? [])[0],
+        extraClass1: (src?.extra_class_1 ?? [])[0],
+        extraClass2: (src?.extra_class_2 ?? [])[0],
+        extraClass3: (src?.extra_class_3 ?? [])[0],
+        extraClass4: (src?.extra_class_4 ?? [])[0],
+        extraClass5: (src?.extra_class_5 ?? [])[0],
+        salesCode: (src?.sales_code ?? [])[0],
+        per: (src?.per ?? [])[0],
+        colorCode: (src?.color_code ?? [])[0],
+        colorDescription: (src?.color_description ?? [])[0],
+        supplier: (src?.supplier ?? [])[0],
+        supplierReference: (src?.supplier_reference ?? [])[0],
+        barcode: (src?.barcode ?? [])[0],
+        weight: Utils.toNumber((src?.weight ?? [])[0]),
+        volume: Utils.toNumber((src?.volume ?? [])[0]),
+        taxCategory: Utils.toNumber((src?.tax_category ?? [])[0]),
+        qdp: Utils.toNumber((src?.qdp ?? [])[0]),
+        pdp: Utils.toNumber((src?.pdp ?? [])[0]),
+        packsPerCarton: Utils.toNumber((src?.packs_per_carton ?? [])[0]),
+        singlesPerPack: Utils.toNumber((src?.singles_per_pack ?? [])[0]),
+        cartonPerItem: Utils.toNumber((src?.carton_per_item ?? [])[0]),
+        unitsPerSingle: Utils.toNumber((src?.units_per_single ?? [])[0]),
+        unitsPerBox: Utils.toNumber((src?.units_per_box ?? [])[0]),
+        salesPrice1: Utils.toNumber((src?.sales_price_1 ?? [])[0]),
+        salesPrice2: Utils.toNumber((src?.sales_price_2 ?? [])[0]),
+        salesPrice3: Utils.toNumber((src?.sales_price_3 ?? [])[0]),
+        salesPrice4: Utils.toNumber((src?.sales_price_4 ?? [])[0]),
+        salesPrice5: Utils.toNumber((src?.sales_price_5 ?? [])[0]),
+        salesPrice6: Utils.toNumber((src?.sales_price_6 ?? [])[0]),
+        salesPrice7: Utils.toNumber((src?.sales_price_7 ?? [])[0]),
+        salesPrice8: Utils.toNumber((src?.sales_price_8 ?? [])[0]),
+        salesPrice9: Utils.toNumber((src?.sales_price_9 ?? [])[0]),
+        salesPrice10: Utils.toNumber((src?.sales_price_10 ?? [])[0]),
+        salesPrice11: Utils.toNumber((src?.sales_price_11 ?? [])[0]),
+        salesPrice12: Utils.toNumber((src?.sales_price_12 ?? [])[0]),
+        sellStartDate: (src?.sell_start_date ?? [])[0],
+        sellEndDate: (src?.sell_end_date ?? [])[0],
+        deliverFromDate: (src?.deliver_from_date ?? [])[0],
+        isoCountryOfOrigin: (src?.iso_country_of_origin ?? [])[0],
+        stockActive: (src?.stock_active ?? [])[0],
+        alternateNamekey: (src?.alternate_namekey ?? [])[0],
+        size: (src?.size ?? [])[0],
+        pack: (src?.pack ?? [])[0],
+    };
+}
+function mapStockBaseInterface(src) {
+    return {
+        code: (src?.code ?? [])[0],
+        description: (src?.description ?? [])[0],
+    };
+}
+/**
+ * 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 function mapStockLookupRequestParams(src) {
+    checkParamLimits(src, STOCK_LOOKUP_REQUEST_PARAMS_LIMIT);
+    return new StockLookupRequestBody({
+        SearchType: src?.searchType,
+        SearchValue: src?.searchValue,
+        StockCategoryFr: src?.stockCategoryFr,
+        StockCategoryTo: src?.stockCategoryTo,
+        StockClassFr1: src?.stockClassFr1,
+        StockClassTo1: src?.stockClassTo1,
+        StockClassFr2: src?.stockClassFr2,
+        StockClassTo2: src?.stockClassTo2,
+        StockClassFr3: src?.stockClassFr3,
+        StockClassTo3: src?.stockClassTo3,
+        StockExtraClassFr1: src?.stockExtraClassFr1,
+        StockExtraClassTo1: src?.stockExtraClassTo1,
+        StockExtraClassFr2: src?.stockExtraClassFr2,
+        StockExtraClassTo2: src?.stockExtraClassTo2,
+        StockExtraClassFr3: src?.stockExtraClassFr3,
+        StockExtraClassTo3: src?.stockExtraClassTo3,
+        StockExtraClassFr4: src?.stockExtraClassFr4,
+        StockExtraClassTo4: src?.stockExtraClassTo4,
+        StockExtraClassFr5: src?.stockExtraClassFr5,
+        StockExtraClassTo5: src?.stockExtraClassTo5,
+        SysModTimeFr: src?.sysModTimeFr,
+        SysModTimeTo: src?.sysModTimeTo,
+        AlternateNamekeyFr: src?.alternateNamekeyFr,
+        AlternateNamekeyTo: src?.alternateNamekeyTo,
+        StockActive: (src?.stockActive ?? []).join(""),
+        Warehouse: src?.warehouse,
+        Debtor: src?.debtor,
+        DateTime: src?.datetime,
+    });
+}

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

@@ -0,0 +1 @@
+export {};

package/dist/modules/stock-lookup/mappings/stock-lookup.mapper.spec.js

@@ -0,0 +1,92 @@
+import { StockActive } from "../../shared/types";
+import { StockClassificationType, StockSearchType, } from "../types";
+import { mapStockLookupRequestParams } from "./stock-lookup.mapper";
+describe("stockLookup mappers", () => {
+    test("mapStockLookupRequestParams all params", () => {
+        const src = {
+            searchType: StockClassificationType.EXT1,
+            searchValue: "123",
+            stockCategoryFr: "1",
+            stockCategoryTo: "2",
+            stockClassFr1: "3",
+            stockClassTo1: "4",
+            stockClassFr2: "5",
+            stockClassTo2: "6",
+            stockClassFr3: "7",
+            stockClassTo3: "8",
+            stockExtraClassFr1: "9",
+            stockExtraClassTo1: "10",
+            stockExtraClassFr2: "11",
+            stockExtraClassTo2: "12",
+            stockExtraClassFr3: "13",
+            stockExtraClassTo3: "14",
+            stockExtraClassFr4: "15",
+            stockExtraClassTo4: "16",
+            stockExtraClassFr5: "17",
+            stockExtraClassTo5: "18",
+            sysModTimeFr: "2022-01-01",
+            sysModTimeTo: "2022-01-05",
+            alternateNamekeyFr: "2022-01-02",
+            alternateNamekeyTo: "2022-01-03",
+            stockActive: [StockActive.Y],
+            warehouse: "W1",
+            debtor: "D1",
+            datetime: "2022-01-04",
+        };
+        const expected = {
+            SearchType: StockClassificationType.EXT1,
+            SearchValue: "123",
+            StockCategoryFr: "1",
+            StockCategoryTo: "2",
+            StockClassFr1: "3",
+            StockClassTo1: "4",
+            StockClassFr2: "5",
+            StockClassTo2: "6",
+            StockClassFr3: "7",
+            StockClassTo3: "8",
+            StockExtraClassFr1: "9",
+            StockExtraClassTo1: "10",
+            StockExtraClassFr2: "11",
+            StockExtraClassTo2: "12",
+            StockExtraClassFr3: "13",
+            StockExtraClassTo3: "14",
+            StockExtraClassFr4: "15",
+            StockExtraClassTo4: "16",
+            StockExtraClassFr5: "17",
+            StockExtraClassTo5: "18",
+            SysModTimeFr: "2022-01-01",
+            SysModTimeTo: "2022-01-05",
+            AlternateNamekeyFr: "2022-01-02",
+            AlternateNamekeyTo: "2022-01-03",
+            StockActive: "Y",
+            Warehouse: "W1",
+            Debtor: "D1",
+            DateTime: "2022-01-04",
+        };
+        const mapped = mapStockLookupRequestParams(src);
+        expect(mapped).toEqual(expected);
+    });
+    test("mapStockLookupRequestParams required params", () => {
+        const src = {
+            searchType: StockClassificationType.EXT1,
+        };
+        const expected = {
+            SearchType: StockClassificationType.EXT1,
+        };
+        const mapped = mapStockLookupRequestParams(src);
+        expect(mapped.SearchType).toEqual(expected.SearchType);
+    });
+    test("mapStockLookupRequestParams search type and value", () => {
+        const src = {
+            searchType: StockSearchType.BARCODE,
+            searchValue: "1234567890123",
+        };
+        const expected = {
+            SearchType: StockSearchType.BARCODE,
+            SearchValue: "1234567890123",
+        };
+        const mapped = mapStockLookupRequestParams(src);
+        expect(mapped.SearchType).toEqual(expected.SearchType);
+        expect(mapped.SearchValue).toEqual(expected.SearchValue);
+    });
+});

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

@@ -0,0 +1,65 @@
+import { AxiosInstance } from "axios";
+import { SizeGrid, Stock, StockBarcode, StockCategory, StockClassification, StockClassificationType, StockColor, StockLookupRequestParams } from "./types/stock-lookup.interface";
+/**
+ * Module containing all methods to call endpoints belonging to the StockLookup service in Harmony API
+ *
+ * @export
+ * @class StockLookupModule
+ * @typedef {StockLookupModule}
+ */
+export declare class StockLookupModule {
+    private axiosInstance;
+    private readonly SERVICE_URL;
+    constructor(axiosInstance: AxiosInstance);
+    /**
+     * Function to call the sizeGridLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<SizeGrid[]>} Array of size grid response objects which correspond to Harmony API response
+     */
+    sizeGridLookup(sessionId: string): Promise<SizeGrid[]>;
+    /**
+     * Function to call the stockClassificationLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @param {*} [scType=StockClassificationType.STK1] Stock classification type (default is "STK1")
+     * @returns {Promise<StockClassification[]>} Array of stock classification response objects which correspond to Harmony API response
+     */
+    stockClassificationLookup(sessionId: string, scType?: StockClassificationType): Promise<StockClassification[]>;
+    /**
+     * Function to call the stockBarcodeLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @param {StockLookupRequestParams} params object containing search parameters
+     * @returns {Promise<StockBarcode[]>} Array of stock barcode response objects which correspond to Harmony API response
+     */
+    stockBarcodeLookup(params: StockLookupRequestParams, sessionId: string): Promise<StockBarcode[]>;
+    /**
+     * Function to call the StockColorLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<StockColor[]>} Array of stock classification response objects which correspond to Harmony API response
+     */
+    stockColorLookup(sessionId: string): Promise<StockColor[]>;
+    /**
+     * Function to call the StockCateogryLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<StockCategory[]>} Array of stock category response objects which correspond to Harmony API response
+     */
+    stockCategoryLookup(sessionId: string): Promise<StockCategory[]>;
+    /**
+     * Function to call the StockLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {StockLookupRequestParams} params object containing search parameters to be used in the SOAP request sent to Harmony API
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<Stock[]>} Array of stock response objects which correspond to Harmony API response
+     */
+    stockLookup(params: StockLookupRequestParams, sessionId: string): Promise<Stock[]>;
+}

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

@@ -0,0 +1,141 @@
+import { ApiHelper, Utils } from "../../helpers";
+import { ServiceAlias } from "../shared/types";
+import { mapSizeGrid, mapStock, mapStockBarcode, mapStockCategory, mapStockClassification, mapStockColor, mapStockLookupRequestParams, } from "./mappings/stock-lookup.mapper";
+import { StockClassificationType, StockLookupRequestBody, StockSearchType, } from "./types/stock-lookup.interface";
+/**
+ * Module containing all methods to call endpoints belonging to the StockLookup service in Harmony API
+ *
+ * @export
+ * @class StockLookupModule
+ * @typedef {StockLookupModule}
+ */
+export class StockLookupModule {
+    axiosInstance;
+    SERVICE_URL = "/StockLookupService/StockLookupService";
+    constructor(axiosInstance) {
+        this.axiosInstance = axiosInstance;
+    }
+    /**
+     * Function to call the sizeGridLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<SizeGrid[]>} Array of size grid response objects which correspond to Harmony API response
+     */
+    async sizeGridLookup(sessionId) {
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, `SizeGridLookup`, sessionId, ServiceAlias.STOCK_LOOKUP, this.axiosInstance);
+            return response?.SizeGrid?.map(mapSizeGrid);
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    /**
+     * Function to call the stockClassificationLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @param {*} [scType=StockClassificationType.STK1] Stock classification type (default is "STK1")
+     * @returns {Promise<StockClassification[]>} Array of stock classification response objects which correspond to Harmony API response
+     */
+    async stockClassificationLookup(sessionId, scType = StockClassificationType.STK1) {
+        const body = new StockLookupRequestBody({ SearchType: scType });
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, `StockClassificationLookup`, sessionId, ServiceAlias.STOCK_LOOKUP, this.axiosInstance, body.toString());
+            return response?.StockClassification?.map(mapStockClassification);
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    /**
+     * Function to call the stockBarcodeLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @param {StockLookupRequestParams} params object containing search parameters
+     * @returns {Promise<StockBarcode[]>} Array of stock barcode response objects which correspond to Harmony API response
+     */
+    async stockBarcodeLookup(params, sessionId) {
+        const body = mapStockLookupRequestParams(params);
+        const { SearchType, SearchValue } = body;
+        // Logic for the search value based on stock barcode type
+        switch (SearchType) {
+            case StockSearchType.BARCODE:
+                if (Utils.nonEmptyString(SearchValue) && SearchValue?.length != 13) {
+                    throw new Error("Barcode search requires a barcode value");
+                }
+                break;
+            case StockSearchType.STOCK:
+                if (Utils.nonEmptyString(SearchValue) && SearchValue?.trim() === "*") {
+                    throw new Error("Stock search value cannot be '*'");
+                }
+                break;
+            case StockSearchType.STOCK_KEYWORD:
+                if (Utils.nonEmptyString(SearchValue) && SearchValue?.includes("*")) {
+                    throw new Error("Stock Keyword search does not allow wildcard character (*)");
+                }
+                if (Utils.isEmptyString(SearchValue)) {
+                    throw new Error("Stock Keyword search value cannot be empty");
+                }
+        }
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, [`StockBarcodeLookup`, `Request`], sessionId, ServiceAlias.STOCK_LOOKUP, this.axiosInstance, body.toString());
+            return response?.StockBarcode?.map(mapStockBarcode);
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    /**
+     * Function to call the StockColorLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<StockColor[]>} Array of stock classification response objects which correspond to Harmony API response
+     */
+    async stockColorLookup(sessionId) {
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, `StockColorLookup`, sessionId, ServiceAlias.STOCK_LOOKUP, this.axiosInstance);
+            return response?.StockColor?.map(mapStockColor);
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    /**
+     * Function to call the StockCateogryLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<StockCategory[]>} Array of stock category response objects which correspond to Harmony API response
+     */
+    async stockCategoryLookup(sessionId) {
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, `StockCategoryLookup`, sessionId, ServiceAlias.STOCK_LOOKUP, this.axiosInstance);
+            return response?.StockCategory?.map(mapStockCategory);
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    /**
+     * Function to call the StockLookup endpoint in Harmony API
+     *
+     * @async
+     * @param {StockLookupRequestParams} params object containing search parameters to be used in the SOAP request sent to Harmony API
+     * @param {string} sessionId session ID for authentication
+     * @returns {Promise<Stock[]>} Array of stock response objects which correspond to Harmony API response
+     */
+    async stockLookup(params, sessionId) {
+        const body = mapStockLookupRequestParams(params);
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, [`StockLookup`, `Request`], sessionId, ServiceAlias.STOCK_LOOKUP, this.axiosInstance, body.toString());
+            return response?.Stock?.map(mapStock);
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+}

package/dist/modules/stock-lookup/stock-lookup.module.spec.d.ts

@@ -0,0 +1 @@
+export {};