@dotdev/harmony-sdk 1.0.1

package/dist/modules/point-of-sale/types/process-sale-order.interface.d.ts

@@ -0,0 +1,67 @@
+import { PosBaseQueryParams, PosQueryDebtor, PosQueryExtra, PosQueryHeader, PosQueryInvoice, PosQueryStock } from ".";
+import { BooleanResponse } from "../../shared";
+export interface ProcessSaleOrderQueryParams extends PosBaseQueryParams {
+    header: ProcessSaleOrderQueryHeader;
+    extra: ProcessSaleOrderQueryExtra;
+    stock: ProcessSaleOrderQueryStock[];
+    debtor: ProcessSaleOrderQueryDebtor[];
+}
+export interface ProcessSaleOrderQueryHeader extends PosQueryHeader {
+    invoiceNo?: string;
+    orderNo: string;
+    fulfillmentWarehouse?: string;
+    cancelLaybyNo?: string;
+    orderLines: number;
+    orderDepositTotal?: number;
+    orderVersion: number;
+    orderDeliveryDate?: string;
+    orderCancelAfterDate?: string;
+    webOrderType?: string;
+}
+export interface ProcessSaleOrderQueryExtra extends PosQueryExtra {
+    /**
+     * Delivery street number and name
+     *
+     * @type {?string}
+     */
+    deliveryAddress1?: string;
+    /**
+     * Additional address identifier like building name
+     *
+     * @type {?string}
+     */
+    deliveryAddress2?: string;
+    /**
+     * Delivery Suburb and State Code ie 2or3 char identifier ie NSW,WA.
+     * For Australia: Suburb + State, separated by space (should be valid and compatible with APOST if dispatch is from Harmony)
+     *
+     * @type {?string}
+     */
+    deliveryAddress3?: string;
+    /**
+     * Delivery country
+     *
+     * @type {?string}
+     */
+    deliveryAddress4?: string;
+    /**
+     * Delivery postcode. For Australia - valid APOST postcode
+     *
+     * @type {?string}
+     */
+    deliveryPostcode?: string;
+    deliveryInstruction1?: string;
+    deliveryInstruction2?: string;
+    carrier?: string;
+}
+export interface ProcessSaleOrderQueryStock extends PosQueryStock {
+    dispatchDate?: string;
+    invoiceQty: number;
+    orderQty: number;
+    depositAmount?: number;
+    exportLineNo?: number;
+    markdownReason?: string;
+    skuBarcode?: string;
+}
+export type ProcessSaleOrderQueryDebtor = PosQueryInvoice & PosQueryDebtor;
+export type ProcessSalesOrderResponse = BooleanResponse;

package/dist/modules/point-of-sale/types/process-sale-order.interface.js

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

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

@@ -0,0 +1 @@
+export * from "./types";

package/dist/modules/shared/index.js

@@ -0,0 +1 @@
+export * from "./types";

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

@@ -0,0 +1,93 @@
+import { StockSearchType } from "../../stock-lookup";
+/**
+ * Generic type containing limit for each property within the type. Use in conjunction with `checkParamLimits` function to check whether
+ * all properties/params provided meet their individual limits.
+ *
+ * @export
+ * @typedef {ParamLimits}
+ * @template T
+ */
+export type ParamLimits<T> = {
+    [K in keyof T]: number | ((val: any) => boolean);
+};
+/**
+ * Enum values corresponding to the alias of services used in the Harmonic API URL
+ * i.e. StockLookupService with alias "stk" has service URL as "http://stk.ws.fbsaust.com.au"
+ *
+ * @export
+ * @enum {number}
+ */
+export declare enum ServiceAlias {
+    STOCK_LOOKUP = "stk",
+    STOCK_LEVEL_LOOKUP = "stklvl",
+    POINT_OF_SALE = "pos",
+    GIFT_VOUCHER = "gv",
+    DIARY = "dry",
+    CARRIER = "discs"
+}
+export interface OptionalStockQueryParams {
+    stockCategoryFr?: string;
+    stockCategoryTo?: string;
+    stockClassFr1?: string;
+    stockClassTo1?: string;
+    stockClassFr2?: string;
+    stockClassTo2?: string;
+    stockClassFr3?: string;
+    stockClassTo3?: string;
+    stockExtraClassFr1?: string;
+    stockExtraClassTo1?: string;
+    stockExtraClassFr2?: string;
+    stockExtraClassTo2?: string;
+    stockExtraClassFr3?: string;
+    stockExtraClassTo3?: string;
+    stockExtraClassFr4?: string;
+    stockExtraClassTo4?: string;
+    stockExtraClassFr5?: string;
+    stockExtraClassTo5?: string;
+    sysModTimeFr?: string;
+    sysModTimeTo?: string;
+    alternateNamekeyFr?: string;
+    alternateNamekeyTo?: string;
+    stockActive?: StockActive[];
+}
+export declare enum StockActive {
+    Y = "Y",
+    I = "I",
+    N = "N",
+    S = "S",
+    O = "O",
+    P = "P"
+}
+export interface CombinedSearchTypeValue {
+    type: StockSearchType;
+    value: string;
+}
+export declare class OptionalStockRequestBody {
+    StockCategoryFr?: string;
+    StockCategoryTo?: string;
+    StockClassFr1?: string;
+    StockClassTo1?: string;
+    StockClassFr2?: string;
+    StockClassTo2?: string;
+    StockClassFr3?: string;
+    StockClassTo3?: string;
+    StockExtraClassFr1?: string;
+    StockExtraClassTo1?: string;
+    StockExtraClassFr2?: string;
+    StockExtraClassTo2?: string;
+    StockExtraClassFr3?: string;
+    StockExtraClassTo3?: string;
+    StockExtraClassFr4?: string;
+    StockExtraClassTo4?: string;
+    StockExtraClassFr5?: string;
+    StockExtraClassTo5?: string;
+    SysModTimeFr?: string;
+    SysModTimeTo?: string;
+    AlternateNamekeyFr?: string;
+    AlternateNamekeyTo?: string;
+    StockActive?: string;
+    constructor(obj: Partial<OptionalStockRequestBody>);
+}
+export interface BooleanResponse {
+    result: boolean[];
+}

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

@@ -0,0 +1,53 @@
+/**
+ * Enum values corresponding to the alias of services used in the Harmonic API URL
+ * i.e. StockLookupService with alias "stk" has service URL as "http://stk.ws.fbsaust.com.au"
+ *
+ * @export
+ * @enum {number}
+ */
+export var ServiceAlias;
+(function (ServiceAlias) {
+    ServiceAlias["STOCK_LOOKUP"] = "stk";
+    ServiceAlias["STOCK_LEVEL_LOOKUP"] = "stklvl";
+    ServiceAlias["POINT_OF_SALE"] = "pos";
+    ServiceAlias["GIFT_VOUCHER"] = "gv";
+    ServiceAlias["DIARY"] = "dry";
+    ServiceAlias["CARRIER"] = "discs";
+})(ServiceAlias || (ServiceAlias = {}));
+export var StockActive;
+(function (StockActive) {
+    StockActive["Y"] = "Y";
+    StockActive["I"] = "I";
+    StockActive["N"] = "N";
+    StockActive["S"] = "S";
+    StockActive["O"] = "O";
+    StockActive["P"] = "P";
+})(StockActive || (StockActive = {}));
+export class OptionalStockRequestBody {
+    StockCategoryFr;
+    StockCategoryTo;
+    StockClassFr1;
+    StockClassTo1;
+    StockClassFr2;
+    StockClassTo2;
+    StockClassFr3;
+    StockClassTo3;
+    StockExtraClassFr1;
+    StockExtraClassTo1;
+    StockExtraClassFr2;
+    StockExtraClassTo2;
+    StockExtraClassFr3;
+    StockExtraClassTo3;
+    StockExtraClassFr4;
+    StockExtraClassTo4;
+    StockExtraClassFr5;
+    StockExtraClassTo5;
+    SysModTimeFr;
+    SysModTimeTo;
+    AlternateNamekeyFr;
+    AlternateNamekeyTo;
+    StockActive;
+    constructor(obj) {
+        Object.assign(this, obj);
+    }
+}

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+import { StockLevel, StockLevelLookupQueryParams, StockLevelLookupRequestBody, StockLevelRaw, Warehouse, WarehouseRaw } from "../types";
+export declare function mapWarehouse(src: WarehouseRaw): Warehouse;
+export declare function mapStockLevel(src: StockLevelRaw): StockLevel;
+export declare function mapStockLevelLookupQueryParams(src: StockLevelLookupQueryParams): StockLevelLookupRequestBody;

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

@@ -0,0 +1,78 @@
+import { Utils } from "../../../helpers";
+import { mapOptionalStockQueryParams } from "../../../helpers/mapper";
+import { OnlyNonZero, QtyType, StockLevelLookupRequestBody, } from "../types";
+export function mapWarehouse(src) {
+    return {
+        namekey: (src?.namekey ?? [])[0],
+        description1: (src?.description_1 ?? [])[0],
+        description2: (src?.description_2 ?? [])[0],
+        class1: (src?.class_1 ?? [])[0],
+        class2: (src?.class_2 ?? [])[0],
+        class3: (src?.class_3 ?? [])[0],
+        class4: (src?.class_4 ?? [])[0],
+        class5: (src?.class_5 ?? [])[0],
+    };
+}
+export function mapStockLevel(src) {
+    return {
+        stock: (src?.stock ?? [])[0],
+        stockType: (src?.stock_type ?? [])[0],
+        pack: (src?.pack ?? [])[0],
+        warehouse: (src?.warehouse ?? [])[0],
+        salesCode: (src?.sales_code ?? [])[0],
+        qtyType: (src?.qty_type ?? [])[0],
+        qdp: Utils.toNumber((src?.qdp ?? [])[0] ?? 0),
+        packQty: Utils.toNumber((src?.pack_qty ?? [])[0] ?? 0),
+        qty: Utils.toNumber((src?.qty ?? [])[0] ?? 0),
+        sizeQty1: Utils.toNumber((src?.size_qty_01 ?? [])[0] ?? 0),
+        sizeQty2: Utils.toNumber((src?.size_qty_02 ?? [])[0] ?? 0),
+        sizeQty3: Utils.toNumber((src?.size_qty_03 ?? [])[0] ?? 0),
+        sizeQty4: Utils.toNumber((src?.size_qty_04 ?? [])[0] ?? 0),
+        sizeQty5: Utils.toNumber((src?.size_qty_05 ?? [])[0] ?? 0),
+        sizeQty6: Utils.toNumber((src?.size_qty_06 ?? [])[0] ?? 0),
+        sizeQty7: Utils.toNumber((src?.size_qty_07 ?? [])[0] ?? 0),
+        sizeQty8: Utils.toNumber((src?.size_qty_08 ?? [])[0] ?? 0),
+        sizeQty9: Utils.toNumber((src?.size_qty_09 ?? [])[0] ?? 0),
+        sizeQty10: Utils.toNumber((src?.size_qty_10 ?? [])[0] ?? 0),
+        sizeQty11: Utils.toNumber((src?.size_qty_11 ?? [])[0] ?? 0),
+        sizeQty12: Utils.toNumber((src?.size_qty_12 ?? [])[0] ?? 0),
+        sizeQty13: Utils.toNumber((src?.size_qty_13 ?? [])[0] ?? 0),
+        sizeQty14: Utils.toNumber((src?.size_qty_14 ?? [])[0] ?? 0),
+        sizeQty15: Utils.toNumber((src?.size_qty_15 ?? [])[0] ?? 0),
+        sizeQty16: Utils.toNumber((src?.size_qty_16 ?? [])[0] ?? 0),
+        sizeQty17: Utils.toNumber((src?.size_qty_17 ?? [])[0] ?? 0),
+        sizeQty18: Utils.toNumber((src?.size_qty_18 ?? [])[0] ?? 0),
+        sizeQty19: Utils.toNumber((src?.size_qty_19 ?? [])[0] ?? 0),
+        sizeQty20: Utils.toNumber((src?.size_qty_20 ?? [])[0] ?? 0),
+    };
+}
+export function mapStockLevelLookupQueryParams(src) {
+    const optional = mapOptionalStockQueryParams(src);
+    return new StockLevelLookupRequestBody({
+        SearchType: `<Type>${src?.searchType?.type ?? ""}</Type><Value>${src?.searchType?.value ?? ""}</Value>`,
+        QtyType: `<Type>${src?.qtyType ?? QtyType.STK}</Type>`,
+        Summarised: src?.summarised,
+        OnlyNonZero: src?.onlyNonZero ?? OnlyNonZero.YES,
+        Warehouse: src?.warehouse ?? "",
+        Warehouse1: src?.warehouse1 ?? "",
+        Warehouse2: src?.warehouse2 ?? "",
+        Warehouse3: src?.warehouse3 ?? "",
+        Warehouse4: src?.warehouse4 ?? "",
+        Warehouse5: src?.warehouse5 ?? "",
+        Warehouse6: src?.warehouse6 ?? "",
+        Warehouse7: src?.warehouse7 ?? "",
+        Warehouse8: src?.warehouse8 ?? "",
+        Warehouse9: src?.warehouse9 ?? "",
+        Warehouse10: src?.warehouse10 ?? "",
+        WarehouseClassFr1: src?.warehouseClassFr1 ?? "",
+        WarehouseClassTo1: src?.warehouseClassTo1 ?? "",
+        WarehouseClassFr2: src?.warehouseClassFr2 ?? "",
+        WarehouseClassTo2: src?.warehouseClassTo2 ?? "",
+        WarehouseClassFr3: src?.warehouseClassFr3 ?? "",
+        WarehouseClassTo3: src?.warehouseClassTo3 ?? "",
+        WarehouseClassFr4: src?.warehouseClassFr4 ?? "",
+        WarehouseClassTo4: src?.warehouseClassTo4 ?? "",
+        WarehouseClassFr5: src?.warehouseClassFr5 ?? "",
+        ...optional,
+    });
+}

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

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

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

@@ -0,0 +1,57 @@
+import { mapWarehouse } from "./stock-level-lookup.mapper";
+describe("StockLevelLookupMapper.mapWarehouse", () => {
+    it("should map warehouse response correctly", () => {
+        const warehouseResponse = {
+            Warehouse: [
+                {
+                    namekey: ["testNamekey"],
+                    description_1: ["testDescription1"],
+                    description_2: ["testDescription2"],
+                    class_1: ["testClass1"],
+                    class_2: ["testClass2"],
+                    class_3: ["testClass3"],
+                    class_4: ["testClass4"],
+                    class_5: ["testClass5"],
+                },
+            ],
+        };
+        const expected = {
+            namekey: "testNamekey",
+            description1: "testDescription1",
+            description2: "testDescription2",
+            class1: "testClass1",
+            class2: "testClass2",
+            class3: "testClass3",
+            class4: "testClass4",
+            class5: "testClass5",
+        };
+        expect(mapWarehouse(warehouseResponse.Warehouse[0])).toEqual(expected);
+    });
+    it("should map warehouse response and return arrrays of same size regardless whether the properties are available or not", () => {
+        const warehouseResponse = {
+            Warehouse: [
+                {
+                    namekey: ["testNamekey"],
+                    description_1: ["testDescription1"],
+                    description_2: undefined,
+                    class_1: ["testClass1"],
+                    class_2: undefined,
+                    class_3: undefined,
+                    class_4: ["testClass4"],
+                    class_5: ["testClass5"],
+                },
+            ],
+        };
+        const expected = {
+            namekey: "testNamekey",
+            description1: "testDescription1",
+            description2: undefined,
+            class1: "testClass1",
+            class2: undefined,
+            class3: undefined,
+            class4: "testClass4",
+            class5: "testClass5",
+        };
+        expect(mapWarehouse(warehouseResponse.Warehouse[0])).toEqual(expected);
+    });
+});

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

@@ -0,0 +1,10 @@
+import { AxiosInstance } from "axios";
+import { StockLevel, StockLevelLookupQueryParams, Warehouse } from "./types";
+export declare class StockLevelLookupModule {
+    private axiosInstance;
+    private readonly SERVICE_URL;
+    constructor(axiosInstance: AxiosInstance);
+    warehouseLookup(sessionId: string): Promise<Warehouse[]>;
+    stockLevelLookup(params: StockLevelLookupQueryParams, sessionId: string): Promise<StockLevel[]>;
+    stockLevelLookupByWarehouseQuickView(params: StockLevelLookupQueryParams, sessionId: string): Promise<StockLevel[]>;
+}

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

@@ -0,0 +1,39 @@
+import { ApiHelper } from "../../helpers";
+import { ServiceAlias } from "../shared/types";
+import { mapStockLevel, mapStockLevelLookupQueryParams, mapWarehouse, } from "./mappings";
+export class StockLevelLookupModule {
+    axiosInstance;
+    SERVICE_URL = "/StockLevelLookupService/StockLevelLookupService";
+    constructor(axiosInstance) {
+        this.axiosInstance = axiosInstance;
+    }
+    async warehouseLookup(sessionId) {
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, `WarehouseLookup`, sessionId, ServiceAlias.STOCK_LEVEL_LOOKUP, this.axiosInstance);
+            return response?.Warehouse?.map(mapWarehouse) ?? [];
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    async stockLevelLookup(params, sessionId) {
+        const body = mapStockLevelLookupQueryParams(params);
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, [`StockLevelLookup`, `Request`], sessionId, ServiceAlias.STOCK_LEVEL_LOOKUP, this.axiosInstance, body.toString());
+            return response?.StockLevel?.map(mapStockLevel) ?? [];
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+    async stockLevelLookupByWarehouseQuickView(params, sessionId) {
+        const body = mapStockLevelLookupQueryParams(params);
+        try {
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, [`StockLevelLookupByWarehouseQuickView`, `Request`], sessionId, ServiceAlias.STOCK_LEVEL_LOOKUP, this.axiosInstance, body.toString());
+            return response?.StockLevel?.map(mapStockLevel) ?? [];
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
+}

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

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