@shopfront/bridge 1.18.3 → 1.20.0

package/.idea/git_toolbox_prj.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GitToolBoxProjectSettings">
+    <option name="commitMessageIssueKeyValidationOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+    <option name="commitMessageValidationEnabledOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+  </component>
+</project>

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

@@ -1,4 +1,4 @@
-import { ShopfrontSaleProduct, ShopfrontSaleProductType } from "./ShopfrontSaleState";
+import { ShopfrontSaleProduct, ShopfrontSaleProductPromotions, ShopfrontSaleProductType } from "./ShopfrontSaleState";
 export declare class SaleProduct {
     readonly internalId: string;
     protected id: string;
@@ -12,6 +12,7 @@ export declare class SaleProduct {
     protected contains: Array<SaleProduct>;
     protected edited: boolean;
     protected caseQuantity?: number;
+    protected promotions: ShopfrontSaleProductPromotions;
     protected metaData: Record<string, unknown>;
     protected mapped?: string;
     constructor(id: string, quantity: number, price?: number, indexAddress?: Array<number>);
@@ -114,6 +115,12 @@ export declare class SaleProduct {
      * @returns {number | undefined}
      */
     getCaseQuantity(): number | undefined;
+    /**
+     * Get the promotions for the product.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getPromotions(): ShopfrontSaleProductPromotions;
     /**
      * Get the meta data for the product.
      *

package/lib/APIs/Sale/SaleProduct.js

@@ -7,6 +7,7 @@ exports.SaleProduct = void 0;
 const UUID_1 = __importDefault(require("../../Utilities/UUID"));
 class SaleProduct {
     constructor(id, quantity, price, indexAddress) {
+        this.promotions = {};
         this.metaData = {};
         this.internalId = UUID_1.default.generate();
         this.id = id;
@@ -55,6 +56,7 @@ class SaleProduct {
         this.note = data.note;
         this.edited = data.edited;
         this.caseQuantity = data.caseQuantity;
+        this.promotions = data.promotions;
         this.metaData = data.metaData;
         this.mapped = data.mapped;
         for (let i = 0, l = data.products.length; i < l; i++) {
@@ -161,6 +163,14 @@ class SaleProduct {
     getCaseQuantity() {
         return this.caseQuantity;
     }
+    /**
+     * Get the promotions for the product.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getPromotions() {
+        return this.promotions;
+    }
     /**
      * Get the meta data for the product.
      *

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

@@ -1,5 +1,12 @@
 export declare type ShopfrontSalePaymentStatus = "completed" | "cancelled" | "failed";
 export declare type ShopfrontSaleProductType = "Normal" | "Basket" | "Package" | "Component" | "Voucher";
+export interface ShopfrontSaleProductPromotions {
+    [id: string]: {
+        name: string;
+        active: boolean;
+        quantity: number;
+    };
+}
 export interface ShopfrontSaleProduct {
     uuid: string;
     type: ShopfrontSaleProductType;
@@ -15,6 +22,7 @@ export interface ShopfrontSaleProduct {
     };
     note: string;
     products: Array<ShopfrontSaleProduct>;
+    promotions: ShopfrontSaleProductPromotions;
     edited: boolean;
     caseQuantity: number;
     metaData: Record<string, unknown>;

package/lib/Application.d.ts

@@ -1,5 +1,5 @@
 import { Bridge } from "./Bridge";
-import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, RegisterChangedEvent, SoundEvents } from "./ApplicationEvents";
+import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, RegisterChangedEvent, SellScreenActionMode, SellScreenSummaryMode, SoundEvents } from "./ApplicationEvents";
 import { Serializable } from "./Common/Serializable";
 import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent";
 import { ShopfrontSaleState } from "./APIs/Sale";
@@ -100,6 +100,8 @@ export declare class Application {
         user: string | null;
     }>;
     printReceipt(content: string): void;
+    changeSellScreenActionMode(mode: SellScreenActionMode): void;
+    changeSellScreenSummaryMode(mode: SellScreenSummaryMode): void;
     protected dataIsAudioResponse(data: Record<string, unknown>): data is {
         requestId: string;
         success: boolean;

package/lib/Application.js

@@ -31,6 +31,7 @@ const FulfilmentCollectOrder_1 = require("./Events/FulfilmentCollectOrder");
 const FulfilmentCompleteOrder_1 = require("./Events/FulfilmentCompleteOrder");
 const CurrentSale_1 = require("./APIs/Sale/CurrentSale");
 const SaleCreate_1 = require("./Utilities/SaleCreate");
+const AudioReady_1 = require("./Events/AudioReady");
 class ShopfrontTokenDecodingError extends Error {
 }
 exports.ShopfrontTokenDecodingError = ShopfrontTokenDecodingError;
@@ -55,6 +56,7 @@ class Application {
             UI_PIPELINE: new Map(),
             PAYMENT_METHODS_ENABLED: new Map(),
             AUDIO_PERMISSION_CHANGE: new Map(),
+            AUDIO_READY: new Map(),
             FULFILMENT_GET_ORDER: new Map(),
             FULFILMENT_PROCESS_ORDER: new Map(),
             FULFILMENT_VOID_ORDER: new Map(),
@@ -266,6 +268,10 @@ class Application {
                 c = new PaymentMethodsEnabled_1.PaymentMethodsEnabled(callback);
                 this.listeners[event].set(callback, c);
                 break;
+            case "AUDIO_READY":
+                c = new AudioReady_1.AudioReady(callback);
+                this.listeners[event].set(callback, c);
+                break;
             case "AUDIO_PERMISSION_CHANGE":
                 c = new AudioPermissionChange_1.AudioPermissionChange(callback);
                 this.listeners[event].set(callback, c);
@@ -473,6 +479,16 @@ class Application {
             type: "text",
         });
     }
+    changeSellScreenActionMode(mode) {
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.CHANGE_SELL_SCREEN_ACTION_MODE, {
+            mode
+        });
+    }
+    changeSellScreenSummaryMode(mode) {
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.CHANGE_SELL_SCREEN_SUMMARY_MODE, {
+            mode
+        });
+    }
     dataIsAudioResponse(data) {
         return typeof data.requestId === "string" &&
             typeof data.success === "boolean" && (typeof data.message === "string" ||

package/lib/ApplicationEvents.d.ts

@@ -26,6 +26,7 @@ import { OrderDetails } from "./APIs/Fulfilment/FulfilmentTypes";
 import { FulfilmentCollectOrder } from "./Events/FulfilmentCollectOrder";
 import { FulfilmentCompleteOrder } from "./Events/FulfilmentCompleteOrder";
 import { Sale } from "./APIs/Sale";
+import { AudioReady } from "./Events/AudioReady";
 export declare enum ToShopfront {
     READY = "READY",
     SERIALIZED = "SERIALIZED",
@@ -52,6 +53,8 @@ export declare enum ToShopfront {
     AUDIO_REQUEST_PERMISSION = "AUDIO_REQUEST_PERMISSION",
     AUDIO_PRELOAD = "AUDIO_PRELOAD",
     AUDIO_PLAY = "AUDIO_PLAY",
+    CHANGE_SELL_SCREEN_ACTION_MODE = "CHANGE_SELL_SCREEN_ACTION_MODE",
+    CHANGE_SELL_SCREEN_SUMMARY_MODE = "CHANGE_SELL_SCREEN_SUMMARY_MODE",
     SELL_SCREEN_OPTION_CHANGE = "SELL_SCREEN_OPTION_CHANGE",
     INTERNAL_PAGE_MESSAGE = "INTERNAL_PAGE_MESSAGE",
     TABLE_UPDATE = "TABLE_UPDATE",
@@ -113,6 +116,7 @@ export interface FromShopfrontReturns {
     SALE_COMPLETE: void;
     UI_PIPELINE: Array<UIPipelineResponse>;
     PAYMENT_METHODS_ENABLED: Array<SellScreenPaymentMethod>;
+    AUDIO_READY: void;
     AUDIO_PERMISSION_CHANGE: void;
     FULFILMENT_GET_ORDER: OrderDetails;
     FULFILMENT_VOID_ORDER: void;
@@ -193,6 +197,7 @@ export interface FromShopfrontCallbacks {
     SALE_COMPLETE: (event: SaleCompletedEvent) => MaybePromise<FromShopfrontReturns["SALE_COMPLETE"]>;
     UI_PIPELINE: (event: Array<UIPipelineResponse>, context: UIPipelineContext) => MaybePromise<FromShopfrontReturns["UI_PIPELINE"]>;
     PAYMENT_METHODS_ENABLED: (event: Array<SellScreenPaymentMethod>, context: PaymentMethodEnabledContext) => MaybePromise<FromShopfrontReturns["PAYMENT_METHODS_ENABLED"]>;
+    AUDIO_READY: () => MaybePromise<FromShopfrontReturns["AUDIO_READY"]>;
     AUDIO_PERMISSION_CHANGE: (event: AudioPermissionChangeEvent) => MaybePromise<FromShopfrontReturns["AUDIO_PERMISSION_CHANGE"]>;
     FULFILMENT_GET_ORDER: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_GET_ORDER"]>;
     FULFILMENT_VOID_ORDER: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_VOID_ORDER"]>;
@@ -216,6 +221,7 @@ export interface FromShopfront {
     REQUEST_SALE_KEYS: RequestSaleKeys;
     UI_PIPELINE: UIPipeline;
     PAYMENT_METHODS_ENABLED: PaymentMethodsEnabled;
+    AUDIO_READY: AudioReady;
     AUDIO_PERMISSION_CHANGE: AudioPermissionChange;
     FULFILMENT_GET_ORDER: FulfilmentGetOrder;
     FULFILMENT_VOID_ORDER: FulfilmentVoidOrder;
@@ -237,3 +243,5 @@ export interface FromShopfrontInternal {
     RESPONSE_SECURE_KEY: "RESPONSE_SECURE_KEY";
     RESPONSE_CREATE_SALE: "RESPONSE_CREATE_SALE";
 }
+export declare type SellScreenActionMode = "search" | "keys" | "held-sales" | "payment" | "customers" | "promotions" | "show-backorders" | "fulfilment-orders";
+export declare type SellScreenSummaryMode = "transaction" | "payments" | "receipts";

package/lib/ApplicationEvents.js

@@ -29,6 +29,9 @@ var ToShopfront;
     ToShopfront["AUDIO_REQUEST_PERMISSION"] = "AUDIO_REQUEST_PERMISSION";
     ToShopfront["AUDIO_PRELOAD"] = "AUDIO_PRELOAD";
     ToShopfront["AUDIO_PLAY"] = "AUDIO_PLAY";
+    // Sell Screen Events
+    ToShopfront["CHANGE_SELL_SCREEN_ACTION_MODE"] = "CHANGE_SELL_SCREEN_ACTION_MODE";
+    ToShopfront["CHANGE_SELL_SCREEN_SUMMARY_MODE"] = "CHANGE_SELL_SCREEN_SUMMARY_MODE";
     // Emitable Events
     ToShopfront["SELL_SCREEN_OPTION_CHANGE"] = "SELL_SCREEN_OPTION_CHANGE";
     ToShopfront["INTERNAL_PAGE_MESSAGE"] = "INTERNAL_PAGE_MESSAGE";

package/lib/Events/AudioReady.d.ts

@@ -0,0 +1,6 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+export declare class AudioReady extends BaseEvent<undefined> {
+    constructor(callback: FromShopfrontCallbacks["AUDIO_READY"]);
+    emit(): Promise<FromShopfrontReturns["AUDIO_READY"]>;
+}

package/lib/Events/AudioReady.js

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

package/package.json

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