@dotdev/harmony-sdk 1.10.6 → 1.12.0

package/dist/HarmonyAPI.d.ts

@@ -1,5 +1,5 @@
 import { IAxiosRetryConfig } from "axios-retry";
-import { AuthenticationToken, Carrier, CarrierShipment, CreateDiaryQueryParams, Diary, GetCarrierShipmentByTimeQueryParams, GetDiaryQueryParams, ProcessSaleOrderQueryParams, ProcessSaleOrderWithoutPaymentQueryParams, SizeGrid, Stock, StockBarcode, StockCategory, StockClassification, StockClassificationType, StockColor, StockLevel, StockLevelLookupQueryParams, StockLookupRequestParams, Warehouse } from "./modules";
+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 { GiftVoucher, GiftVoucherLookupQueryParams, GiftVoucherReservationQueryParams, GiftVoucherUsedQueryParams, GiftVoucherVerificationKeyQueryParams } from "./modules/gift-voucher/types";
 export declare class HarmonyAPI {
     private baseUrl;
@@ -25,6 +25,7 @@ export declare class HarmonyAPI {
     processSalesOrder(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<boolean>;
     processSalesOrderWithoutPayment(params: ProcessSaleOrderWithoutPaymentQueryParams, sessionId: string): Promise<boolean>;
     mapOrderPayloadToXml(params: Partial<ProcessSaleOrderQueryParams>, sessionId: string): Promise<string>;
+    processInvoice(params: ProcessInvoiceQueryParams, sessionId: string): Promise<boolean>;
     processReturns(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<boolean>;
     modifyExistingSalesOrder(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<boolean>;
     cancelExistingSalesOrder(params: ProcessSaleOrderQueryParams, sessionId: string): Promise<boolean>;

package/dist/HarmonyAPI.js

@@ -86,9 +86,15 @@ export class HarmonyAPI {
     async processSalesOrderWithoutPayment(params, sessionId) {
         return await this.pointOfSaleModule.processSalesOrderWithoutPayment(params, sessionId);
     }
+    // Temporary workaround to return payload to Core
+    // TODO: Update API helper function to return payload with every API call
     async mapOrderPayloadToXml(params, sessionId) {
         return await this.pointOfSaleModule.mapOrderPayloadToXml(params, sessionId);
     }
+    // Post fulfilled orders
+    async processInvoice(params, sessionId) {
+        return await this.pointOfSaleModule.processInvoice(params, sessionId);
+    }
     async processReturns(params, sessionId) {
         return await this.pointOfSaleModule.processReturns(params, sessionId);
     }

package/dist/modules/gift-voucher/index.d.ts

@@ -1 +1,3 @@
 export * from "./gift-voucher.module";
+export * from './mappings';
+export * from './types';

package/dist/modules/gift-voucher/index.js

@@ -1 +1,3 @@
 export * from "./gift-voucher.module";
+export * from './mappings';
+export * from './types';

package/dist/modules/point-of-sale/mappings/process-sale-order.mapper.d.ts

@@ -1,5 +1,6 @@
-import { ProcessSaleOrderQueryDebtor, ProcessSaleOrderQueryExtra, ProcessSaleOrderQueryHeader, ProcessSaleOrderQueryParams, ProcessSaleOrderQueryStock, ProcessSaleOrderWithoutPaymentQueryParams } from "../types";
+import { ProcessInvoiceQueryParams, ProcessSaleOrderQueryDebtor, ProcessSaleOrderQueryExtra, ProcessSaleOrderQueryHeader, ProcessSaleOrderQueryParams, ProcessSaleOrderQueryStock, ProcessSaleOrderWithoutPaymentQueryParams } from "../types";
 export declare function mapProcessSaleOrderQueryParams(params: ProcessSaleOrderQueryParams): string;
+export declare function mapProcessInvoiceQueryParams(params: ProcessInvoiceQueryParams): string;
 export declare function mapProcessSaleOrderWithoutPaymentQueryParams(params: ProcessSaleOrderWithoutPaymentQueryParams): string;
 export declare function mapProcessSaleOrderBaseQueryParams(params: ProcessSaleOrderWithoutPaymentQueryParams): {
     mode: import("../types").PosQueryMode | undefined;
@@ -13,3 +14,4 @@ export declare function mapProcessSaleOrderQueryHeaders(params: ProcessSaleOrder
 export declare function mapProcessSaleOrderQueryExtra(params: ProcessSaleOrderQueryExtra): string;
 export declare function mapProcessSaleOrderQueryStock(params: ProcessSaleOrderQueryStock): string;
 export declare function mapProcessSaleOrderQueryDebtor(params: ProcessSaleOrderQueryDebtor): string;
+export declare function mapPosInvoiceQuery(params: ProcessInvoiceQueryParams): string;

package/dist/modules/point-of-sale/mappings/process-sale-order.mapper.js

@@ -7,6 +7,15 @@ export function mapProcessSaleOrderQueryParams(params) {
     };
     return Utils.toXml(Utils.deleteEmptyProps(body));
 }
+export function mapProcessInvoiceQueryParams(params) {
+    // XML body in JSON format, to be converted to XML string
+    const body = {
+        ...mapProcessSaleOrderBaseQueryParams(params),
+        invoice: mapPosInvoiceQuery(params),
+        debtor: mapProcessSaleOrderQueryDebtor((params?.debtor ?? [])[0]),
+    };
+    return Utils.toXml(Utils.deleteEmptyProps(body));
+}
 export function mapProcessSaleOrderWithoutPaymentQueryParams(params) {
     return Utils.toXml(Utils.deleteEmptyProps(mapProcessSaleOrderBaseQueryParams(params)));
 }
@@ -148,3 +157,12 @@ export function mapProcessSaleOrderQueryDebtor(params) {
     };
     return Utils.deleteEmptyProps(body);
 }
+export function mapPosInvoiceQuery(params) {
+    const body = {
+        invoice_price_inc: params?.invoice?.invoicePriceInc,
+        rounding: params?.invoice?.rounding,
+        total_tax: params?.invoice?.totalTax,
+        cash_drawer_id: params?.invoice?.cashDrawerId,
+    };
+    return Utils.deleteEmptyProps(body);
+}

package/dist/modules/point-of-sale/point-of-sale.module.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ProcessSaleOrderQueryParams, ProcessSaleOrderWithoutPaymentQueryParams } from "./types";
+import { ProcessInvoiceQueryParams, ProcessSaleOrderQueryParams, ProcessSaleOrderWithoutPaymentQueryParams } from "./types";
 export declare class PointOfSaleModule {
     private axiosInstance;
     private readonly SERVICE_URL;
@@ -31,6 +31,13 @@ export declare class PointOfSaleModule {
      * @returns {Promise<boolean>}
      */
     processSalesOrderWithoutPayment(params: ProcessSaleOrderWithoutPaymentQueryParams, sessionId: string): Promise<boolean>;
+    /**
+     * Function to call the ProcessInvoice endpoint in Harmony Point Of Sale service
+     * This is used to post orders that are already fulfilled (e.g. POS orders)
+     * @param params query params
+     * @param sessionId authenticated session ID string
+     */
+    processInvoice(params: ProcessInvoiceQueryParams, sessionId: string): Promise<boolean>;
     /**
      * Function to call the ProcessReturns endpoint in Harmony Point Of Sale service
      *

package/dist/modules/point-of-sale/point-of-sale.module.js

@@ -1,6 +1,6 @@
 import { ApiHelper, Utils } from "../../helpers";
 import { ServiceAlias } from "../shared";
-import { mapProcessSaleOrderQueryDebtor, mapProcessSaleOrderQueryExtra, mapProcessSaleOrderQueryHeaders, mapProcessSaleOrderQueryParams, mapProcessSaleOrderQueryStock, mapProcessSaleOrderWithoutPaymentQueryParams, } from "./mappings/process-sale-order.mapper";
+import { mapProcessInvoiceQueryParams, mapProcessSaleOrderQueryDebtor, mapProcessSaleOrderQueryExtra, mapProcessSaleOrderQueryHeaders, mapProcessSaleOrderQueryParams, mapProcessSaleOrderQueryStock, mapProcessSaleOrderWithoutPaymentQueryParams, } from "./mappings/process-sale-order.mapper";
 import { promisify } from "util";
 import { parseString } from "xml2js";
 const parseXml = promisify(parseString);
@@ -93,6 +93,22 @@ export class PointOfSaleModule {
             throw await ApiHelper.parseError(error);
         }
     }
+    /**
+     * Function to call the ProcessInvoice endpoint in Harmony Point Of Sale service
+     * This is used to post orders that are already fulfilled (e.g. POS orders)
+     * @param params query params
+     * @param sessionId authenticated session ID string
+     */
+    async processInvoice(params, sessionId) {
+        try {
+            const requestBody = mapProcessInvoiceQueryParams(params);
+            const response = await ApiHelper.sendServiceRequest(this.SERVICE_URL, ["ProcessInvoice", "Request"], sessionId, ServiceAlias.POINT_OF_SALE, this.axiosInstance, requestBody);
+            return Boolean(response?.result[0] ?? "false");
+        }
+        catch (error) {
+            throw await ApiHelper.parseError(error);
+        }
+    }
     /**
      * Function to call the ProcessReturns endpoint in Harmony Point Of Sale service
      *

package/dist/modules/point-of-sale/point-of-sale.module.spec.js

@@ -363,4 +363,205 @@ describe("PointOfSaleModule", () => {
         expect(Utils.removeEmptySpaces(actualPayload)).toEqual(Utils.removeEmptySpaces(expectedPayload));
         mAxios.post.mockClear();
     });
+    test("ProcessInvoice should process the order correctly and return response", async () => {
+        const token = "test-token";
+        const ns = "S";
+        const expectedPayload = `
+			<${ns}:Envelope xmlns:${ns}="http://schemas.xmlsoap.org/soap/envelope/" xmlns:${ServiceAlias.POINT_OF_SALE}="http://${ServiceAlias.POINT_OF_SALE}.ws.fbsaust.com.au">
+			<${ns}:Header>
+					<${ServiceAlias.POINT_OF_SALE}:SessionId>${token}</${ServiceAlias.POINT_OF_SALE}:SessionId>
+			</${ns}:Header>
+			<${ns}:Body>
+					<${ServiceAlias.POINT_OF_SALE}:ProcessInvoiceRequest>
+						<mode>U</mode>
+						<audit_no>106942</audit_no>
+						<header>
+										<order_no>W00106943</order_no>
+										<customer_order_no>W00106943</customer_order_no>
+										<transaction_date>02-06-2015</transaction_date>
+										<transaction_time_hour>11</transaction_time_hour>
+										<transaction_time_min>52</transaction_time_min>
+										<transaction_time_sec>0</transaction_time_sec>
+										<shop_debtor>ABC</shop_debtor>
+										<diary>0005353</diary>
+										<diary_name_1>AMMY</diary_name_1>
+										<diary_name_2>WHITE</diary_name_2>
+										<warehouse>WEB</warehouse>
+										<agent_zone_1>1111</agent_zone_1>
+										<terminal_id>online</terminal_id>
+										<user>WEB</user>
+										<order_lines>0</order_lines>
+										<order_deposit_total>119.95</order_deposit_total>
+										<order_version>0</order_version>
+										<originator_software>WEB</originator_software>
+										<account_sale_flag>Y</account_sale_flag>
+						</header>
+						<extra>
+										<delivery_address_1>37</delivery_address_1>
+										<delivery_address_2>HOTHAM ST</delivery_address_2>
+										<delivery_address_3>ST KILDA EAST</delivery_address_3>
+										<delivery_address_4>VIC</delivery_address_4>
+										<delivery_postcode>3111</delivery_postcode>
+										<delivery_instruction_1>Enter backdoor</delivery_instruction_1>
+										<delivery_instruction_2>Then frontdoor</delivery_instruction_2>
+										<carrier>APOST</carrier>
+										<email>test@example.com</email>
+										<telephone_home>0444888885</telephone_home>
+										<telephone_mobile>0444888884</telephone_mobile>
+										<telephone_work>0444888883</telephone_work>
+										<billing_surname>DOE</billing_surname>
+										<billing_first_name>JOHN</billing_first_name>
+										<billing_address_1>37</billing_address_1>
+										<billing_address_2>HOTHAM ST</billing_address_2>
+										<billing_address_3>ST KILDA EAST</billing_address_3>
+										<billing_address_4>VIC</billing_address_4>
+										<billing_postcode>3111</billing_postcode>
+										<billing_telephone_home>0444888888</billing_telephone_home>
+										<billing_telephone_mobile>0444888887</billing_telephone_mobile>
+										<billing_telephone_work>0444888886</billing_telephone_work>
+										<customised_info>CUSTOM</customised_info>
+						</extra>
+						<stock>
+										<stock>7281VL.100</stock>
+										<stock_description>3/4 SLV CROSS OVER DRESS W/ TUCKS</stock_description>
+										<size>S</size>
+										<qdp>0</qdp>
+										<pdp>2</pdp>
+										<invoice_qty>0</invoice_qty>
+										<order_qty>1</order_qty>
+										<discount_price>119.95</discount_price>
+										<line_tax>0</line_tax>
+										<discount_rate>30</discount_rate>
+										<discount_reason>210</discount_reason>
+										<current_rrp_inc>149.95</current_rrp_inc>
+						</stock>
+						<invoice>
+							<invoice_price_inc>100.1</invoice_price_inc>
+							<rounding>1.1</rounding>
+							<total_tax>2.1</total_tax>
+							<cash_drawer_id>BIONLINE</cash_drawer_id>
+						</invoice>
+						<debtor>
+										<payment_type>4</payment_type>
+										<payment_amount>119.95</payment_amount>
+										<invoice_price_inc>0</invoice_price_inc>
+										<rounding>0</rounding>
+										<total_tax>0</total_tax>
+										<card_name>PPAL</card_name>
+										<card_no>ABC123</card_no>
+										<card_expiry_month>0</card_expiry_month>
+										<card_expiry_year>0</card_expiry_year>
+										<cash_drawer_id>ABC1</cash_drawer_id>
+										<reservation_history_no>0</reservation_history_no>
+						</debtor>
+					</${ServiceAlias.POINT_OF_SALE}:ProcessInvoiceRequest>
+			</${ns}:Body>
+ </${ns}:Envelope>
+		`;
+        const params = {
+            mode: PosQueryMode.UPDATE,
+            auditNo: "106942",
+            header: {
+                orderNo: "W00106943",
+                customerOrderNo: "W00106943",
+                transactionDate: "02-06-2015",
+                transactionTimeHour: 11,
+                transactionTimeMin: 52,
+                transactionTimeSec: 0,
+                shopDebtor: "ABC",
+                diary: "0005353",
+                diaryName1: "AMMY",
+                diaryName2: "WHITE",
+                warehouse: "WEB",
+                agentZone1: 1111,
+                terminalId: "online",
+                user: "WEB",
+                orderLines: 0,
+                orderDepositTotal: 119.95,
+                orderVersion: 0,
+                originatorSoftware: "WEB",
+                accountSaleFlag: AccountSaleFlag.YES,
+            },
+            stock: [
+                {
+                    stock: "7281VL.100",
+                    stockDescription: "3/4 SLV CROSS OVER DRESS W/ TUCKS",
+                    size: "S",
+                    qdp: 0,
+                    pdp: 2,
+                    invoiceQty: 0.0,
+                    orderQty: 1.0,
+                    discountPrice: 119.95,
+                    lineTax: 0.0,
+                    discountRate: 30.0,
+                    discountReason: "210",
+                    currentRrpInc: 149.95,
+                },
+            ],
+            invoice: {
+                invoicePriceInc: 100.1,
+                rounding: 1.1,
+                totalTax: 2.1,
+                cashDrawerId: 'BIONLINE'
+            },
+            extra: {
+                deliveryAddress1: "37",
+                deliveryAddress2: "HOTHAM ST",
+                deliveryAddress3: "ST KILDA EAST",
+                deliveryAddress4: "VIC",
+                deliveryPostcode: "3111",
+                deliveryInstruction1: "Enter backdoor",
+                deliveryInstruction2: "Then frontdoor",
+                telephoneHome: "0444888885",
+                telephoneMobile: "0444888884",
+                telephoneWork: "0444888883",
+                email: "test@example.com",
+                billingAddress1: "37",
+                billingAddress2: "HOTHAM ST",
+                billingAddress3: "ST KILDA EAST",
+                billingAddress4: "VIC",
+                billingPostcode: "3111",
+                billingFirstname: "JOHN",
+                billingSurname: "DOE",
+                billingTelephoneHome: "0444888888",
+                billingTelephoneMobile: "0444888887",
+                billingTelephoneWork: "0444888886",
+                carrier: "APOST",
+                customisedInfo: "CUSTOM",
+            },
+            debtor: [
+                {
+                    paymentType: PosPaymentType.CARD,
+                    paymentAmount: 119.95,
+                    invoicePriceInc: 0.0,
+                    rounding: 0.0,
+                    totalTax: 0.0,
+                    cardName: CardName.PAYPAL,
+                    cardNo: "ABC123",
+                    cardExpiryMonth: 0,
+                    cardExpiryYear: 0,
+                    cashDrawerId: "ABC1",
+                    reservationHistoryNo: 0,
+                },
+            ],
+        };
+        const mockedResp = `
+		<?xml version='1.0' encoding='UTF-8'?>
+		<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+			<S:Body><ns2:ProcessInvoiceResponse xmlns:ns2="http://pos.ws.fbsaust.com.au">
+					<result>true</result>
+				</ns2:ProcessInvoiceResponse></S:Body>
+		</S:Envelope>
+	`;
+        const expectedResult = true;
+        mAxios.post.mockResolvedValueOnce({ data: mockedResp });
+        const response = await posModule.processInvoice(params, token);
+        // Test that expected response is correct
+        expect(typeof response).toEqual("boolean");
+        expect(response).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.mockClear();
+    });
 });

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

@@ -3,6 +3,9 @@ import { BooleanResponse } from "../../shared";
 export interface ProcessSaleOrderQueryParams extends ProcessSaleOrderWithoutPaymentQueryParams {
     debtor: ProcessSaleOrderQueryDebtor[];
 }
+export interface ProcessInvoiceQueryParams extends ProcessSaleOrderQueryParams {
+    invoice: PosQueryInvoice;
+}
 export interface ProcessSaleOrderWithoutPaymentQueryParams extends PosBaseQueryParams {
     header: ProcessSaleOrderQueryHeader;
     extra: ProcessSaleOrderQueryExtra;
@@ -67,3 +70,4 @@ export interface ProcessSaleOrderQueryStock extends PosQueryStock {
 }
 export type ProcessSaleOrderQueryDebtor = PosQueryInvoice & PosQueryDebtor;
 export type ProcessSalesOrderResponse = BooleanResponse;
+export type ProcessInvoiceResponse = BooleanResponse;

package/package.json

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