@shopfront/bridge 2.0.0 → 2.0.2

package/lib/APIs/CurrentSale/Sale.js

@@ -1,290 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sale = void 0;
-const SaleUpdate_1 = require("../../Actions/SaleUpdate");
-const SaleProduct_1 = require("./SaleProduct");
-const SalePayment_1 = require("./SalePayment");
-const SaleCustomer_1 = require("./SaleCustomer");
-const Exceptions_1 = require("./Exceptions");
-class Sale {
-    /**
-     * 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} sale
-     */
-    constructor(application, sale) {
-        this.application = application;
-        this.sale = sale;
-        this.cancelled = false;
-    }
-    /**
-     * Get the raw state of the sale, it is highly recommend that you DO NOT use this method as the
-     * returned data may be quite volatile.
-     *
-     * @internal
-     * @returns {ShopfrontSaleState}
-     */
-    getRawState() {
-        return this.sale;
-    }
-    /**
-     * Update the sale to be the latest sale that exists on the sell screen.
-     *
-     * @returns {Promise<void>}
-     */
-    async refreshSale() {
-        this.checkIfCancelled();
-        const newSale = await this.application.getCurrentSale();
-        if (newSale === false) {
-            throw new Exceptions_1.InvalidSaleDeviceError();
-        }
-        this.sale = newSale.getRawState();
-    }
-    /**
-     * Check if the sale has already been cancelled, if it has, throw a SaleCancelledError.
-     *
-     * @protected
-     */
-    checkIfCancelled() {
-        if (this.cancelled) {
-            throw new Exceptions_1.SaleCancelledError();
-        }
-    }
-    /**
-     * Send a sale update to Shopfront.
-     *
-     * @protected
-     * @param {SaleUpdate} update
-     * @returns {Promise<void>}
-     */
-    sendSaleUpdate(update) {
-        this.checkIfCancelled();
-        this.application.send(update);
-        return this.refreshSale();
-    }
-    /**
-     * Get the products that are currently on the sale.
-     *
-     * @returns {Array<SaleProduct>}
-     */
-    getProducts() {
-        const products = [];
-        for (let i = 0, l = this.sale.products.length; i < l; i++) {
-            // The hydration method loops through child products so we don't have to
-            // worry about that here.
-            products.push(SaleProduct_1.SaleProduct.HydrateFromState(this.sale.products[i], [i]));
-        }
-        return products;
-    }
-    /**
-     * Get the payments that are currently on the sale.
-     *
-     * @returns {Array<SalePayment>}
-     */
-    getPayments() {
-        const payments = [];
-        for (let i = 0, l = this.sale.payments.length; i < l; i++) {
-            payments.push(SalePayment_1.SalePayment.HydrateFromState(this.sale.payments[i]));
-        }
-        return payments;
-    }
-    /**
-     * Get the current customer on the sale.
-     *
-     * @returns {SaleCustomer | null}
-     */
-    getCustomer() {
-        if (this.sale.customer === false) {
-            return null;
-        }
-        return new SaleCustomer_1.SaleCustomer(this.sale.customer.uuid);
-    }
-    /**
-     * Get the external sale note (visible to the customer).
-     *
-     * @returns {string}
-     */
-    getExternalNote() {
-        return this.sale.notes.sale;
-    }
-    /**
-     * Get the internal sale note.
-     *
-     * @returns {string}
-     */
-    getInternalNote() {
-        return this.sale.notes.internal;
-    }
-    /**
-     * Get the order reference (visible to the customer).
-     *
-     * @returns {string}
-     */
-    getOrderReference() {
-        return this.sale.orderReference;
-    }
-    /**
-     * Get the current meta data for the sale
-     *
-     * @returns {Record<string, unknown>}
-     */
-    getMetaData() {
-        return this.sale.metaData;
-    }
-    /**
-     * Cancel the current sale in progress.
-     *
-     * @returns {Promise<void>}
-     */
-    async cancelSale() {
-        await this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_CANCEL", {}));
-        this.cancelled = true;
-    }
-    /**
-     * Add a product to the sale.
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
-     */
-    addProduct(product) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_ADD", {
-            id: product.getId(),
-            quantity: product.getQuantity(),
-            price: product.getPrice(),
-            indexAddress: product.getIndexAddress(),
-            metaData: product.getMetaData(),
-        }));
-    }
-    /**
-     * 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>}
-     */
-    removeProduct(product) {
-        return this.sendSaleUpdate(new SaleUpdate_1.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>}
-     */
-    addPayment(payment) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PAYMENT_ADD", {
-            id: payment.getId(),
-            amount: payment.getAmount(),
-            cashout: payment.getCashout(),
-            status: payment.getStatus(),
-        }));
-    }
-    /**
-     * 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>}
-     */
-    reversePayment(payment) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PAYMENT_REVERSE", {
-            id: payment.getId(),
-            amount: payment.getAmount(),
-            cashout: payment.getCashout(),
-            status: payment.getStatus(),
-        }));
-    }
-    /**
-     * 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>}
-     */
-    addCustomer(customer) {
-        return this.sendSaleUpdate(new SaleUpdate_1.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>}
-     */
-    removeCustomer() {
-        return this.sendSaleUpdate(new SaleUpdate_1.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>}
-     */
-    setExternalNote(note, append = false) {
-        return this.sendSaleUpdate(new SaleUpdate_1.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>}
-     */
-    setInternalNote(note, append = false) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_INTERNAL_NOTE", {
-            note,
-            append,
-        }));
-    }
-    /**
-     * Set the order reference to the provided string.
-     *
-     * @param {string} reference
-     * @returns {Promise<void>}
-     */
-    setOrderReference(reference) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_ORDER_REFERENCE", {
-            reference,
-        }));
-    }
-    /**
-     * Set the meta data of the sale, this will override the previous meta data.
-     *
-     * @param metaData
-     */
-    setMetaData(metaData) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_META_DATA", {
-            metaData,
-        }));
-    }
-    /**
-     * Update a product's details, currently this only updates the top-level meta data
-     * @param product
-     */
-    updateProduct(product) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_UPDATE", {
-            id: product.getId(),
-            indexAddress: product.getIndexAddress(),
-            metaData: product.getMetaData(),
-        }));
-    }
-}
-exports.Sale = Sale;

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

@@ -1,10 +0,0 @@
-export declare class SaleCustomer {
-    protected id: string;
-    constructor(id: string);
-    /**
-     * Get the ID of the customer.
-     *
-     * @returns {string}
-     */
-    getId(): string;
-}

package/lib/APIs/CurrentSale/SaleCustomer.js

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

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

@@ -1,68 +0,0 @@
-import { ShopfrontSalePayment } from "./ShopfrontSaleState";
-export declare enum SalePaymentStatus {
-    APPROVED = "completed",
-    DECLINED = "failed",
-    CANCELLED = "cancelled"
-}
-export declare class SalePayment {
-    protected id: string;
-    protected type?: string;
-    protected status?: SalePaymentStatus;
-    protected amount: number;
-    protected cashout?: number;
-    protected rounding?: number;
-    constructor(id: string, amount: number, cashout?: number, status?: SalePaymentStatus);
-    /**
-     * Hydrate a sale payment from the SaleState.
-     *
-     * @internal
-     * @param {ShopfrontSalePayment} payment
-     * @returns {SalePayment}
-     * @constructor
-     */
-    static HydrateFromState(payment: ShopfrontSalePayment): SalePayment;
-    /**
-     * Set the internal data for the payment.
-     * This method is for hydration of the payment from Shopfront, it's highly recommend that you DO NOT use this method.
-     *
-     * @internal
-     * @param {ShopfrontSalePayment} data
-     */
-    setInternal(data: ShopfrontSalePayment): void;
-    /**
-     * Get the ID of the sale payment method.
-     *
-     * @returns {string}
-     */
-    getId(): string;
-    /**
-     * Get the type of payment method this is.
-     *
-     * @returns {string | undefined}
-     */
-    getType(): string | undefined;
-    /**
-     * Get the status of this payment method.
-     *
-     * @returns {SalePaymentStatus | undefined}
-     */
-    getStatus(): SalePaymentStatus | undefined;
-    /**
-     * Get the value of this payment method.
-     *
-     * @returns {number}
-     */
-    getAmount(): number;
-    /**
-     * Get the cashout amount paid for on this payment method.
-     *
-     * @returns {number | undefined}
-     */
-    getCashout(): number | undefined;
-    /**
-     * Get the amount of rounding applied to this payment method.
-     *
-     * @returns {number | undefined}
-     */
-    getRounding(): number | undefined;
-}

package/lib/APIs/CurrentSale/SalePayment.js

@@ -1,99 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SalePayment = exports.SalePaymentStatus = void 0;
-var SalePaymentStatus;
-(function (SalePaymentStatus) {
-    SalePaymentStatus["APPROVED"] = "completed";
-    SalePaymentStatus["DECLINED"] = "failed";
-    SalePaymentStatus["CANCELLED"] = "cancelled";
-})(SalePaymentStatus = exports.SalePaymentStatus || (exports.SalePaymentStatus = {}));
-class SalePayment {
-    constructor(id, amount, cashout, status) {
-        this.id = id;
-        this.amount = amount;
-        this.cashout = cashout;
-        this.status = status;
-    }
-    /**
-     * Hydrate a sale payment from the SaleState.
-     *
-     * @internal
-     * @param {ShopfrontSalePayment} payment
-     * @returns {SalePayment}
-     * @constructor
-     */
-    static HydrateFromState(payment) {
-        let status = SalePaymentStatus.APPROVED;
-        switch (payment.status) {
-            case "failed":
-                status = SalePaymentStatus.DECLINED;
-                break;
-            case "cancelled":
-                status = SalePaymentStatus.CANCELLED;
-                break;
-        }
-        const hydrated = new SalePayment(payment.method, payment.amount, payment.cashout, status);
-        hydrated.setInternal(payment);
-        return hydrated;
-    }
-    /**
-     * Set the internal data for the payment.
-     * This method is for hydration of the payment from Shopfront, it's highly recommend that you DO NOT use this method.
-     *
-     * @internal
-     * @param {ShopfrontSalePayment} data
-     */
-    setInternal(data) {
-        this.type = data.type;
-        this.rounding = data.rounding;
-    }
-    /**
-     * Get the ID of the sale payment method.
-     *
-     * @returns {string}
-     */
-    getId() {
-        return this.id;
-    }
-    /**
-     * Get the type of payment method this is.
-     *
-     * @returns {string | undefined}
-     */
-    getType() {
-        return this.type;
-    }
-    /**
-     * Get the status of this payment method.
-     *
-     * @returns {SalePaymentStatus | undefined}
-     */
-    getStatus() {
-        return this.status;
-    }
-    /**
-     * Get the value of this payment method.
-     *
-     * @returns {number}
-     */
-    getAmount() {
-        return this.amount;
-    }
-    /**
-     * Get the cashout amount paid for on this payment method.
-     *
-     * @returns {number | undefined}
-     */
-    getCashout() {
-        return this.cashout;
-    }
-    /**
-     * Get the amount of rounding applied to this payment method.
-     *
-     * @returns {number | undefined}
-     */
-    getRounding() {
-        return this.rounding;
-    }
-}
-exports.SalePayment = SalePayment;

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

@@ -1,121 +0,0 @@
-import { ShopfrontSaleProduct, ShopfrontSaleProductType } from "./ShopfrontSaleState";
-export declare class SaleProduct {
-    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>;
-    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;
-    /**
-     * 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;
-}