@shopfront/bridge 1.16.0 → 1.18.0

package/lib/APIs/Sale/SaleProduct.d.ts

@@ -0,0 +1,129 @@
+import { ShopfrontSaleProduct, ShopfrontSaleProductType } from "./ShopfrontSaleState";
+export declare class SaleProduct {
+    readonly internalId: string;
+    protected id: string;
+    protected quantity: number;
+    protected price?: number;
+    protected indexAddress: Array<number>;
+    protected name?: string;
+    protected type?: ShopfrontSaleProductType;
+    protected taxRateAmount?: number;
+    protected note: string;
+    protected contains: Array<SaleProduct>;
+    protected edited: boolean;
+    protected caseQuantity?: number;
+    protected metaData: Record<string, unknown>;
+    protected mapped?: string;
+    constructor(id: string, quantity: number, price?: number, indexAddress?: Array<number>);
+    /**
+     * Hydrate a sale product from the SaleState.
+     *
+     * @internal
+     * @param {ShopfrontSaleProduct} product
+     * @param {Array<number>} indexAddress
+     * @returns {SaleProduct}
+     * @constructor
+     */
+    static HydrateFromState(product: ShopfrontSaleProduct, indexAddress: Array<number>): SaleProduct;
+    /**
+     * Append a product to this product's list of contained products.
+     *
+     * @protected
+     * @param {SaleProduct} product
+     */
+    protected appendProduct(product: SaleProduct): void;
+    /**
+     * Set the internal data for the product.
+     * This method is for hydration of the product from Shopfront, it's highly recommend that you DO NOT use this method.
+     *
+     * @internal
+     * @param {ShopfrontSaleProduct} data
+     * @param {Array<number>} indexAddress
+     */
+    setInternal(data: ShopfrontSaleProduct, indexAddress: Array<number>): void;
+    /**
+     * Get the ID of the product.
+     * @returns {string}
+     */
+    getId(): string;
+    /**
+     * Gets the mapped id for the product.
+     * Used when the product goes through the fulfilment process mapping
+     * @returns {string | undefined}
+     */
+    getMapped(): string | undefined;
+    /**
+     * Get the current sale quantity of the product.
+     * @returns {number}
+     */
+    getQuantity(): number;
+    /**
+     * Get the current price of the product.
+     * @returns {number | undefined}
+     */
+    getPrice(): number | undefined;
+    /**
+     * Get the index address of the product.
+     * This is the internal address of where the product is in the sale.
+     * (e.g. if the address is [1, 3] it's the fourth contained product in the second sale line).
+     *
+     * @returns {Array<number>}
+     */
+    getIndexAddress(): number[];
+    /**
+     * Get the name of the product.
+     *
+     * @returns {string | undefined}
+     */
+    getName(): string | undefined;
+    /**
+     * Get the type of product this product is.
+     *
+     * @returns {ShopfrontSaleProductType | undefined}
+     */
+    getType(): ShopfrontSaleProductType | undefined;
+    /**
+     * Get the tax rate amount.
+     * This is the rate of the tax rate (e.g. 10 is a tax rate of 10%).
+     *
+     * @returns {number | undefined}
+     */
+    getTaxRateAmount(): number | undefined;
+    /**
+     * Get the sale note attached to this product.
+     *
+     * @returns {string}
+     */
+    getNote(): string;
+    /**
+     * Get the products this product contains.
+     *
+     * @returns {Array<SaleProduct>}
+     */
+    getContains(): SaleProduct[];
+    /**
+     * Get whether this product has been "edited".
+     * Typically, being edited just means that this product has been discounted.
+     *
+     * @returns {boolean}
+     */
+    getEdited(): boolean;
+    /**
+     * Get the case quantity for this product.
+     *
+     * @returns {number | undefined}
+     */
+    getCaseQuantity(): number | undefined;
+    /**
+     * Get the meta data for the product.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData(): Record<string, unknown>;
+    /**
+     * Set the metaData for a product
+     * @param key
+     * @param value
+     */
+    setMetaData(key: string, value: unknown): void;
+}

package/lib/APIs/Sale/SaleProduct.js

@@ -0,0 +1,181 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaleProduct = void 0;
+const UUID_1 = __importDefault(require("../../Utilities/UUID"));
+class SaleProduct {
+    constructor(id, quantity, price, indexAddress) {
+        this.metaData = {};
+        this.internalId = UUID_1.default.generate();
+        this.id = id;
+        this.quantity = quantity;
+        this.price = price;
+        this.indexAddress = indexAddress || [];
+        this.contains = [];
+        this.edited = typeof price !== "undefined";
+        this.note = "";
+    }
+    /**
+     * Hydrate a sale product from the SaleState.
+     *
+     * @internal
+     * @param {ShopfrontSaleProduct} product
+     * @param {Array<number>} indexAddress
+     * @returns {SaleProduct}
+     * @constructor
+     */
+    static HydrateFromState(product, indexAddress) {
+        const hydrated = new SaleProduct(product.uuid, product.quantity, product.prices.price, indexAddress);
+        hydrated.setInternal(product, indexAddress);
+        return hydrated;
+    }
+    /**
+     * Append a product to this product's list of contained products.
+     *
+     * @protected
+     * @param {SaleProduct} product
+     */
+    appendProduct(product) {
+        this.contains.push(product);
+    }
+    /**
+     * Set the internal data for the product.
+     * This method is for hydration of the product from Shopfront, it's highly recommend that you DO NOT use this method.
+     *
+     * @internal
+     * @param {ShopfrontSaleProduct} data
+     * @param {Array<number>} indexAddress
+     */
+    setInternal(data, indexAddress) {
+        this.name = data.name;
+        this.type = data.type;
+        this.taxRateAmount = data.tax?.amount || 0;
+        this.note = data.note;
+        this.edited = data.edited;
+        this.caseQuantity = data.caseQuantity;
+        this.metaData = data.metaData;
+        this.mapped = data.mapped;
+        for (let i = 0, l = data.products.length; i < l; i++) {
+            this.appendProduct(SaleProduct.HydrateFromState(data.products[i], [
+                ...indexAddress,
+                i,
+            ]));
+        }
+    }
+    /**
+     * Get the ID of the product.
+     * @returns {string}
+     */
+    getId() {
+        return this.id;
+    }
+    /**
+     * Gets the mapped id for the product.
+     * Used when the product goes through the fulfilment process mapping
+     * @returns {string | undefined}
+     */
+    getMapped() {
+        return this.mapped;
+    }
+    /**
+     * Get the current sale quantity of the product.
+     * @returns {number}
+     */
+    getQuantity() {
+        return this.quantity;
+    }
+    /**
+     * Get the current price of the product.
+     * @returns {number | undefined}
+     */
+    getPrice() {
+        return this.price;
+    }
+    /**
+     * Get the index address of the product.
+     * This is the internal address of where the product is in the sale.
+     * (e.g. if the address is [1, 3] it's the fourth contained product in the second sale line).
+     *
+     * @returns {Array<number>}
+     */
+    getIndexAddress() {
+        return this.indexAddress;
+    }
+    /**
+     * Get the name of the product.
+     *
+     * @returns {string | undefined}
+     */
+    getName() {
+        return this.name;
+    }
+    /**
+     * Get the type of product this product is.
+     *
+     * @returns {ShopfrontSaleProductType | undefined}
+     */
+    getType() {
+        return this.type;
+    }
+    /**
+     * Get the tax rate amount.
+     * This is the rate of the tax rate (e.g. 10 is a tax rate of 10%).
+     *
+     * @returns {number | undefined}
+     */
+    getTaxRateAmount() {
+        return this.taxRateAmount;
+    }
+    /**
+     * Get the sale note attached to this product.
+     *
+     * @returns {string}
+     */
+    getNote() {
+        return this.note;
+    }
+    /**
+     * Get the products this product contains.
+     *
+     * @returns {Array<SaleProduct>}
+     */
+    getContains() {
+        return this.contains;
+    }
+    /**
+     * Get whether this product has been "edited".
+     * Typically, being edited just means that this product has been discounted.
+     *
+     * @returns {boolean}
+     */
+    getEdited() {
+        return this.edited;
+    }
+    /**
+     * Get the case quantity for this product.
+     *
+     * @returns {number | undefined}
+     */
+    getCaseQuantity() {
+        return this.caseQuantity;
+    }
+    /**
+     * Get the meta data for the product.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData() {
+        return this.metaData;
+    }
+    /**
+     * Set the metaData for a product
+     * @param key
+     * @param value
+     */
+    setMetaData(key, value) {
+        this.metaData[key] = value;
+    }
+}
+exports.SaleProduct = SaleProduct;

package/lib/APIs/Sale/ShopfrontSaleState.d.ts

@@ -0,0 +1,56 @@
+export declare type ShopfrontSalePaymentStatus = "completed" | "cancelled" | "failed";
+export declare type ShopfrontSaleProductType = "Normal" | "Basket" | "Package" | "Component" | "Voucher";
+export interface ShopfrontSaleProduct {
+    uuid: string;
+    type: ShopfrontSaleProductType;
+    name: string;
+    quantity: number;
+    prices: {
+        price: number;
+        normal: number;
+    };
+    tax: null | {
+        id: string;
+        amount: number;
+    };
+    note: string;
+    products: Array<ShopfrontSaleProduct>;
+    edited: boolean;
+    caseQuantity: number;
+    metaData: Record<string, unknown>;
+    mapped?: string;
+}
+interface ShopfrontSaleCustomer {
+    uuid: string;
+}
+export interface ShopfrontSalePayment {
+    method: string;
+    type: string;
+    status: ShopfrontSalePaymentStatus;
+    amount: number;
+    cashout: number;
+    rounding: number;
+}
+export interface ShopfrontSaleState {
+    clientId?: string;
+    register?: string;
+    products: Array<ShopfrontSaleProduct>;
+    customer: false | ShopfrontSaleCustomer;
+    payments: Array<ShopfrontSalePayment>;
+    notes: {
+        internal: string;
+        sale: string;
+    };
+    totals: {
+        sale: number;
+        paid: number;
+        savings: number;
+        discount: number;
+    };
+    linkedTo: string;
+    orderReference: string;
+    refundReason: string;
+    priceSet: string | null;
+    metaData: Record<string, unknown>;
+}
+export {};

package/lib/APIs/Sale/ShopfrontSaleState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/APIs/Sale/index.d.ts

@@ -0,0 +1,9 @@
+export { SaleData, SalePaymentData, SaleProductData } from "../../Utilities/SaleCreate";
+export { ShopfrontSalePayment, ShopfrontSalePaymentStatus, ShopfrontSaleProduct, ShopfrontSaleProductType, ShopfrontSaleState } from "./ShopfrontSaleState";
+export { BaseSale } from "./BaseSale";
+export { SaleProduct } from "./SaleProduct";
+export { SalePayment } from "./SalePayment";
+export { SalePaymentStatus } from "./SalePayment";
+export { SaleCustomer } from "./SaleCustomer";
+export { Sale } from "./Sale";
+export * as Exceptions from "./Exceptions";

package/lib/APIs/Sale/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Exceptions = exports.Sale = exports.SaleCustomer = exports.SalePaymentStatus = exports.SalePayment = exports.SaleProduct = exports.BaseSale = void 0;
+var BaseSale_1 = require("./BaseSale");
+Object.defineProperty(exports, "BaseSale", { enumerable: true, get: function () { return BaseSale_1.BaseSale; } });
+var SaleProduct_1 = require("./SaleProduct");
+Object.defineProperty(exports, "SaleProduct", { enumerable: true, get: function () { return SaleProduct_1.SaleProduct; } });
+var SalePayment_1 = require("./SalePayment");
+Object.defineProperty(exports, "SalePayment", { enumerable: true, get: function () { return SalePayment_1.SalePayment; } });
+var SalePayment_2 = require("./SalePayment");
+Object.defineProperty(exports, "SalePaymentStatus", { enumerable: true, get: function () { return SalePayment_2.SalePaymentStatus; } });
+var SaleCustomer_1 = require("./SaleCustomer");
+Object.defineProperty(exports, "SaleCustomer", { enumerable: true, get: function () { return SaleCustomer_1.SaleCustomer; } });
+var Sale_1 = require("./Sale");
+Object.defineProperty(exports, "Sale", { enumerable: true, get: function () { return Sale_1.Sale; } });
+exports.Exceptions = __importStar(require("./Exceptions"));

package/lib/Actions/SaleUpdate.d.ts

@@ -1,6 +1,6 @@
 import { BaseAction } from "./BaseAction";
 import { Serialized } from "../Common/Serializable";
-import { ShopfrontSalePaymentStatus } from "../APIs/CurrentSale/ShopfrontSaleState";
+import { ShopfrontSalePaymentStatus } from "../APIs/Sale";
 export interface SaleUpdateChanges {
     PRODUCT_ADD: {
         id: string;

package/lib/Application.d.ts

@@ -2,11 +2,12 @@ import { Bridge } from "./Bridge";
 import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, RegisterChangedEvent, SoundEvents } from "./ApplicationEvents";
 import { Serializable } from "./Common/Serializable";
 import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent";
-import { Sale } from "./APIs/CurrentSale";
-import { ShopfrontSaleState } from "./APIs/CurrentSale/ShopfrontSaleState";
+import { ShopfrontSaleState } from "./APIs/Sale";
 import { Database } from "./APIs/Database/Database";
 import { MaybePromise } from "./Utilities/MiscTypes";
 import { BaseEvent } from "./Events/BaseEvent";
+import { CurrentSale } from "./APIs/Sale/CurrentSale";
+import { Sale } from "./APIs/Sale";
 export interface ShopfrontEmbeddedVerificationToken {
     auth: string;
     id: string;
@@ -60,9 +61,23 @@ export declare class Application {
      * Get the current sale on the sell screen, if the current device is not a register
      * then this will return false.
      *
-     * @returns {Promise<Sale | boolean>}
+     * @returns {Promise<CurrentSale | boolean>}
      */
-    getCurrentSale(): Promise<Sale | false>;
+    getCurrentSale(): Promise<CurrentSale | false>;
+    protected dataIsCreateEvent(data: Record<string, unknown>): data is {
+        requestId: string;
+        success: boolean;
+        message?: string;
+    };
+    /**
+     * Send the sale to be created on shopfront.
+     *
+     * @param sale
+     */
+    createSale(sale: Sale): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
     protected dataIsLocation(data: Record<string, unknown>): data is {
         requestId: string;
         register: string | null;

package/lib/Application.js

@@ -13,7 +13,6 @@ const ActionEventRegistrar_1 = __importDefault(require("./Utilities/ActionEventR
 const RequestTableColumns_1 = require("./Events/RequestTableColumns");
 const RequestSellScreenOptions_1 = require("./Events/RequestSellScreenOptions");
 const BaseEmitableEvent_1 = require("./EmitableEvents/BaseEmitableEvent");
-const CurrentSale_1 = require("./APIs/CurrentSale");
 const InternalPageMessage_1 = require("./Events/InternalPageMessage");
 const RegisterChanged_1 = require("./Events/RegisterChanged");
 const Database_1 = require("./APIs/Database/Database");
@@ -24,6 +23,14 @@ const SaleComplete_1 = require("./Events/SaleComplete");
 const UIPipeline_1 = require("./Events/UIPipeline");
 const PaymentMethodsEnabled_1 = require("./Events/PaymentMethodsEnabled");
 const AudioPermissionChange_1 = require("./Events/AudioPermissionChange");
+const FulfilmentGetOrder_1 = require("./Events/FulfilmentGetOrder");
+const FulfilmentVoidOrder_1 = require("./Events/FulfilmentVoidOrder");
+const FulfilmentProcessOrder_1 = require("./Events/FulfilmentProcessOrder");
+const FulfilmentOrderApproval_1 = require("./Events/FulfilmentOrderApproval");
+const FulfilmentCollectOrder_1 = require("./Events/FulfilmentCollectOrder");
+const FulfilmentCompleteOrder_1 = require("./Events/FulfilmentCompleteOrder");
+const CurrentSale_1 = require("./APIs/Sale/CurrentSale");
+const SaleCreate_1 = require("./Utilities/SaleCreate");
 class ShopfrontTokenDecodingError extends Error {
 }
 exports.ShopfrontTokenDecodingError = ShopfrontTokenDecodingError;
@@ -45,6 +52,12 @@ class Application {
             UI_PIPELINE: new Map(),
             PAYMENT_METHODS_ENABLED: new Map(),
             AUDIO_PERMISSION_CHANGE: new Map(),
+            FULFILMENT_GET_ORDER: new Map(),
+            FULFILMENT_PROCESS_ORDER: new Map(),
+            FULFILMENT_VOID_ORDER: new Map(),
+            FULFILMENT_ORDER_APPROVAL: new Map(),
+            FULFILMENT_ORDER_COLLECTED: new Map(),
+            FULFILMENT_ORDER_COMPLETED: new Map(),
         };
         this.directListeners = {};
         this.handleEvent = (event, data, id) => {
@@ -77,7 +90,8 @@ class Application {
                 event === "RESPONSE_LOCATION" ||
                 event === "RESPONSE_OPTION" ||
                 event === "RESPONSE_AUDIO_REQUEST" ||
-                event === "RESPONSE_SECURE_KEY") {
+                event === "RESPONSE_SECURE_KEY" ||
+                event === "RESPONSE_CREATE_SALE") {
                 // Handled elsewhere
                 return;
             }
@@ -175,6 +189,12 @@ class Application {
                     .then(res => {
                     return PaymentMethodsEnabled_1.PaymentMethodsEnabled.respond(this.bridge, res.flat(), id);
                 });
+            case "FULFILMENT_GET_ORDER":
+                results = results;
+                return Promise.all(results)
+                    .then(res => {
+                    return FulfilmentGetOrder_1.FulfilmentGetOrder.respond(this.bridge, res[0], id);
+                });
         }
     }
     addEventListener(event, callback) {
@@ -247,6 +267,33 @@ class Application {
                 c = new AudioPermissionChange_1.AudioPermissionChange(callback);
                 this.listeners[event].set(callback, c);
                 break;
+            case "FULFILMENT_GET_ORDER":
+                if (this.listeners[event].size !== 0) {
+                    throw new TypeError("Application already has 'FULFILMENT_GET_ORDER' event listener registered.");
+                }
+                c = new FulfilmentGetOrder_1.FulfilmentGetOrder(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "FULFILMENT_VOID_ORDER":
+                c = new FulfilmentVoidOrder_1.FulfilmentVoidOrder(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "FULFILMENT_PROCESS_ORDER":
+                c = new FulfilmentProcessOrder_1.FulfilmentProcessOrder(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "FULFILMENT_ORDER_APPROVAL":
+                c = new FulfilmentOrderApproval_1.FulfilmentOrderApproval(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "FULFILMENT_ORDER_COLLECTED":
+                c = new FulfilmentCollectOrder_1.FulfilmentCollectOrder(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "FULFILMENT_ORDER_COMPLETED":
+                c = new FulfilmentCompleteOrder_1.FulfilmentCompleteOrder(callback);
+                this.listeners[event].set(callback, c);
+                break;
         }
         if (typeof c === "undefined") {
             throw new TypeError(`${event} has not been defined`);
@@ -314,7 +361,7 @@ class Application {
      * Get the current sale on the sell screen, if the current device is not a register
      * then this will return false.
      *
-     * @returns {Promise<Sale | boolean>}
+     * @returns {Promise<CurrentSale | boolean>}
      */
     async getCurrentSale() {
         const saleRequest = `SaleRequest-${Date.now().toString()}`;
@@ -341,7 +388,44 @@ class Application {
         if (saleState === false) {
             return saleState;
         }
-        return new CurrentSale_1.Sale(this, saleState);
+        return new CurrentSale_1.CurrentSale(this, saleState);
+    }
+    dataIsCreateEvent(data) {
+        return typeof data.requestId === "string" &&
+            typeof data.success === "boolean" && (typeof data.message === "undefined" ||
+            typeof data.message === "string");
+    }
+    /**
+     * Send the sale to be created on shopfront.
+     *
+     * @param sale
+     */
+    async createSale(sale) {
+        const createSaleRequest = `CreateSaleRequest-${Date.now().toString()}`;
+        const promise = new Promise(res => {
+            const listener = (event, data) => {
+                if (event !== "RESPONSE_CREATE_SALE") {
+                    return;
+                }
+                if (!this.dataIsCreateEvent(data)) {
+                    return;
+                }
+                if (data.requestId !== createSaleRequest) {
+                    return;
+                }
+                this.bridge.removeEventListener(listener);
+                res({
+                    success: data.success,
+                    message: data.message,
+                });
+            };
+            this.bridge.addEventListener(listener);
+        });
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.CREATE_SALE, {
+            requestId: createSaleRequest,
+            sale: (0, SaleCreate_1.buildSaleData)(sale),
+        });
+        return promise;
     }
     dataIsLocation(data) {
         return typeof data.requestId === "string" &&