@shopfront/bridge 1.6.0 → 1.10.0

package/.idea/compiler.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="TypeScriptCompiler">
+    <option name="nodeInterpreterTextField" value="$USER_HOME$/.nvm/versions/node/v14.15.0/bin/node" />
+  </component>
+</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,7 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="JSIgnoredPromiseFromCall" enabled="false" level="WEAK WARNING" enabled_by_default="false" />
+    <inspection_tool class="JSMethodCanBeStatic" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/shopfront-embedded-bridge.iml

@@ -0,0 +1,10 @@
+<?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>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

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

@@ -162,4 +162,9 @@ export declare class Sale {
      * @returns {Promise<void>}
      */
     setOrderReference(reference: string): Promise<void>;
+    /**
+     * Update a product's details, currently this only updates the top-level meta data
+     * @param product
+     */
+    updateProduct(product: SaleProduct): Promise<void>;
 }

package/lib/APIs/CurrentSale/Sale.js

@@ -146,6 +146,7 @@ class Sale {
             quantity: product.getQuantity(),
             price: product.getPrice(),
             indexAddress: product.getIndexAddress(),
+            metaData: product.getMetaData(),
         }));
     }
     /**
@@ -256,5 +257,16 @@ class Sale {
             reference,
         }));
     }
+    /**
+     * 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/SaleProduct.d.ts

@@ -11,6 +11,7 @@ export declare class SaleProduct {
     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.
@@ -72,7 +73,7 @@ export declare class SaleProduct {
      *
      * @returns {ShopfrontSaleProductType | undefined}
      */
-    getType(): "Normal" | "Basket" | "Package" | "Component" | "Voucher" | undefined;
+    getType(): "Normal" | "Voucher" | "Basket" | "Package" | "Component" | undefined;
     /**
      * Get the tax rate amount.
      * This is the rate of the tax rate (e.g. 10 is a tax rate of 10%).
@@ -105,4 +106,16 @@ export declare class SaleProduct {
      * @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/CurrentSale/SaleProduct.js

@@ -3,6 +3,7 @@ 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;
@@ -50,6 +51,7 @@ class SaleProduct {
         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,
@@ -146,5 +148,21 @@ class SaleProduct {
     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

@@ -17,6 +17,7 @@ export interface ShopfrontSaleProduct {
     products: Array<ShopfrontSaleProduct>;
     edited: boolean;
     caseQuantity: number;
+    metaData: Record<string, unknown>;
 }
 interface ShopfrontSaleCustomer {
     uuid: string;

package/lib/Actions/CustomerListOption.d.ts

@@ -0,0 +1,7 @@
+import { BaseAction } from "./BaseAction";
+import { Serialized } from "../Common/Serializable";
+export declare class CustomerListOption extends BaseAction<CustomerListOption> {
+    protected supportedEvents: string[];
+    protected contents: string;
+    constructor(contents: Serialized<CustomerListOption> | string);
+}

package/lib/Actions/CustomerListOption.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerListOption = void 0;
+const BaseAction_1 = require("./BaseAction");
+class CustomerListOption extends BaseAction_1.BaseAction {
+    constructor(contents) {
+        super((() => {
+            if (typeof contents === "string") {
+                return {
+                    properties: [contents],
+                    events: {},
+                    type: "CustomerListOption",
+                };
+            }
+            return contents;
+        })(), CustomerListOption);
+        this.supportedEvents = ["click"];
+        if (typeof contents === "string") {
+            this.contents = contents;
+        }
+        else {
+            this.contents = contents.properties[0];
+        }
+    }
+}
+exports.CustomerListOption = CustomerListOption;

package/lib/Actions/SaleKey.d.ts

@@ -0,0 +1,8 @@
+import { BaseAction } from "./BaseAction";
+import { Serialized } from "../Common/Serializable";
+export declare class SaleKey extends BaseAction<SaleKey> {
+    protected supportedEvents: string[];
+    protected id: string;
+    protected name: string;
+    constructor(id: Serialized<SaleKey> | string, name?: string);
+}

package/lib/Actions/SaleKey.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaleKey = void 0;
+const BaseAction_1 = require("./BaseAction");
+class SaleKey extends BaseAction_1.BaseAction {
+    constructor(id, name) {
+        // https://github.com/Microsoft/TypeScript/issues/8277
+        super((() => {
+            if (typeof id === "string") {
+                return {
+                    properties: [id, name],
+                    events: {},
+                    type: "Button"
+                };
+            }
+            else {
+                return id;
+            }
+        })(), SaleKey);
+        this.supportedEvents = ["click"];
+        if (typeof name === "undefined" && typeof id !== "string") {
+            id = id;
+            this.id = id.properties[0];
+            this.name = id.properties[1];
+        }
+        else {
+            this.id = id;
+            if (typeof name === "undefined") {
+                this.name = "";
+            }
+            else {
+                this.name = name;
+            }
+        }
+    }
+}
+exports.SaleKey = SaleKey;

package/lib/Actions/SaleUpdate.d.ts

@@ -8,6 +8,7 @@ export interface SaleUpdateChanges {
         price?: number;
         consolidate?: boolean;
         indexAddress?: Array<number>;
+        metaData: Record<string, unknown>;
     };
     PRODUCT_REMOVE: {
         id: string;
@@ -41,6 +42,11 @@ export interface SaleUpdateChanges {
     SALE_ORDER_REFERENCE: {
         reference: string;
     };
+    PRODUCT_UPDATE: {
+        id: string;
+        indexAddress: Array<number>;
+        metaData: Record<string, unknown>;
+    };
 }
 export declare class SaleUpdate<K extends keyof SaleUpdateChanges> extends BaseAction<SaleUpdate<K>> {
     protected supportedEvents: never[];

package/lib/Application.d.ts

@@ -1,9 +1,10 @@
 import { Bridge } from "./Bridge";
-import { DirectShopfrontEvent, FromShopfront, FromShopfrontInternal, RegisterChangedEvent } from "./ApplicationEvents";
+import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, RegisterChangedEvent } from "./ApplicationEvents";
 import { Serializable } from "./Common/Serializable";
 import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent";
 import { Sale } from "./APIs/CurrentSale";
 import { Database } from "./APIs/Database/Database";
+import { MaybePromise } from "./Utilities/MiscTypes";
 export declare class Application {
     protected bridge: Bridge;
     protected isReady: boolean;
@@ -15,18 +16,20 @@ export declare class Application {
         [key in keyof Omit<FromShopfront, "CALLBACK">]: Map<Function, FromShopfront[key]>;
     };
     protected directListeners: {
-        [K in DirectShopfrontEvent]?: Set<() => void | Promise<void>>;
+        [K in DirectShopfrontEvent]?: Set<(data: unknown) => void | Promise<void>>;
     };
     database: Database;
     constructor(bridge: Bridge);
     destroy(): void;
     protected handleEvent: (event: keyof FromShopfront | keyof FromShopfrontInternal, data: any, id: string) => void;
-    protected emit(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, data: any, id: string): void | Promise<void>;
-    addEventListener(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, callback: Function): void;
-    removeEventListener(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, callback: () => void): void;
+    protected emit(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, data: any, id: string): MaybePromise<void>;
+    addEventListener<E extends keyof FromShopfrontCallbacks>(event: E, callback: FromShopfrontCallbacks[E]): void;
+    addEventListener<D>(event: DirectShopfrontEvent, callback: (event: D) => MaybePromise<void>): void;
+    removeEventListener(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, callback: (...args: Array<any>) => MaybePromise<any>): void;
     send(item: BaseEmitableEvent<any>): void;
     send(item: Serializable<any>): void;
     download(file: string): void;
+    redirect(toLocation: string, externalRedirect?: boolean): void;
     load(): () => void;
     protected handleEventCallback(data: {
         id?: string;
@@ -49,4 +52,6 @@ export declare class Application {
         outlet: string | null;
         user: string | null;
     }>;
+    printReceipt(content: string): void;
+    getOption<TValueType>(option: string, defaultValue: TValueType): Promise<TValueType>;
 }

package/lib/Application.js

@@ -17,6 +17,11 @@ 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");
+const FormatIntegratedProduct_1 = require("./Events/FormatIntegratedProduct");
+const RequestCustomerListOptions_1 = require("./Events/RequestCustomerListOptions");
+const RequestSaleKeys_1 = require("./Events/RequestSaleKeys");
+const SaleComplete_1 = require("./Events/SaleComplete");
+// noinspection JSUnusedGlobalSymbols
 class Application {
     constructor(bridge) {
         this.listeners = {
@@ -27,6 +32,10 @@ class Application {
             REQUEST_SELL_SCREEN_OPTIONS: new Map(),
             INTERNAL_PAGE_MESSAGE: new Map(),
             REGISTER_CHANGED: new Map(),
+            FORMAT_INTEGRATED_PRODUCT: new Map(),
+            REQUEST_CUSTOMER_LIST_OPTIONS: new Map(),
+            REQUEST_SALE_KEYS: new Map(),
+            SALE_COMPLETE: new Map(),
         };
         this.directListeners = {};
         this.handleEvent = (event, data, id) => {
@@ -56,7 +65,8 @@ class Application {
             }
             else if (event === "RESPONSE_CURRENT_SALE" ||
                 event === "RESPONSE_DATABASE_REQUEST" ||
-                event === "RESPONSE_LOCATION") {
+                event === "RESPONSE_LOCATION" ||
+                event === "RESPONSE_OPTION") {
                 // Handled elsewhere
                 return;
             }
@@ -84,7 +94,7 @@ class Application {
             }
             const results = [];
             for (const e of listeners.values()) {
-                results.push(e());
+                results.push(e(data));
             }
             return Promise.all(results)
                 .then(() => {
@@ -128,6 +138,20 @@ class Application {
                     .then((res) => {
                     return RequestSellScreenOptions_1.RequestSellScreenOptions.respond(this.bridge, res.flat(), id);
                 });
+            case "FORMAT_INTEGRATED_PRODUCT":
+                results = results;
+                return Promise.all(results)
+                    .then((res) => {
+                    return FormatIntegratedProduct_1.FormatIntegratedProduct.respond(this.bridge, res.flat(), id);
+                });
+            case "REQUEST_CUSTOMER_LIST_OPTIONS":
+                results = results;
+                return Promise.all(results)
+                    .then(res => RequestCustomerListOptions_1.RequestCustomerListOptions.respond(this.bridge, res.flat(), id));
+            case "REQUEST_SALE_KEYS":
+                results = results;
+                return Promise.all(results)
+                    .then(res => RequestSaleKeys_1.RequestSaleKeys.respond(this.bridge, res.flat(), id));
         }
     }
     addEventListener(event, callback) {
@@ -137,6 +161,7 @@ class Application {
                 this.directListeners[event] = new Set();
             }
             this.directListeners[event].add(callback);
+            return;
         }
         let c = null;
         switch (event) {
@@ -168,6 +193,22 @@ class Application {
                 c = new RegisterChanged_1.RegisterChanged(callback);
                 this.listeners[event].set(callback, c);
                 break;
+            case "REQUEST_CUSTOMER_LIST_OPTIONS":
+                c = new RequestCustomerListOptions_1.RequestCustomerListOptions(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "FORMAT_INTEGRATED_PRODUCT":
+                c = new FormatIntegratedProduct_1.FormatIntegratedProduct(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "REQUEST_SALE_KEYS":
+                c = new RequestSaleKeys_1.RequestSaleKeys(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "SALE_COMPLETE":
+                c = new SaleComplete_1.SaleComplete(callback);
+                this.listeners[event].set(callback, c);
+                break;
         }
         if (c === null) {
             throw new TypeError(`${event} has not been defined`);
@@ -204,6 +245,12 @@ class Application {
     download(file) {
         this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.DOWNLOAD, file);
     }
+    redirect(toLocation, externalRedirect = true) {
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REDIRECT, {
+            to: toLocation,
+            external: externalRedirect,
+        });
+    }
     load() {
         this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.LOAD, true);
         return () => this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.LOAD, false);
@@ -283,5 +330,37 @@ class Application {
             user: location.user,
         };
     }
+    printReceipt(content) {
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.PRINT_RECEIPT, {
+            content,
+            type: "text",
+        });
+    }
+    async getOption(option, defaultValue) {
+        const request = `OptionRequest-${Date.now().toString()}`;
+        const promise = new Promise(res => {
+            const listener = (event, data) => {
+                if (event !== "RESPONSE_OPTION") {
+                    return;
+                }
+                data = data;
+                if (data.requestId !== request) {
+                    return;
+                }
+                this.bridge.removeEventListener(listener);
+                res(data.value);
+            };
+            this.bridge.addEventListener(listener);
+        });
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.GET_OPTION, {
+            requestId: request,
+            option,
+        });
+        const optionValue = await promise;
+        if (typeof optionValue === "undefined") {
+            return defaultValue;
+        }
+        return optionValue;
+    }
 }
 exports.Application = Application;

package/lib/ApplicationEvents.d.ts

@@ -9,6 +9,12 @@ import { ShopfrontSaleState } from "./APIs/CurrentSale/ShopfrontSaleState";
 import { InternalPageMessage } from "./Events/InternalPageMessage";
 import { InternalMessageSource } from "./APIs/InternalMessages/InternalMessageSource";
 import { RegisterChanged } from "./Events/RegisterChanged";
+import { FormatIntegratedProduct, FormattedSaleProduct } from "./Events/FormatIntegratedProduct";
+import { MaybePromise } from "./Utilities/MiscTypes";
+import { RequestCustomerListOptions, SellScreenCustomerListOption } from "./Events/RequestCustomerListOptions";
+import { SaleKey } from "./Actions/SaleKey";
+import { RequestSaleKeys } from "./Events/RequestSaleKeys";
+import { CompletedSale, SaleComplete } from "./Events/SaleComplete";
 export declare enum ToShopfront {
     READY = "READY",
     SERIALIZED = "SERIALIZED",
@@ -23,6 +29,12 @@ export declare enum ToShopfront {
     UNSUPPORTED_EVENT = "UNSUPPORTED_EVENT",
     NOT_LISTENING_TO_EVENT = "NOT_LISTENING_TO_EVENT",
     REQUEST_LOCATION = "REQUEST_LOCATION",
+    RESPONSE_FORMAT_PRODUCT = "RESPONSE_FORMAT_PRODUCT",
+    RESPONSE_CUSTOMER_LIST_OPTIONS = "RESPONSE_CUSTOMER_LIST_OPTIONS",
+    RESPONSE_SALE_KEYS = "RESPONSE_SALE_KEYS",
+    PRINT_RECEIPT = "PRINT_RECEIPT",
+    REDIRECT = "REDIRECT",
+    GET_OPTION = "GET_OPTION",
     SELL_SCREEN_OPTION_CHANGE = "SELL_SCREEN_OPTION_CHANGE",
     INTERNAL_PAGE_MESSAGE = "INTERNAL_PAGE_MESSAGE",
     TABLE_UPDATE = "TABLE_UPDATE"
@@ -64,6 +76,10 @@ export interface FromShopfrontReturns {
         outlet: string | null;
         user: string | null;
     };
+    FORMAT_INTEGRATED_PRODUCT: FormatIntegratedProductEvent;
+    REQUEST_CUSTOMER_LIST_OPTIONS: Array<SellScreenCustomerListOption>;
+    REQUEST_SALE_KEYS: Array<SaleKey>;
+    SALE_COMPLETE: void;
 }
 export interface InternalPageMessageEvent {
     method: "REQUEST_SETTINGS" | "REQUEST_SELL_SCREEN_OPTIONS" | "EXTERNAL_APPLICATION";
@@ -76,15 +92,25 @@ export interface RegisterChangedEvent {
     outlet: null | string;
     user: null | string;
 }
+export interface FormatIntegratedProductEvent {
+    product: FormattedSaleProduct;
+}
+export interface SaleCompletedEvent {
+    sale: CompletedSale;
+}
 export interface FromShopfrontCallbacks {
-    READY: (event: RegisterChangedEvent) => Promise<FromShopfrontReturns["READY"]>;
-    REQUEST_SETTINGS: () => Promise<FromShopfrontReturns["REQUEST_SETTINGS"]>;
-    REQUEST_BUTTONS: () => Promise<FromShopfrontReturns["REQUEST_BUTTONS"]>;
-    REQUEST_TABLE_COLUMNS: () => Promise<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>;
-    REQUEST_SELL_SCREEN_OPTIONS: () => Promise<FromShopfrontReturns["REQUEST_SELL_SCREEN_OPTIONS"]>;
-    INTERNAL_PAGE_MESSAGE: (event: InternalPageMessageEvent) => Promise<FromShopfrontReturns["INTERNAL_PAGE_MESSAGE"]>;
-    REGISTER_CHANGED: (event: RegisterChangedEvent) => Promise<FromShopfrontReturns["REGISTER_CHANGED"]>;
-    CALLBACK: () => Promise<FromShopfrontReturns["CALLBACK"]>;
+    READY: (event: RegisterChangedEvent) => MaybePromise<FromShopfrontReturns["READY"]>;
+    REQUEST_SETTINGS: () => MaybePromise<FromShopfrontReturns["REQUEST_SETTINGS"]>;
+    REQUEST_BUTTONS: () => MaybePromise<FromShopfrontReturns["REQUEST_BUTTONS"]>;
+    REQUEST_TABLE_COLUMNS: () => MaybePromise<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>;
+    REQUEST_SELL_SCREEN_OPTIONS: () => MaybePromise<FromShopfrontReturns["REQUEST_SELL_SCREEN_OPTIONS"]>;
+    INTERNAL_PAGE_MESSAGE: (event: InternalPageMessageEvent) => MaybePromise<FromShopfrontReturns["INTERNAL_PAGE_MESSAGE"]>;
+    REGISTER_CHANGED: (event: RegisterChangedEvent) => MaybePromise<FromShopfrontReturns["REGISTER_CHANGED"]>;
+    CALLBACK: () => MaybePromise<FromShopfrontReturns["CALLBACK"]>;
+    FORMAT_INTEGRATED_PRODUCT: (event: FormatIntegratedProductEvent) => MaybePromise<FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"]>;
+    REQUEST_CUSTOMER_LIST_OPTIONS: () => MaybePromise<FromShopfrontReturns["REQUEST_CUSTOMER_LIST_OPTIONS"]>;
+    REQUEST_SALE_KEYS: () => MaybePromise<FromShopfrontReturns["REQUEST_SALE_KEYS"]>;
+    SALE_COMPLETE: (event: SaleCompletedEvent) => MaybePromise<FromShopfrontReturns["SALE_COMPLETE"]>;
 }
 export interface FromShopfront {
     READY: Ready;
@@ -92,11 +118,15 @@ export interface FromShopfront {
     REQUEST_BUTTONS: RequestButtons;
     REQUEST_TABLE_COLUMNS: RequestTableColumns;
     REQUEST_SELL_SCREEN_OPTIONS: RequestSellScreenOptions;
+    CALLBACK: Callback;
     INTERNAL_PAGE_MESSAGE: InternalPageMessage;
     REGISTER_CHANGED: RegisterChanged;
-    CALLBACK: Callback;
+    FORMAT_INTEGRATED_PRODUCT: FormatIntegratedProduct;
+    REQUEST_CUSTOMER_LIST_OPTIONS: RequestCustomerListOptions;
+    SALE_COMPLETE: SaleComplete;
+    REQUEST_SALE_KEYS: RequestSaleKeys;
 }
-export declare const directShopfrontEvents: readonly ["SALE_ADD_PRODUCT", "SALE_REMOVE_PRODUCT", "SALE_ADD_CUSTOMER", "SALE_REMOVE_CUSTOMER"];
+export declare const directShopfrontEvents: readonly ["SALE_ADD_PRODUCT", "SALE_REMOVE_PRODUCT", "SALE_UPDATE_PRODUCTS", "SALE_CHANGE_QUANTITY", "SALE_ADD_CUSTOMER", "SALE_REMOVE_CUSTOMER", "SALE_CLEAR"];
 export declare type DirectShopfrontEvent = typeof directShopfrontEvents[number];
 export interface FromShopfrontInternal {
     CYCLE_KEY: "CYCLE_KEY";
@@ -104,4 +134,5 @@ export interface FromShopfrontInternal {
     RESPONSE_CURRENT_SALE: "RESPONSE_CURRENT_SALE";
     RESPONSE_DATABASE_REQUEST: "RESPONSE_DATABASE_REQUEST";
     RESPONSE_LOCATION: "RESPONSE_LOCATION";
+    RESPONSE_OPTION: "RESPONSE_OPTION";
 }

package/lib/ApplicationEvents.js

@@ -16,6 +16,12 @@ var ToShopfront;
     ToShopfront["UNSUPPORTED_EVENT"] = "UNSUPPORTED_EVENT";
     ToShopfront["NOT_LISTENING_TO_EVENT"] = "NOT_LISTENING_TO_EVENT";
     ToShopfront["REQUEST_LOCATION"] = "REQUEST_LOCATION";
+    ToShopfront["RESPONSE_FORMAT_PRODUCT"] = "RESPONSE_FORMAT_PRODUCT";
+    ToShopfront["RESPONSE_CUSTOMER_LIST_OPTIONS"] = "RESPONSE_CUSTOMER_LIST_OPTIONS";
+    ToShopfront["RESPONSE_SALE_KEYS"] = "RESPONSE_SALE_KEYS";
+    ToShopfront["PRINT_RECEIPT"] = "PRINT_RECEIPT";
+    ToShopfront["REDIRECT"] = "REDIRECT";
+    ToShopfront["GET_OPTION"] = "GET_OPTION";
     // Emitable Events
     ToShopfront["SELL_SCREEN_OPTION_CHANGE"] = "SELL_SCREEN_OPTION_CHANGE";
     ToShopfront["INTERNAL_PAGE_MESSAGE"] = "INTERNAL_PAGE_MESSAGE";
@@ -27,6 +33,9 @@ var WithinApplication;
 exports.directShopfrontEvents = [
     "SALE_ADD_PRODUCT",
     "SALE_REMOVE_PRODUCT",
+    "SALE_UPDATE_PRODUCTS",
+    "SALE_CHANGE_QUANTITY",
     "SALE_ADD_CUSTOMER",
-    "SALE_REMOVE_CUSTOMER"
+    "SALE_REMOVE_CUSTOMER",
+    "SALE_CLEAR",
 ];

package/lib/Bridge.d.ts

@@ -19,7 +19,7 @@ export declare class Bridge {
     protected registerListeners(): void;
     protected unregisterListeners(): void;
     protected handleMessage: (event: MessageEvent) => void;
-    sendMessage(type: ApplicationEvents.ToShopfront, data?: {} | null, id?: string): void;
+    sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
     addEventListener(listener: ApplicationEventListener): void;
     removeEventListener(listener: ApplicationEventListener): void;
 }

package/lib/Events/FormatIntegratedProduct.d.ts

@@ -0,0 +1,72 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+import { Bridge } from "../Bridge";
+export declare type FormattedSaleProductType = "Normal" | "Product" | "GiftCard" | "Voucher" | "Basket" | "Package" | "Component" | "Integrated";
+export interface SaleGiftCard {
+    code: string;
+    amount: number;
+    expiry: string;
+}
+export interface FormattedSaleProduct {
+    uuid: string;
+    type: FormattedSaleProductType;
+    name: string;
+    caseQuantity: number;
+    isCase: boolean;
+    quantity: number;
+    loyalty: {
+        earn: number;
+        redeem: number;
+    };
+    prices: {
+        price: number;
+        unlockedPrice: number;
+        normal: number;
+        base: number;
+        addPrice: number;
+        removePrice: number;
+        additionalPrice: number;
+    };
+    tax: {
+        id: false | string;
+        amount: number;
+    };
+    products: Array<FormattedSaleProduct>;
+    defaultProducts: Array<FormattedSaleProduct>;
+    special: boolean;
+    edited: boolean;
+    promotions: {
+        [id: string]: {
+            name: string;
+            active: boolean;
+            quantity: number;
+        };
+    };
+    rebates: {
+        [id: string]: {
+            amount: number;
+            quantity: number;
+        };
+    };
+    giftCard: SaleGiftCard | null;
+    note: string;
+    userId: null | string;
+    priceSet?: string;
+    deleted?: boolean;
+    initiallyDeleted?: boolean;
+    familyId: string | null;
+    canUnlock: boolean;
+    discountReason?: string;
+    requestPrice?: boolean;
+    lockQuantity: boolean;
+    metaData: {
+        [key: string]: any;
+    };
+}
+export declare class FormatIntegratedProduct extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["FORMAT_INTEGRATED_PRODUCT"]);
+    emit(data: {
+        product: FormattedSaleProduct;
+    }): Promise<FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"]>;
+    static respond(bridge: Bridge, data: Array<FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"]>, id: string): Promise<void>;
+}

package/lib/Events/FormatIntegratedProduct.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormatIntegratedProduct = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+const ApplicationEvents_1 = require("../ApplicationEvents");
+class FormatIntegratedProduct extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        const result = await Promise.resolve(this.callback(data));
+        if (typeof result !== "object" || result === null) {
+            throw new TypeError("Callback must return an object");
+        }
+        return result;
+    }
+    static async respond(bridge, data, id) {
+        if (data.length > 1) {
+            throw new Error("Multiple integrated product responses found, please ensure you are only subscribed to FORMAT_INTEGRATED_PRODUCT once");
+        }
+        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_FORMAT_PRODUCT, data[0], id);
+    }
+}
+exports.FormatIntegratedProduct = FormatIntegratedProduct;

package/lib/Events/RequestCustomerListOptions.d.ts

@@ -0,0 +1,12 @@
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+import { Bridge } from "..";
+import { BaseEvent } from "./BaseEvent";
+export interface SellScreenCustomerListOption {
+    contents: string;
+    onClick: () => void;
+}
+export declare class RequestCustomerListOptions extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["REQUEST_CUSTOMER_LIST_OPTIONS"]);
+    emit(data: {}): Promise<FromShopfrontReturns["REQUEST_CUSTOMER_LIST_OPTIONS"]>;
+    static respond(bridge: Bridge, options: Array<SellScreenCustomerListOption>, id: string): Promise<void>;
+}

package/lib/Events/RequestCustomerListOptions.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestCustomerListOptions = void 0;
+const ApplicationEvents_1 = require("../ApplicationEvents");
+const BaseEvent_1 = require("./BaseEvent");
+const CustomerListOption_1 = require("../Actions/CustomerListOption");
+class RequestCustomerListOptions extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        let result = await Promise.resolve(this.callback());
+        if (!Array.isArray(result)) {
+            result = [result];
+        }
+        for (let i = 0, l = result.length; i < l; i++) {
+            if (!result[i].contents || !result[i].onClick) {
+                throw new TypeError("You must specify both the contents and an onClick callback");
+            }
+        }
+        return result;
+    }
+    static async respond(bridge, options, id) {
+        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_CUSTOMER_LIST_OPTIONS, options.map(option => {
+            const o = new CustomerListOption_1.CustomerListOption(option.contents);
+            o.addEventListener("click", option.onClick);
+            return o.serialize();
+        }), id);
+    }
+}
+exports.RequestCustomerListOptions = RequestCustomerListOptions;

package/lib/Events/RequestSaleKeys.d.ts

@@ -0,0 +1,9 @@
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+import { Bridge } from "..";
+import { BaseEvent } from "./BaseEvent";
+import { SaleKey } from "../Actions/SaleKey";
+export declare class RequestSaleKeys extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["REQUEST_SALE_KEYS"]);
+    emit(): Promise<FromShopfrontReturns["REQUEST_SALE_KEYS"]>;
+    static respond(bridge: Bridge, keys: Array<SaleKey>, id: string): Promise<void>;
+}

package/lib/Events/RequestSaleKeys.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestSaleKeys = void 0;
+const ApplicationEvents_1 = require("../ApplicationEvents");
+const BaseEvent_1 = require("./BaseEvent");
+const SaleKey_1 = require("../Actions/SaleKey");
+class RequestSaleKeys extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit() {
+        let result = await Promise.resolve(this.callback());
+        if (!Array.isArray(result)) {
+            result = [result];
+        }
+        for (let i = 0, l = result.length; i < l; i++) {
+            if (!(result[i] instanceof SaleKey_1.SaleKey)) {
+                throw new TypeError("You must return an instance of SaleKey");
+            }
+        }
+        return result;
+    }
+    static async respond(bridge, keys, id) {
+        let response = [];
+        for (let i = 0, l = keys.length; i < l; i++) {
+            if (!(keys[i] instanceof SaleKey_1.SaleKey)) {
+                throw new TypeError("Invalid response returned, expected SaleKey");
+            }
+            response.push(keys[i].serialize());
+        }
+        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_SALE_KEYS, response, id);
+    }
+}
+exports.RequestSaleKeys = RequestSaleKeys;

package/lib/Events/SaleComplete.d.ts

@@ -0,0 +1,112 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+interface CompletedSaleProduct {
+    uuid: string;
+    type: "Normal" | "Product" | "GiftCard" | "Voucher" | "Basket" | "Package" | "Component" | "Integrated";
+    name: string;
+    caseQuantity: number;
+    isCase: boolean;
+    quantity: number;
+    loyalty: {
+        earn: number;
+        redeem: number;
+    };
+    prices: {
+        price: number;
+        unlockedPrice: number;
+        normal: number;
+        base: number;
+        addPrice: number;
+        removePrice: number;
+        additionalPrice: number;
+    };
+    tax: {
+        id: false | string;
+        amount: number;
+    };
+    products: Array<CompletedSaleProduct>;
+    defaultProducts: Array<CompletedSaleProduct>;
+    special: boolean;
+    edited: boolean;
+    promotions: {
+        [id: string]: {
+            name: string;
+            active: boolean;
+            quantity: number;
+        };
+    };
+    rebates: {
+        [id: string]: {
+            amount: number;
+            quantity: number;
+        };
+    };
+    giftCard: {
+        code: string;
+        amount: number;
+        expiry: string;
+    } | null;
+    note: string;
+    userId: null | string;
+    priceSet?: string;
+    deleted?: boolean;
+    initiallyDeleted?: boolean;
+    familyId: string | null;
+    canUnlock: boolean;
+    discountReason?: string;
+    requestPrice?: boolean;
+    lockQuantity: boolean;
+    metaData: {
+        [key: string]: any;
+    };
+}
+interface CompletedSalePayment {
+    method: string;
+    type: string;
+    status: "approved" | "cancelled" | "declined" | "completed" | "failed";
+    amount: number;
+    cashout: number;
+    rounding: number | undefined;
+    metadata: string;
+    registerId: string;
+    userId?: string;
+    processTime?: string;
+    receipt?: string;
+    reverted: boolean;
+    uploaded?: boolean;
+    voucherRefund?: boolean;
+}
+export interface CompletedSale {
+    products: Array<CompletedSaleProduct>;
+    customer: false | {
+        uuid: string;
+    };
+    payments: Array<CompletedSalePayment>;
+    notes: {
+        internal: string;
+        sale: string;
+    };
+    totals: {
+        sale: number;
+        remaining: number;
+        paid: number;
+        savings: number;
+        discount: number;
+        change: number;
+        cashout: number;
+        rounding: number;
+    };
+    registerId: string;
+    userId: string;
+    orderReference: string;
+    refundReason: string;
+    status: "COMPLETED";
+    id: string;
+    invoiceId: string;
+    createdAt: string;
+}
+export declare class SaleComplete extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["SALE_COMPLETE"]);
+    emit(data: CompletedSale): Promise<FromShopfrontReturns["SALE_COMPLETE"]>;
+}
+export {};

package/lib/Events/SaleComplete.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaleComplete = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+class SaleComplete extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        this.callback(data);
+    }
+}
+exports.SaleComplete = SaleComplete;

package/lib/Utilities/MiscTypes.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A property which might be a promise or the promise's wrapped type
+ */
+export declare type MaybePromise<P> = P | Promise<P>;

package/lib/Utilities/MiscTypes.js

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

package/lib/index.d.ts

@@ -3,6 +3,9 @@ export { Button } from "./Actions/Button";
 export { Redirect } from "./Actions/Redirect";
 export { Toast } from "./Actions/Toast";
 export { Dialog } from "./Actions/Dialog";
+export { SaleKey } from "./Actions/SaleKey";
 export { SellScreenOption } from "./EmitableEvents/SellScreenOption";
 export { TableUpdate } from "./EmitableEvents/TableUpdate";
+export { CompletedSale } from "./Events/SaleComplete";
+export { Application } from "./Application";
 export * as Sales from "./APIs/CurrentSale/index";

package/lib/index.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sales = exports.TableUpdate = exports.SellScreenOption = exports.Dialog = exports.Toast = exports.Redirect = exports.Button = exports.Bridge = void 0;
+exports.Sales = exports.Application = exports.TableUpdate = exports.SellScreenOption = exports.SaleKey = exports.Dialog = exports.Toast = exports.Redirect = exports.Button = exports.Bridge = void 0;
 var Bridge_1 = require("./Bridge");
 Object.defineProperty(exports, "Bridge", { enumerable: true, get: function () { return Bridge_1.Bridge; } });
 var Button_1 = require("./Actions/Button");
@@ -30,8 +30,12 @@ var Toast_1 = require("./Actions/Toast");
 Object.defineProperty(exports, "Toast", { enumerable: true, get: function () { return Toast_1.Toast; } });
 var Dialog_1 = require("./Actions/Dialog");
 Object.defineProperty(exports, "Dialog", { enumerable: true, get: function () { return Dialog_1.Dialog; } });
+var SaleKey_1 = require("./Actions/SaleKey");
+Object.defineProperty(exports, "SaleKey", { enumerable: true, get: function () { return SaleKey_1.SaleKey; } });
 var SellScreenOption_1 = require("./EmitableEvents/SellScreenOption");
 Object.defineProperty(exports, "SellScreenOption", { enumerable: true, get: function () { return SellScreenOption_1.SellScreenOption; } });
 var TableUpdate_1 = require("./EmitableEvents/TableUpdate");
 Object.defineProperty(exports, "TableUpdate", { enumerable: true, get: function () { return TableUpdate_1.TableUpdate; } });
+var Application_1 = require("./Application");
+Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return Application_1.Application; } });
 exports.Sales = __importStar(require("./APIs/CurrentSale/index"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopfront/bridge",
-  "version": "1.6.0",
+  "version": "1.10.0",
   "main": "./lib/index.js",
   "license": "ISC",
   "description": "The bridge used to embed your application within Shopfront",

package/yarn.lock

@@ -1,8 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-
-typescript@^4.1.2:
-  version "4.1.2"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.2.tgz#6369ef22516fe5e10304aae5a5c4862db55380e9"
-  integrity sha512-thGloWsGH3SOxv1SoY7QojKi0tc+8FnOmiarEGMbd/lar7QOEd3hvlx3Fp5y6FlDUGl9L+pd4n2e+oToGMmhRQ==