@dotdev/harmony-sdk 1.0.6

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

@@ -0,0 +1,419 @@
+import axios from "axios";
+import { ApiHelper } from "../../helpers";
+import { StockLookupModule } from "./stock-lookup.module";
+import { StockSearchType, } from "./types/stock-lookup.interface";
+jest.mock("axios");
+const mAxios = axios;
+const sessionId = ""; // process.env.SESSION_ID as string;
+const stockLookupModule = new StockLookupModule(mAxios);
+describe("SizeGridLookup", () => {
+    test("sizeGridLookup", async () => {
+        const mockedResponse = {
+            data: `
+				<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+						<S:Body>
+								<ns2:SizeGridLookupResponse xmlns:ns2="http://stk.ws.fbsaust.com.au">
+										<SizeGrid>
+												<namekey>01</namekey>
+												<description_1>XS-S to 4XL</description_1>
+												<description_2></description_2>
+												<size_1>XS-S</size_1>
+												<size_2>S-M</size_2>
+												<size_3>M-L</size_3>
+												<size_4>LX-L</size_4>
+												<size_5>XXS</size_5>
+												<size_6>XS</size_6>
+												<size_7>S</size_7>
+												<size_8>M</size_8>
+												<size_9>L</size_9>
+												<size_10>XL</size_10>
+												<size_11>XXL</size_11>
+												<size_12>XXXL</size_12>
+												<size_13>4XL</size_13>
+												<size_14></size_14>
+												<size_15></size_15>
+												<size_16></size_16>
+												<size_17></size_17>
+												<size_18></size_18>
+												<size_19></size_19>
+												<size_20></size_20>
+										</SizeGrid>
+								</ns2:SizeGridLookupResponse>
+						</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const expected = {
+            namekey: "01",
+            description1: "XS-S to 4XL",
+            description2: "",
+            size1: "XS-S",
+            size2: "S-M",
+            size3: "M-L",
+            size4: "LX-L",
+            size5: "XXS",
+            size6: "XS",
+            size7: "S",
+            size8: "M",
+            size9: "L",
+            size10: "XL",
+            size11: "XXL",
+            size12: "XXXL",
+            size13: "4XL",
+            size14: "",
+            size15: "",
+            size16: "",
+            size17: "",
+            size18: "",
+            size19: "",
+            size20: "",
+        };
+        mAxios.post.mockResolvedValueOnce(mockedResponse);
+        const response = await stockLookupModule.sizeGridLookup(sessionId);
+        expect(Array.isArray(response)).toBe(true);
+        expect(response.length).toEqual(1);
+        expect(response[0]).toEqual(expected);
+    });
+});
+describe("StockClassificationLookup", () => {
+    test("stockClassificationLookup", async () => {
+        const mockedResponse = {
+            data: `
+				<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+						<S:Body>
+								<ns2:StockClassificationLookupResponse xmlns:ns2="http://stk.ws.fbsaust.com.au">
+										<StockClassification>
+												<code>BACK</code>
+												<description>BACK PACK</description>
+										</StockClassification>
+										<StockClassification>
+												<code>BASHO</code>
+												<description>BASIC HOODY</description>
+										</StockClassification>
+										 </ns2:StockClassificationLookupResponse>
+						</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const mockedOutput = [
+            { code: "BACK", description: "BACK PACK" },
+            { code: "BASHO", description: "BASIC HOODY" },
+        ];
+        mAxios.post.mockResolvedValueOnce(mockedResponse);
+        const response = await stockLookupModule.stockClassificationLookup(`"${sessionId}"`);
+        expect(Array.isArray(response)).toEqual(true);
+        expect(response.length).toEqual(2);
+        expect(response[0]).toHaveProperty("code");
+        expect(response[0]).toHaveProperty("description");
+        expect(response).toEqual(mockedOutput);
+    });
+});
+describe("StockBarcodeLookup", () => {
+    test("stockBarcodeLookup", async () => {
+        const resp = {
+            data: `<?xml version='1.0' encoding='UTF-8'?>
+			<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+				<S:Body>
+						<ns2:StockBarcodeLookupResponse xmlns:ns2="http://">
+								<SystemTime>29-07-2024 10:51:27</SystemTime>
+								<StockBarcode>
+										<stock>9999999.TEST</stock>
+										<barcode>1234567891234</barcode>
+										<size>10</size>
+										<pack></pack>
+								</StockBarcode>
+						</ns2:StockBarcodeLookupResponse>
+    		</S:Body>
+			</S:Envelope>`,
+        };
+        const mockedOutput = [
+            {
+                stock: "9999999.TEST",
+                barcode: "1234567891234",
+                size: "10",
+                pack: "",
+            },
+        ];
+        const params = {
+            searchType: StockSearchType.BARCODE,
+            searchValue: "1234567891234",
+        };
+        mAxios.post.mockResolvedValueOnce(resp);
+        const response = await stockLookupModule.stockBarcodeLookup(params, `"${sessionId}"`);
+        expect(Array.isArray(response)).toEqual(true);
+        expect(response.length).toEqual(1);
+        expect(response[0]).toHaveProperty("stock");
+        expect(response[0]).toHaveProperty("barcode");
+        expect(response[0]).toHaveProperty("size");
+        expect(response[0]).toHaveProperty("pack");
+        expect(response).toEqual(mockedOutput);
+    });
+    test("stockBarcodeLookup check correct method name being sent", async () => {
+        const mockedSendApiRequest = jest.spyOn(ApiHelper, "sendSoapRequest");
+        const resp = {
+            data: `<?xml version='1.0' encoding='UTF-8'?>
+			<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+				<S:Body>
+						<ns2:StockBarcodeLookupResponse xmlns:ns2="http://">
+								<SystemTime>29-07-2024 10:51:27</SystemTime>
+								<StockBarcode>
+										<stock>9999999.TEST</stock>
+										<barcode>1234567891234</barcode>
+										<size>10</size>
+										<pack></pack>
+								</StockBarcode>
+						</ns2:StockBarcodeLookupResponse>
+    		</S:Body>
+			</S:Envelope>`,
+        };
+        mAxios.post.mockResolvedValueOnce(resp);
+        const response = await stockLookupModule.stockBarcodeLookup({
+            searchType: StockSearchType.BARCODE,
+        }, "");
+        const apiBody = mockedSendApiRequest.mock.calls[0][2];
+        expect(apiBody?.includes(`<stk:StockBarcodeLookupRequest>`) &&
+            apiBody?.includes(`</stk:StockBarcodeLookupRequest>`)).toBe(true);
+    });
+    test("stockBarcodeLookup errors", async () => {
+        // requires valid barcode
+        try {
+            const params = {
+                searchType: StockSearchType.BARCODE,
+                searchValue: "123",
+            };
+            await stockLookupModule.stockBarcodeLookup(params, `"${sessionId}"`);
+        }
+        catch (error) {
+            expect(error?.message).toEqual("Barcode search requires a barcode value");
+        }
+        // stock search cannot except only wildcard character
+        try {
+            const params = {
+                searchType: StockSearchType.STOCK,
+                searchValue: "*",
+            };
+            await stockLookupModule.stockBarcodeLookup(params, `"${sessionId}"`);
+        }
+        catch (error) {
+            expect(error?.message).toEqual("Stock search value cannot be '*'");
+        }
+        // stock keyword search cannot except wildcard
+        try {
+            const params = {
+                searchType: StockSearchType.STOCK_KEYWORD,
+                searchValue: "test*",
+            };
+            await stockLookupModule.stockBarcodeLookup(params, `"${sessionId}"`);
+        }
+        catch (error) {
+            expect(error?.message).toEqual("Stock Keyword search does not allow wildcard character (*)");
+        }
+        // stock keyword search cannot except blank search value
+        try {
+            const params = {
+                searchType: StockSearchType.STOCK_KEYWORD,
+                searchValue: "",
+            };
+            await stockLookupModule.stockBarcodeLookup(params, `"${sessionId}"`);
+        }
+        catch (error) {
+            expect(error?.message).toEqual("Stock Keyword search value cannot be empty");
+        }
+    });
+});
+describe("StockColorLookup", () => {
+    test("stockColorLookup base", async () => {
+        const resp = {
+            data: `
+			<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+    		<S:Body>
+        <ns2:StockColorLookupResponse xmlns:ns2="http://stk.ws.fbsaust.com.au">
+            <StockColor>
+                <code>.TEST</code>
+                <description>TEST &amp; THIS</description>
+            </StockColor>
+				</ns2:StockColorLookupResponse>
+				</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const mockedOutput = [
+            {
+                code: ".TEST",
+                description: "TEST & THIS",
+            },
+        ];
+        mAxios.post.mockResolvedValueOnce(resp);
+        const response = await stockLookupModule.stockColorLookup(`"${sessionId}"`);
+        expect(Array.isArray(response)).toEqual(true);
+        expect(response.length).toEqual(1);
+        expect(response[0]).toHaveProperty("code");
+        expect(response[0]).toHaveProperty("description");
+        expect(response).toEqual(mockedOutput);
+    });
+});
+describe("StockCatergoryLookup", () => {
+    test("stockCategoryLookup base", async () => {
+        const resp = {
+            data: `
+			<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+    		<S:Body>
+        <ns2:StockCategoryLookupResponse xmlns:ns2="http://stk.ws.fbsaust.com.au">
+            <StockCategory>
+                <code>123</code>
+                <description_1>ONE TWO THREE</description_1>
+                <description_2>! @ #</description_2>
+            </StockCategory>
+				</ns2:StockCategoryLookupResponse>
+				</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const mockedOutput = [
+            {
+                code: "123",
+                description1: "ONE TWO THREE",
+                description2: "! @ #",
+            },
+        ];
+        mAxios.post.mockResolvedValueOnce(resp);
+        const response = await stockLookupModule.stockCategoryLookup(`"${sessionId}"`);
+        expect(Array.isArray(response)).toEqual(true);
+        expect(response.length).toEqual(1);
+        expect(response[0]).toHaveProperty("code");
+        expect(response[0]).toHaveProperty("description1");
+        expect(response[0]).toHaveProperty("description2");
+        expect(response).toEqual(mockedOutput);
+    });
+});
+describe("StockLookup", () => {
+    const params = {
+        searchType: StockSearchType.STOCK_KEYWORD,
+        searchValue: "test*",
+    };
+    test("stockLookup base test", async () => {
+        const resp = {
+            data: `
+			<?xml version='1.0' encoding='UTF-8'?>
+				<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+						<S:Body>
+								<ns2:StockLookupResponse xmlns:ns2="http://stk.ws.fbsaust.com.au">
+										<SystemTime>02-02-2022 09:09:09</SystemTime>
+										<Stock>
+												<namekey>6008016.KHAK</namekey>
+												<description_1>TWISTED TEE DRESS</description_1>
+												<description_2></description_2>
+												<category>Z-SL</category>
+												<class_1>DREKN</class_1>
+												<class_2>COREP</class_2>
+												<class_3>05DRE</class_3>
+												<extra_class_1></extra_class_1>
+												<extra_class_2>FEM</extra_class_2>
+												<extra_class_3></extra_class_3>
+												<extra_class_4>02DRE</extra_class_4>
+												<extra_class_5></extra_class_5>
+												<sales_code>@LL</sales_code>
+												<per></per>
+												<color_code>KHAK</color_code>
+												<color_description>KHAKI</color_description>
+												<supplier>AUWUHMYH</supplier>
+												<supplier_reference></supplier_reference>
+												<barcode></barcode>
+												<weight>0.21000000000000002</weight>
+												<volume>0.0</volume>
+												<tax_category>1</tax_category>
+												<qdp>0</qdp>
+												<pdp>2</pdp>
+												<packs_per_carton>1</packs_per_carton>
+												<singles_per_pack>1</singles_per_pack>
+												<carton_per_item>0</carton_per_item>
+												<units_per_single>0</units_per_single>
+												<units_per_box>0.0</units_per_box>
+												<sales_price_1>59.95</sales_price_1>
+												<sales_price_2>0.0</sales_price_2>
+												<sales_price_3>26.75</sales_price_3>
+												<sales_price_4>59.95</sales_price_4>
+												<sales_price_5>20.0</sales_price_5>
+												<sales_price_6>69.95</sales_price_6>
+												<sales_price_7>0.0</sales_price_7>
+												<sales_price_8>28.75</sales_price_8>
+												<sales_price_9>69.95</sales_price_9>
+												<sales_price_10>30.0</sales_price_10>
+												<sales_price_11>20.0</sales_price_11>
+												<sales_price_12>30.0</sales_price_12>
+												<sell_start_date></sell_start_date>
+												<sell_end_date></sell_end_date>
+												<deliver_from_date></deliver_from_date>
+												<iso_country_of_origin></iso_country_of_origin>
+												<size>6</size>
+												<pack></pack>
+										</Stock>
+								</ns2:StockLookupResponse>
+						</S:Body>
+				</S:Envelope>
+			`,
+        };
+        const mockedOutput = [
+            {
+                namekey: "6008016.KHAK",
+                description1: "TWISTED TEE DRESS",
+                description2: "",
+                category: "Z-SL",
+                class1: "DREKN",
+                class2: "COREP",
+                class3: "05DRE",
+                extraClass1: "",
+                extraClass2: "FEM",
+                extraClass3: "",
+                extraClass4: "02DRE",
+                extraClass5: "",
+                salesCode: "@LL",
+                per: "",
+                colorCode: "KHAK",
+                colorDescription: "KHAKI",
+                supplier: "AUWUHMYH",
+                supplierReference: "",
+                barcode: "",
+                weight: 0.21000000000000002,
+                volume: 0,
+                taxCategory: 1,
+                qdp: 0,
+                pdp: 2,
+                packsPerCarton: 1,
+                singlesPerPack: 1,
+                cartonPerItem: 0,
+                unitsPerSingle: 0,
+                unitsPerBox: 0,
+                salesPrice1: 59.95,
+                salesPrice2: 0,
+                salesPrice3: 26.75,
+                salesPrice4: 59.95,
+                salesPrice5: 20,
+                salesPrice6: 69.95,
+                salesPrice7: 0,
+                salesPrice8: 28.75,
+                salesPrice9: 69.95,
+                salesPrice10: 30,
+                salesPrice11: 20,
+                salesPrice12: 30,
+                sellStartDate: "",
+                sellEndDate: "",
+                deliverFromDate: "",
+                isoCountryOfOrigin: "",
+                size: "6",
+                pack: "",
+                stockActive: undefined,
+                alternateNamekey: undefined,
+            },
+        ];
+        mAxios.post.mockResolvedValueOnce(resp);
+        const response = await stockLookupModule.stockLookup(params, `"${sessionId}"`);
+        expect(Array.isArray(response)).toEqual(true);
+        expect(response.length).toEqual(1);
+        expect(response).toEqual(mockedOutput);
+    });
+});

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

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

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

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

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

@@ -0,0 +1,242 @@
+import { OptionalStockQueryParams, OptionalStockRequestBody, ParamLimits } from "../../shared/types";
+export declare class StockLookupRequestBody extends OptionalStockRequestBody {
+    SearchType: StockLookupSearchType;
+    SearchValue?: string;
+    Warehouse?: string;
+    Debtor?: string;
+    DateTime?: string;
+    constructor(obj: Partial<StockLookupRequestBody>);
+    toString(): string;
+}
+export type StockLookupSearchType = StockSearchType | StockClassificationType;
+export declare enum StockSearchType {
+    BARCODE = "Barcode",
+    STOCK = "Stock",
+    STOCK_KEYWORD = "StockKeyword"
+}
+export interface StockLookupRequestParams extends OptionalStockQueryParams {
+    searchType: StockLookupSearchType;
+    searchValue?: string;
+    warehouse?: string;
+    debtor?: string;
+    datetime?: string;
+}
+export declare const STOCK_LOOKUP_REQUEST_PARAMS_LIMIT: ParamLimits<StockLookupRequestParams>;
+export interface StockBaseInterfaceRaw {
+    code: string | string[];
+    description: string | string[];
+}
+export interface StockBaseInterface {
+    code: string;
+    description: string;
+}
+export interface SizeGridRaw {
+    namekey: string | string[];
+    description_1: string | string[];
+    description_2: string | string[];
+    size_1: string | string[];
+    size_2: string | string[];
+    size_3: string | string[];
+    size_4: string | string[];
+    size_5: string | string[];
+    size_6: string | string[];
+    size_7: string | string[];
+    size_8: string | string[];
+    size_9: string | string[];
+    size_10: string | string[];
+    size_11: string | string[];
+    size_12: string | string[];
+    size_13: string | string[];
+    size_14: string | string[];
+    size_15: string | string[];
+    size_16: string | string[];
+    size_17: string | string[];
+    size_18: string | string[];
+    size_19: string | string[];
+    size_20: string | string[];
+}
+export interface SizeGrid {
+    namekey: string;
+    description1: string;
+    description2: string;
+    size1: string;
+    size2: string;
+    size3: string;
+    size4: string;
+    size5: string;
+    size6: string;
+    size7: string;
+    size8: string;
+    size9: string;
+    size10: string;
+    size11: string;
+    size12: string;
+    size13: string;
+    size14: string;
+    size15: string;
+    size16: string;
+    size17: string;
+    size18: string;
+    size19: string;
+    size20: string;
+}
+export interface SizeGridResponse {
+    SizeGrid: SizeGridRaw[];
+}
+export interface StockClassification extends StockBaseInterface {
+}
+export interface StockClassificationRaw extends StockBaseInterfaceRaw {
+}
+export interface StockClassificationResponse {
+    StockClassification: StockClassificationRaw[];
+}
+export declare enum StockClassificationType {
+    STK1 = "STK1",
+    STK2 = "STK2",
+    STK3 = "STK3",
+    EXT1 = "EXT1",
+    EXT2 = "EXT2",
+    EXT3 = "EXT3",
+    EXT4 = "EXT4",
+    EXT5 = "EXT5"
+}
+export interface StockBarcodeRaw {
+    stock: string[];
+    barcode: string[];
+    size: string[];
+    pack: string[];
+}
+export interface StockBarcode {
+    stock: string;
+    barcode: string;
+    size: string;
+    pack: string;
+}
+export interface StockBarcodeResponse {
+    StockBarcode: StockBarcodeRaw[];
+}
+export interface StockColor extends StockBaseInterface {
+}
+export interface StockColorRaw extends StockBaseInterfaceRaw {
+}
+export interface StockColorResponse {
+    StockColor: StockColorRaw[];
+}
+export interface StockCategory {
+    code: string;
+    description1: string;
+    description2: string;
+}
+export interface StockCategoryRaw {
+    code: string[];
+    description_1: string[];
+    description_2: string[];
+}
+export interface StockCatergoryResponse {
+    StockCategory: StockCategoryRaw[];
+}
+export interface Stock {
+    namekey: string;
+    description1: string;
+    description2: string;
+    category: string;
+    class1: string;
+    class2: string;
+    class3: string;
+    extraClass1: string;
+    extraClass2: string;
+    extraClass3: string;
+    extraClass4: string;
+    extraClass5: string;
+    salesCode: string;
+    per: string;
+    colorCode: string;
+    colorDescription: string;
+    supplier: string;
+    supplierReference: string;
+    barcode: string;
+    weight: number;
+    volume: number;
+    taxCategory: number;
+    qdp: number;
+    pdp: number;
+    packsPerCarton: number;
+    singlesPerPack: number;
+    cartonPerItem: number;
+    unitsPerSingle: number;
+    unitsPerBox: number;
+    salesPrice1: number;
+    salesPrice2: number;
+    salesPrice3: number;
+    salesPrice4: number;
+    salesPrice5: number;
+    salesPrice6: number;
+    salesPrice7: number;
+    salesPrice8: number;
+    salesPrice9: number;
+    salesPrice10: number;
+    salesPrice11: number;
+    salesPrice12: number;
+    sellStartDate: string;
+    sellEndDate: string;
+    deliverFromDate: string;
+    isoCountryOfOrigin: string;
+    size?: string;
+    pack?: string;
+    stockActive?: string;
+    alternateNamekey?: string;
+}
+export interface StockRaw {
+    namekey: string[];
+    description_1: string[];
+    description_2: string[];
+    category: string[];
+    class_1: string[];
+    class_2: string[];
+    class_3: string[];
+    extra_class_1: string[];
+    extra_class_2: string[];
+    extra_class_3: string[];
+    extra_class_4: string[];
+    extra_class_5: string[];
+    sales_code: string[];
+    per: string[];
+    color_code: string[];
+    color_description: string[];
+    supplier: string[];
+    supplier_reference: string[];
+    barcode: string[];
+    weight: string[];
+    volume: string[];
+    tax_category: string[];
+    qdp: string[];
+    pdp: string[];
+    packs_per_carton: string[];
+    singles_per_pack: string[];
+    carton_per_item: string[];
+    units_per_single: string[];
+    units_per_box: string[];
+    sales_price_1: string[];
+    sales_price_2: string[];
+    sales_price_3: string[];
+    sales_price_4: string[];
+    sales_price_5: string[];
+    sales_price_6: string[];
+    sales_price_7: string[];
+    sales_price_8: string[];
+    sales_price_9: string[];
+    sales_price_10: string[];
+    sales_price_11: string[];
+    sales_price_12: string[];
+    sell_start_date: string[];
+    sell_end_date: string[];
+    deliver_from_date: string[];
+    iso_country_of_origin: string[];
+    size: string[];
+    pack: string[];
+    stock_active: string[];
+    alternate_namekey: string[];
+}
+export interface StockResponse {
+    Stock: StockRaw[];
+}