@shopfront/bridge 2.0.0 → 2.0.2

package/lib/APIs/CurrentSale/SaleProduct.js

@@ -1,167 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaleProduct = void 0;
-class SaleProduct {
-    constructor(id, quantity, price, indexAddress) {
-        this.metaData = {};
-        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;
-        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;
-    }
-    /**
-     * 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/CurrentSale/ShopfrontSaleState.d.ts

@@ -1,53 +0,0 @@
-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>;
-}
-interface ShopfrontSaleCustomer {
-    uuid: string;
-}
-export interface ShopfrontSalePayment {
-    method: string;
-    type: string;
-    status: ShopfrontSalePaymentStatus;
-    amount: number;
-    cashout: number;
-    rounding: number;
-}
-export interface ShopfrontSaleState {
-    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/CurrentSale/ShopfrontSaleState.js

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

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

@@ -1,6 +0,0 @@
-export { Sale } from "./Sale";
-export { SaleProduct } from "./SaleProduct";
-export { SalePayment } from "./SalePayment";
-export { SalePaymentStatus } from "./SalePayment";
-export { SaleCustomer } from "./SaleCustomer";
-export * as Exceptions from "./Exceptions";

package/lib/APIs/CurrentSale/index.js

@@ -1,37 +0,0 @@
-"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.SaleCustomer = exports.SalePaymentStatus = exports.SalePayment = exports.SaleProduct = exports.Sale = void 0;
-var Sale_1 = require("./Sale");
-Object.defineProperty(exports, "Sale", { enumerable: true, get: function () { return Sale_1.Sale; } });
-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; } });
-exports.Exceptions = __importStar(require("./Exceptions"));