@shopfront/bridge 1.16.0 → 1.18.2

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,10 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <JSCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+    </TypeScriptCodeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/embedded-bridge.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" />
     </modules>
   </component>
 </project>

package/.idea/php.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MessDetectorOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCSFixerOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCodeSnifferOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PhpStanOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PsalmOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+</project>

package/.idea/{embedded-bridge.iml → shopfront-embedded-bridge.iml}

@@ -1,9 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="WEB_MODULE" version="4">
   <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/lib" />
-    </content>
+    <content url="file://$MODULE_DIR$" />
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>

package/lib/APIs/Fulfilment/FulfilmentTypes.d.ts

@@ -0,0 +1,43 @@
+export declare type OrderStatus = "PENDING_APPROVAL" | "WAITING_FOR_PACKING" | "PACKED" | "COLLECTED" | "COMPLETED";
+export interface OrderSummaryDetails {
+    id: string;
+    customer: {
+        name: string;
+        phone: string;
+    };
+    courier?: {
+        icon?: string;
+        name: string;
+        phone: string;
+    };
+    comment?: string;
+    totalPrice: number;
+    expiry?: string | Date;
+    status: OrderStatus;
+    finalLabel?: string;
+    createdAt: string;
+}
+export declare type OrderCreateDetails = Omit<OrderSummaryDetails, "status"> & Partial<Pick<OrderSummaryDetails, "status">>;
+export interface OrderDetails extends OrderSummaryDetails {
+    items: Array<OrderItem>;
+}
+export interface OrderItem {
+    id: string;
+    image?: string;
+    name: string;
+    quantity: number;
+    packSize: number;
+    price: number;
+    comment?: string;
+    match?: OrderItemMatch;
+}
+export interface OrderItemMatch {
+    id?: string;
+    barcodes?: Array<string>;
+    mdbId?: number;
+    supplier?: {
+        id?: string;
+        mdbId?: number;
+    };
+    supplierCodes?: Array<string>;
+}

package/lib/APIs/Fulfilment/FulfilmentTypes.js

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

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

@@ -0,0 +1,147 @@
+import { SaleCustomer } from "./SaleCustomer";
+import { SalePayment } from "./SalePayment";
+import { SaleProduct } from "./SaleProduct";
+export interface BaseSaleData {
+    register: string | undefined;
+    clientId: string | undefined;
+    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 interface SaleData extends BaseSaleData {
+    customer: null | SaleCustomer;
+    payments: Array<SalePayment>;
+    products: Array<SaleProduct>;
+}
+export declare abstract class BaseSale {
+    protected sale: BaseSaleData;
+    protected customer: null | SaleCustomer;
+    protected payments: Array<SalePayment>;
+    protected products: Array<SaleProduct>;
+    protected constructor({ customer, payments, products, ...sale }: SaleData);
+    /**
+     * Updates the sale data to be inline with the new sale
+     *
+     * @param {BaseSale} sale
+     * @protected
+     */
+    protected hydrate(sale: BaseSale): void;
+    /**
+     * Get the products that are currently on the sale.
+     *
+     * @returns {Array<SaleProduct>}
+     */
+    getProducts(): Array<SaleProduct>;
+    /**
+     * Get the payments that are currently on the sale.
+     *
+     * @returns {Array<SalePayment>}
+     */
+    getPayments(): Array<SalePayment>;
+    /**
+     * Get the current customer on the sale.
+     *
+     * @returns {SaleCustomer | null}
+     */
+    getCustomer(): null | SaleCustomer;
+    /**
+     * Get the register.
+     *
+     * @returns {string | undefined}
+     */
+    getRegister(): string | undefined;
+    /**
+     * Get the client id.
+     *
+     * @returns {string | null}
+     */
+    getClientId(): string | undefined;
+    /**
+     * Get the current sale total on the sale.
+     *
+     * @returns {number}
+     */
+    getSaleTotal(): number;
+    /**
+     * Get the current paid total on the sale.
+     *
+     * @returns {number}
+     */
+    getPaidTotal(): number;
+    /**
+     * Get the current savings total on the sale.
+     *
+     * @returns {number}
+     */
+    getSavingsTotal(): number;
+    /**
+     * Get the current discount total on the sale.
+     *
+     * @returns {number}
+     */
+    getDiscountTotal(): number;
+    /**
+     * Get the linked to value on the sale.
+     *
+     * @returns {string}
+     */
+    getLinkedTo(): string;
+    /**
+     * Get the refund reason on the sale.
+     *
+     * @returns {string}
+     */
+    getRefundReason(): string;
+    /**
+     * Get the price set on the sale.
+     *
+     * @returns {string | null}
+     */
+    getPriceSet(): string | null;
+    /**
+     * Get the external sale note (visible to the customer).
+     *
+     * @returns {string}
+     */
+    getExternalNote(): string;
+    /**
+     * Get the internal sale note.
+     *
+     * @returns {string}
+     */
+    getInternalNote(): string;
+    /**
+     * Get the order reference (visible to the customer).
+     *
+     * @returns {string}
+     */
+    getOrderReference(): string;
+    /**
+     * Get the current meta data for the sale
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData(): Record<string, unknown>;
+    abstract addProduct(product: SaleProduct): Promise<void>;
+    abstract removeProduct(product: SaleProduct): Promise<void>;
+    abstract addPayment(payment: SalePayment): Promise<void>;
+    abstract addCustomer(customer: SaleCustomer): Promise<void>;
+    abstract removeCustomer(): Promise<void>;
+    abstract setExternalNote(note: string, append?: boolean): Promise<void>;
+    abstract setInternalNote(note: string, append?: boolean): Promise<void>;
+    abstract setOrderReference(reference: string): Promise<void>;
+    abstract setMetaData(metaData: Record<string, unknown>): Promise<void>;
+    abstract updateProduct(product: SaleProduct): Promise<void>;
+}

package/lib/APIs/Sale/BaseSale.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSale = void 0;
+class BaseSale {
+    constructor({ customer, payments, products, ...sale }) {
+        this.sale = sale;
+        this.customer = customer;
+        this.payments = payments;
+        this.products = products;
+    }
+    /**
+     * Updates the sale data to be inline with the new sale
+     *
+     * @param {BaseSale} sale
+     * @protected
+     */
+    hydrate(sale) {
+        this.sale = sale.sale;
+        this.customer = sale.customer;
+        this.payments = sale.payments;
+        this.products = sale.products;
+    }
+    /**
+     * Get the products that are currently on the sale.
+     *
+     * @returns {Array<SaleProduct>}
+     */
+    getProducts() {
+        return this.products;
+    }
+    /**
+     * Get the payments that are currently on the sale.
+     *
+     * @returns {Array<SalePayment>}
+     */
+    getPayments() {
+        return this.payments;
+    }
+    /**
+     * Get the current customer on the sale.
+     *
+     * @returns {SaleCustomer | null}
+     */
+    getCustomer() {
+        return this.customer;
+    }
+    /**
+     * Get the register.
+     *
+     * @returns {string | undefined}
+     */
+    getRegister() {
+        return this.sale.register;
+    }
+    /**
+     * Get the client id.
+     *
+     * @returns {string | null}
+     */
+    getClientId() {
+        return this.sale.clientId;
+    }
+    /**
+     * Get the current sale total on the sale.
+     *
+     * @returns {number}
+     */
+    getSaleTotal() {
+        return this.sale.totals.sale;
+    }
+    /**
+     * Get the current paid total on the sale.
+     *
+     * @returns {number}
+     */
+    getPaidTotal() {
+        return this.sale.totals.paid;
+    }
+    /**
+     * Get the current savings total on the sale.
+     *
+     * @returns {number}
+     */
+    getSavingsTotal() {
+        return this.sale.totals.savings;
+    }
+    /**
+     * Get the current discount total on the sale.
+     *
+     * @returns {number}
+     */
+    getDiscountTotal() {
+        return this.sale.totals.discount;
+    }
+    /**
+     * Get the linked to value on the sale.
+     *
+     * @returns {string}
+     */
+    getLinkedTo() {
+        return this.sale.linkedTo;
+    }
+    /**
+     * Get the refund reason on the sale.
+     *
+     * @returns {string}
+     */
+    getRefundReason() {
+        return this.sale.refundReason;
+    }
+    /**
+     * Get the price set on the sale.
+     *
+     * @returns {string | null}
+     */
+    getPriceSet() {
+        return this.sale.priceSet;
+    }
+    /**
+     * 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;
+    }
+}
+exports.BaseSale = BaseSale;

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

@@ -0,0 +1,132 @@
+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;
+    /**
+     * 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>}
+     */
+    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>}
+     */
+    cancelSale(): Promise<void>;
+    /**
+     * Add a product to the sale.
+     *
+     * @param {SaleProduct} product
+     * @returns {Promise<void>}
+     */
+    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>}
+     */
+    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>}
+     */
+    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>}
+     */
+    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>}
+     */
+    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>}
+     */
+    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>}
+     */
+    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>}
+     */
+    setInternalNote(note: string, append?: boolean): Promise<void>;
+    /**
+     * Set the order reference to the provided string.
+     *
+     * @param {string} reference
+     * @returns {Promise<void>}
+     */
+    setOrderReference(reference: string): Promise<void>;
+    /**
+     * Set the meta data of the sale, this will override the previous meta data.
+     *
+     * @param metaData
+     */
+    setMetaData(metaData: Record<string, unknown>): Promise<void>;
+    /**
+     * Update a product's details, currently this only updates the top-level meta data
+     * @param product
+     */
+    updateProduct(product: SaleProduct): Promise<void>;
+}