@shopfront/bridge 2.0.0 → 2.0.2

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

@@ -1,132 +1,67 @@
-import { BaseSale } from "./BaseSale";
-import { ShopfrontSaleState } from "./ShopfrontSaleState";
-import { SalePayment } from "./SalePayment";
-import { SaleProduct } from "./SaleProduct";
-import { SaleCustomer } from "./SaleCustomer";
-import { Application } from "../../Application";
-import { SaleUpdate, SaleUpdateChanges } from "../../Actions/SaleUpdate";
-export declare class CurrentSale extends BaseSale {
-    protected application: Application;
-    protected cancelled: boolean;
+import { SaleUpdate, SaleUpdateChanges } from "../../Actions/SaleUpdate.js";
+import { BaseCurrentSale } from "./BaseCurrentSale.js";
+import { SaleCustomer } from "./SaleCustomer.js";
+import { SalePayment } from "./SalePayment.js";
+import { SaleProduct } from "./SaleProduct.js";
+export declare class CurrentSale extends BaseCurrentSale {
     /**
-     * Create a sale from a sale state.
-     * It's highly recommend to not construct a sale manually, instead use application.getCurrentSale().
-     *
-     * @param {Application} application
-     * @param {ShopfrontSaleState} saleState
-     */
-    constructor(application: Application, saleState: ShopfrontSaleState);
-    /**
-     * Update the sale to be the latest sale that exists on the sell screen.
-     *
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     refreshSale(): Promise<void>;
     /**
      * Check if the sale has already been cancelled, if it has, throw a SaleCancelledError.
-     *
-     * @protected
      */
     protected checkIfCancelled(): void;
     /**
      * Send a sale update to Shopfront.
-     *
-     * @protected
-     * @param {SaleUpdate} update
-     * @returns {Promise<void>}
      */
     protected sendSaleUpdate(update: SaleUpdate<keyof SaleUpdateChanges>): Promise<void>;
     /**
-     * Cancel the current sale in progress.
-     *
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     cancelSale(): Promise<void>;
     /**
-     * Add a product to the sale.
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     addProduct(product: SaleProduct): Promise<void>;
     /**
-     * Remove a product from the sale.
-     * It's highly recommended that you pass in a product that has been retrieved using sale.getProducts().
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     removeProduct(product: SaleProduct): Promise<void>;
     /**
-     * Add a payment to the sell screen.
-     *
-     * If you specify a payment with a status, it will bypass the payment gateway (i.e. it won't request that the
-     * user takes money from the customer).
-     *
-     * If you don't specify a cashout amount, it will automatically determine if the payment method normally requests
-     * cashout (from the payment method settings).
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     addPayment(payment: SalePayment): Promise<void>;
     /**
-     * Reverse a payment on the sell screen.
-     *
-     * This is used to issue a refund to the customer. The sale payment amount should be positive.
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     reversePayment(payment: SalePayment): Promise<void>;
     /**
-     * Add a customer to the sale.
-     * If there is already a customer on the sale this will override that customer.
-     *
-     * @param {SaleCustomer} customer
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     addCustomer(customer: SaleCustomer): Promise<void>;
     /**
-     * Remove the customer from the current sale.
-     * If there is no customer currently on the sale this will be ignored.
-     * If there are "on account" or loyalty payments still on the sale, this will be ignored.
-     *
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     removeCustomer(): Promise<void>;
     /**
-     * Set the external note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     setExternalNote(note: string, append?: boolean): Promise<void>;
     /**
-     * Set the internal note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     setInternalNote(note: string, append?: boolean): Promise<void>;
     /**
-     * Set the order reference to the provided string.
-     *
-     * @param {string} reference
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     setOrderReference(reference: string): Promise<void>;
     /**
-     * Set the meta data of the sale, this will override the previous meta data.
-     *
-     * @param metaData
+     * @inheritDoc
      */
     setMetaData(metaData: Record<string, unknown>): Promise<void>;
     /**
-     * Update a product's details, currently this can update quantity, price and metadata
-     * @param product
+     * @inheritDoc
      */
     updateProduct(product: SaleProduct): Promise<void>;
 }

package/lib/APIs/Sale/CurrentSale.js

@@ -1,52 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrentSale = void 0;
-const BaseSale_1 = require("./BaseSale");
-const SaleUpdate_1 = require("../../Actions/SaleUpdate");
-const Exceptions_1 = require("./Exceptions");
-const Sale_1 = require("./Sale");
-class CurrentSale extends BaseSale_1.BaseSale {
+import { SaleUpdate } from "../../Actions/SaleUpdate.js";
+import { BaseCurrentSale } from "./BaseCurrentSale.js";
+import { InvalidSaleDeviceError, SaleCancelledError } from "./Exceptions.js";
+export class CurrentSale extends BaseCurrentSale {
     /**
-     * Create a sale from a sale state.
-     * It's highly recommend to not construct a sale manually, instead use application.getCurrentSale().
-     *
-     * @param {Application} application
-     * @param {ShopfrontSaleState} saleState
-     */
-    constructor(application, saleState) {
-        super(Sale_1.Sale.buildSaleData(saleState));
-        this.application = application;
-        this.cancelled = false;
-    }
-    /**
-     * Update the sale to be the latest sale that exists on the sell screen.
-     *
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     async refreshSale() {
         this.checkIfCancelled();
         const newSale = await this.application.getCurrentSale();
         if (newSale === false) {
-            throw new Exceptions_1.InvalidSaleDeviceError();
+            throw new InvalidSaleDeviceError();
         }
         this.hydrate(newSale);
     }
     /**
      * Check if the sale has already been cancelled, if it has, throw a SaleCancelledError.
-     *
-     * @protected
      */
     checkIfCancelled() {
         if (this.cancelled) {
-            throw new Exceptions_1.SaleCancelledError();
+            throw new SaleCancelledError();
         }
     }
     /**
      * Send a sale update to Shopfront.
-     *
-     * @protected
-     * @param {SaleUpdate} update
-     * @returns {Promise<void>}
      */
     sendSaleUpdate(update) {
         this.checkIfCancelled();
@@ -54,22 +30,17 @@ class CurrentSale extends BaseSale_1.BaseSale {
         return this.refreshSale();
     }
     /**
-     * Cancel the current sale in progress.
-     *
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     async cancelSale() {
-        await this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_CANCEL", {}));
+        await this.sendSaleUpdate(new SaleUpdate("SALE_CANCEL", {}));
         this.cancelled = true;
     }
     /**
-     * Add a product to the sale.
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     addProduct(product) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_ADD", {
+        return this.sendSaleUpdate(new SaleUpdate("PRODUCT_ADD", {
             id: product.getId(),
             quantity: product.getQuantity(),
             price: product.getPrice(),
@@ -78,32 +49,19 @@ class CurrentSale extends BaseSale_1.BaseSale {
         }));
     }
     /**
-     * Remove a product from the sale.
-     * It's highly recommended that you pass in a product that has been retrieved using sale.getProducts().
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     removeProduct(product) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_REMOVE", {
+        return this.sendSaleUpdate(new SaleUpdate("PRODUCT_REMOVE", {
             id: product.getId(),
             indexAddress: product.getIndexAddress(),
         }));
     }
     /**
-     * Add a payment to the sell screen.
-     *
-     * If you specify a payment with a status, it will bypass the payment gateway (i.e. it won't request that the
-     * user takes money from the customer).
-     *
-     * If you don't specify a cashout amount, it will automatically determine if the payment method normally requests
-     * cashout (from the payment method settings).
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     addPayment(payment) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PAYMENT_ADD", {
+        return this.sendSaleUpdate(new SaleUpdate("PAYMENT_ADD", {
             id: payment.getId(),
             amount: payment.getAmount(),
             cashout: payment.getCashout(),
@@ -111,15 +69,10 @@ class CurrentSale extends BaseSale_1.BaseSale {
         }));
     }
     /**
-     * Reverse a payment on the sell screen.
-     *
-     * This is used to issue a refund to the customer. The sale payment amount should be positive.
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     reversePayment(payment) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PAYMENT_REVERSE", {
+        return this.sendSaleUpdate(new SaleUpdate("PAYMENT_REVERSE", {
             id: payment.getId(),
             amount: payment.getAmount(),
             cashout: payment.getCashout(),
@@ -127,82 +80,60 @@ class CurrentSale extends BaseSale_1.BaseSale {
         }));
     }
     /**
-     * Add a customer to the sale.
-     * If there is already a customer on the sale this will override that customer.
-     *
-     * @param {SaleCustomer} customer
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     addCustomer(customer) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("CUSTOMER_ADD", {
+        return this.sendSaleUpdate(new SaleUpdate("CUSTOMER_ADD", {
             id: customer.getId(),
         }));
     }
     /**
-     * Remove the customer from the current sale.
-     * If there is no customer currently on the sale this will be ignored.
-     * If there are "on account" or loyalty payments still on the sale, this will be ignored.
-     *
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     removeCustomer() {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("CUSTOMER_REMOVE", {}));
+        return this.sendSaleUpdate(new SaleUpdate("CUSTOMER_REMOVE", {}));
     }
     /**
-     * Set the external note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     setExternalNote(note, append = false) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_EXTERNAL_NOTE", {
+        return this.sendSaleUpdate(new SaleUpdate("SALE_EXTERNAL_NOTE", {
             note,
             append,
         }));
     }
     /**
-     * Set the internal note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     setInternalNote(note, append = false) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_INTERNAL_NOTE", {
+        return this.sendSaleUpdate(new SaleUpdate("SALE_INTERNAL_NOTE", {
             note,
             append,
         }));
     }
     /**
-     * Set the order reference to the provided string.
-     *
-     * @param {string} reference
-     * @returns {Promise<void>}
+     * @inheritDoc
      */
     setOrderReference(reference) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_ORDER_REFERENCE", {
+        return this.sendSaleUpdate(new SaleUpdate("SALE_ORDER_REFERENCE", {
             reference,
         }));
     }
     /**
-     * Set the meta data of the sale, this will override the previous meta data.
-     *
-     * @param metaData
+     * @inheritDoc
      */
     setMetaData(metaData) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_META_DATA", {
+        return this.sendSaleUpdate(new SaleUpdate("SALE_META_DATA", {
             metaData,
         }));
     }
     /**
-     * Update a product's details, currently this can update quantity, price and metadata
-     * @param product
+     * @inheritDoc
      */
     updateProduct(product) {
         const updateData = {
             id: product.getId(),
-            indexAddress: product.getIndexAddress()
+            indexAddress: product.getIndexAddress(),
         };
         if (product.wasQuantityModified()) {
             updateData.quantity = product.getQuantity();
@@ -214,7 +145,6 @@ class CurrentSale extends BaseSale_1.BaseSale {
             updateData.metaData = product.getMetaData();
         }
         product.clearModificationFlags();
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_UPDATE", updateData));
+        return this.sendSaleUpdate(new SaleUpdate("PRODUCT_UPDATE", updateData));
     }
 }
-exports.CurrentSale = CurrentSale;

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

@@ -4,3 +4,6 @@ export declare class SaleCancelledError extends Error {
 export declare class InvalidSaleDeviceError extends Error {
     constructor();
 }
+export declare class ProductNotExistsError extends Error {
+    constructor();
+}

package/lib/APIs/Sale/Exceptions.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidSaleDeviceError = exports.SaleCancelledError = void 0;
-class SaleCancelledError extends Error {
+export class SaleCancelledError extends Error {
     constructor() {
         super("The sale is no longer active.");
     }
 }
-exports.SaleCancelledError = SaleCancelledError;
-class InvalidSaleDeviceError extends Error {
+export class InvalidSaleDeviceError extends Error {
     constructor() {
         super("This device is no longer a register able to perform a sale.");
     }
 }
-exports.InvalidSaleDeviceError = InvalidSaleDeviceError;
+export class ProductNotExistsError extends Error {
+    constructor() {
+        super("Product does not exist in the sale");
+    }
+}

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

@@ -1,23 +1,56 @@
-import { BaseSale, SaleData } from "./BaseSale";
-import { SaleCustomer } from "./SaleCustomer";
-import { SalePayment } from "./SalePayment";
-import { SaleProduct } from "./SaleProduct";
-import { Application } from "../../Application";
-import { ShopfrontSaleState } from "./ShopfrontSaleState";
+import { Application } from "../../Application.js";
+import { BaseSale, SaleData } from "./BaseSale.js";
+import { SaleCustomer } from "./SaleCustomer.js";
+import { SalePayment } from "./SalePayment.js";
+import { SaleProduct } from "./SaleProduct.js";
+import { ShopfrontSaleState } from "./ShopfrontSaleState.js";
 export declare class Sale extends BaseSale {
     protected created: boolean;
     protected creating: boolean;
     constructor(data: SaleData);
+    /**
+     * Add a customer to the sale
+     */
     addCustomer(customer: SaleCustomer): Promise<void>;
+    /**
+     * Add a payment to the sale
+     */
     addPayment(payment: SalePayment): Promise<void>;
+    /**
+     * Add a product to the sale
+     */
     addProduct(product: SaleProduct): Promise<void>;
+    /**
+     * Remove the customer from the sale
+     */
     removeCustomer(): Promise<void>;
+    /**
+     * Remove a product from the sale
+     */
     removeProduct(product: SaleProduct): Promise<void>;
+    /**
+     * Remove a payment from the sale
+     */
     removePayment(payment: SalePayment): Promise<void>;
+    /**
+     * Add / append an external note to the sale
+     */
     setExternalNote(note: string, append?: boolean): Promise<void>;
+    /**
+     * Add / append an internal note to the sale
+     */
     setInternalNote(note: string, append?: boolean): Promise<void>;
+    /**
+     * Set the sale's meta-data
+     */
     setMetaData(metaData: Record<string, unknown>): Promise<void>;
+    /**
+     * Set the sale's order reference
+     */
     setOrderReference(reference: string): Promise<void>;
+    /**
+     * Update a product in the sale
+     */
     updateProduct(product: SaleProduct): Promise<void>;
     /**
      * Create the sale on the server
@@ -28,7 +61,6 @@ export declare class Sale extends BaseSale {
     }>;
     /**
      * Converts the sale state to the sale data
-     * @param saleState
      */
     static buildSaleData(saleState: ShopfrontSaleState): SaleData;
 }

package/lib/APIs/Sale/Sale.js

@@ -1,34 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sale = void 0;
-const BaseSale_1 = require("./BaseSale");
-const SaleCustomer_1 = require("./SaleCustomer");
-const SalePayment_1 = require("./SalePayment");
-const SaleProduct_1 = require("./SaleProduct");
-class Sale extends BaseSale_1.BaseSale {
+import { BaseSale } from "./BaseSale.js";
+import { SaleCustomer } from "./SaleCustomer.js";
+import { SalePayment } from "./SalePayment.js";
+import { SaleProduct } from "./SaleProduct.js";
+export class Sale extends BaseSale {
     constructor(data) {
         super(data);
         this.created = false;
         this.creating = false;
     }
+    /**
+     * Add a customer to the sale
+     */
     async addCustomer(customer) {
         this.customer = customer;
     }
+    /**
+     * Add a payment to the sale
+     */
     async addPayment(payment) {
         if (this.payments.find(p => p.internalId === payment.internalId)) {
             throw new TypeError("Payment has already been added to sale.");
         }
         this.payments.push(payment);
     }
+    /**
+     * Add a product to the sale
+     */
     async addProduct(product) {
         if (this.products.find(p => p.internalId === product.internalId)) {
             throw new TypeError("Product has already been added to sale.");
         }
         this.products.push(product);
     }
+    /**
+     * Remove the customer from the sale
+     */
     async removeCustomer() {
         this.customer = null;
     }
+    /**
+     * Remove a product from the sale
+     */
     async removeProduct(product) {
         const index = this.products.findIndex(p => p.internalId === product.internalId);
         if (index === -1) {
@@ -36,6 +48,9 @@ class Sale extends BaseSale_1.BaseSale {
         }
         this.products.splice(index, 1);
     }
+    /**
+     * Remove a payment from the sale
+     */
     async removePayment(payment) {
         const index = this.payments.findIndex(p => p.internalId === payment.internalId);
         if (index === -1) {
@@ -43,6 +58,9 @@ class Sale extends BaseSale_1.BaseSale {
         }
         this.payments.splice(index, 1);
     }
+    /**
+     * Add / append an external note to the sale
+     */
     async setExternalNote(note, append) {
         if (append) {
             this.sale.notes.sale += note;
@@ -51,6 +69,9 @@ class Sale extends BaseSale_1.BaseSale {
             this.sale.notes.sale = note;
         }
     }
+    /**
+     * Add / append an internal note to the sale
+     */
     async setInternalNote(note, append) {
         if (append) {
             this.sale.notes.internal += note;
@@ -59,12 +80,21 @@ class Sale extends BaseSale_1.BaseSale {
             this.sale.notes.internal = note;
         }
     }
+    /**
+     * Set the sale's meta-data
+     */
     async setMetaData(metaData) {
         this.sale.metaData = metaData;
     }
+    /**
+     * Set the sale's order reference
+     */
     async setOrderReference(reference) {
         this.sale.orderReference = reference;
     }
+    /**
+     * Update a product in the sale
+     */
     async updateProduct(product) {
         const index = this.products.findIndex(p => p.internalId === product.internalId);
         if (index === -1) {
@@ -92,7 +122,6 @@ class Sale extends BaseSale_1.BaseSale {
     }
     /**
      * Converts the sale state to the sale data
-     * @param saleState
      */
     static buildSaleData(saleState) {
         return {
@@ -105,12 +134,11 @@ class Sale extends BaseSale_1.BaseSale {
             refundReason: saleState.refundReason,
             priceSet: saleState.priceSet,
             metaData: saleState.metaData,
-            customer: saleState.customer ? new SaleCustomer_1.SaleCustomer(saleState.customer.uuid) : null,
-            payments: saleState.payments.map(SalePayment_1.SalePayment.HydrateFromState),
+            customer: saleState.customer ? new SaleCustomer(saleState.customer.uuid) : null,
+            payments: saleState.payments.map(SalePayment.HydrateFromState),
             products: saleState.products.map((product, index) => {
-                return SaleProduct_1.SaleProduct.HydrateFromState(product, [index]);
+                return SaleProduct.HydrateFromState(product, [index]);
             }),
         };
     }
 }
-exports.Sale = Sale;

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

@@ -3,8 +3,6 @@ export declare class SaleCustomer {
     constructor(id: string);
     /**
      * Get the ID of the customer.
-     *
-     * @returns {string}
      */
     getId(): string;
 }

package/lib/APIs/Sale/SaleCustomer.js

@@ -1,17 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaleCustomer = void 0;
-class SaleCustomer {
+export class SaleCustomer {
     constructor(id) {
         this.id = id;
     }
     /**
      * Get the ID of the customer.
-     *
-     * @returns {string}
      */
     getId() {
         return this.id;
     }
 }
-exports.SaleCustomer = SaleCustomer;