@shopfront/bridge 1.18.2 → 1.18.4

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";
@@ -18,8 +18,14 @@ export interface ShopfrontEmbeddedVerificationToken {
         loaded: string;
     };
 }
+export interface ShopfrontEmbeddedTokenError {
+    error: boolean;
+    type: string;
+}
 export declare class ShopfrontTokenDecodingError extends Error {
 }
+export declare class ShopfrontTokenRequestError extends Error {
+}
 export declare class Application {
     protected bridge: Bridge;
     protected isReady: boolean;
@@ -94,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;
@@ -139,6 +147,7 @@ export declare class Application {
     };
     protected generateSigningKey(): Promise<void>;
     protected decodeToken(signature: BufferSource, data: BufferSource, returnTokenObject?: boolean): Promise<ShopfrontEmbeddedVerificationToken | string>;
+    protected tokenDataContainsErrors(data: unknown): data is ShopfrontEmbeddedTokenError;
     getToken(returnTokenObject: true): Promise<ShopfrontEmbeddedVerificationToken>;
     getToken(returnTokenObject?: false): Promise<string>;
 }

package/lib/Application.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = exports.ShopfrontTokenDecodingError = void 0;
+exports.Application = exports.ShopfrontTokenRequestError = exports.ShopfrontTokenDecodingError = void 0;
 const ApplicationEvents_1 = require("./ApplicationEvents");
 const Ready_1 = require("./Events/Ready");
 const Button_1 = require("./Actions/Button");
@@ -31,9 +31,13 @@ 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;
+class ShopfrontTokenRequestError extends Error {
+}
+exports.ShopfrontTokenRequestError = ShopfrontTokenRequestError;
 // noinspection JSUnusedGlobalSymbols
 class Application {
     constructor(bridge) {
@@ -52,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(),
@@ -263,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);
@@ -470,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" ||
@@ -595,6 +614,12 @@ class Application {
         }
         return decoded.auth;
     }
+    tokenDataContainsErrors(data) {
+        if (!data || typeof data !== "object") {
+            return false;
+        }
+        return "error" in data && "type" in data;
+    }
     async getToken(returnTokenObject) {
         await this.generateSigningKey();
         const request = `TokenRequest-${Date.now().toString()}`;
@@ -617,7 +642,12 @@ class Application {
         this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REQUEST_SECURE_KEY, {
             requestId: request,
         });
-        return this.decodeToken(...(await promise), returnTokenObject);
+        const [signature, data] = await promise;
+        // Throw the error if there is one
+        if (this.tokenDataContainsErrors(data)) {
+            throw new ShopfrontTokenRequestError(data.type);
+        }
+        return this.decodeToken(signature, data, returnTokenObject);
     }
 }
 exports.Application = Application;

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;