@shopfront/bridge 2.0.0 → 2.0.2

package/lib/Application.js

@@ -1,74 +1,45 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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");
-const RequestSettings_1 = require("./Events/RequestSettings");
-const RequestButtons_1 = require("./Events/RequestButtons");
-const ActionEventRegistrar_1 = __importDefault(require("./Utilities/ActionEventRegistrar"));
-const RequestTableColumns_1 = require("./Events/RequestTableColumns");
-const RequestSellScreenOptions_1 = require("./Events/RequestSellScreenOptions");
-const BaseEmitableEvent_1 = require("./EmitableEvents/BaseEmitableEvent");
-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");
-const UIPipeline_1 = require("./Events/UIPipeline");
-const PaymentMethodsEnabled_1 = require("./Events/PaymentMethodsEnabled");
-const AudioPermissionChange_1 = require("./Events/AudioPermissionChange");
-const FulfilmentGetOrder_1 = require("./Events/FulfilmentGetOrder");
-const FulfilmentVoidOrder_1 = require("./Events/FulfilmentVoidOrder");
-const FulfilmentProcessOrder_1 = require("./Events/FulfilmentProcessOrder");
-const FulfilmentOrderApproval_1 = require("./Events/FulfilmentOrderApproval");
-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 {
+import { Button } from "./Actions/Button.js";
+import { Database } from "./APIs/Database/Database.js";
+import { CurrentSale } from "./APIs/Sale/CurrentSale.js";
+import { isDirectShopfrontEvent, ToShopfront, } from "./ApplicationEvents.js";
+import { BaseApplication, ShopfrontTokenDecodingError, ShopfrontTokenRequestError, } from "./BaseApplication.js";
+import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent.js";
+import { AudioPermissionChange } from "./Events/AudioPermissionChange.js";
+import { AudioReady } from "./Events/AudioReady.js";
+import { FormatIntegratedProduct } from "./Events/FormatIntegratedProduct.js";
+import { FulfilmentCollectOrder } from "./Events/FulfilmentCollectOrder.js";
+import { FulfilmentCompleteOrder } from "./Events/FulfilmentCompleteOrder.js";
+import { FulfilmentGetOrder } from "./Events/FulfilmentGetOrder.js";
+import { FulfilmentOrderApproval } from "./Events/FulfilmentOrderApproval.js";
+import { FulfilmentProcessOrder } from "./Events/FulfilmentProcessOrder.js";
+import { FulfilmentVoidOrder } from "./Events/FulfilmentVoidOrder.js";
+import { GiftCardCodeCheck } from "./Events/GiftCardCodeCheck.js";
+import { InternalPageMessage } from "./Events/InternalPageMessage.js";
+import { PaymentMethodsEnabled } from "./Events/PaymentMethodsEnabled.js";
+import { Ready } from "./Events/Ready.js";
+import { RegisterChanged } from "./Events/RegisterChanged.js";
+import { RequestButtons } from "./Events/RequestButtons.js";
+import { RequestCustomerListOptions } from "./Events/RequestCustomerListOptions.js";
+import { RequestSaleKeys } from "./Events/RequestSaleKeys.js";
+import { RequestSellScreenOptions } from "./Events/RequestSellScreenOptions.js";
+import { RequestSettings } from "./Events/RequestSettings.js";
+import { RequestTableColumns } from "./Events/RequestTableColumns.js";
+import { SaleComplete } from "./Events/SaleComplete.js";
+import { UIPipeline } from "./Events/UIPipeline.js";
+import ActionEventRegistrar from "./Utilities/ActionEventRegistrar.js";
+import { buildSaleData } from "./Utilities/SaleCreate.js";
+export class Application extends BaseApplication {
     constructor(bridge) {
-        this.listeners = {
-            READY: new Map(),
-            REQUEST_SETTINGS: new Map(),
-            REQUEST_BUTTONS: new Map(),
-            REQUEST_TABLE_COLUMNS: new Map(),
-            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(),
-            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(),
-            FULFILMENT_ORDER_APPROVAL: new Map(),
-            FULFILMENT_ORDER_COLLECTED: new Map(),
-            FULFILMENT_ORDER_COMPLETED: new Map(),
-        };
-        this.directListeners = {};
+        super(bridge, new Database(bridge));
+        /**
+         * Handles an application event
+         */
         this.handleEvent = (event, data, id) => {
             if (event === "READY") {
                 this.isReady = true;
                 this.key = data.key;
+                this.outlet = data.outlet;
+                this.register = data.register;
                 data = {
                     outlet: data.outlet,
                     register: data.register,
@@ -87,7 +58,7 @@ class Application {
             }
             else if (event === "LOCATION_CHANGED") {
                 // Unregister all serialized listeners as they're no longer displayed
-                ActionEventRegistrar_1.default.clear();
+                ActionEventRegistrar.clear();
                 return;
             }
             else if (event === "RESPONSE_CURRENT_SALE" ||
@@ -102,42 +73,39 @@ class Application {
             }
             this.emit(event, data, id);
         };
-        this.bridge = bridge;
-        this.isReady = false;
-        this.key = '';
-        this.register = null;
-        this.outlet = null;
-        this.user = null;
-        this.database = new Database_1.Database(this.bridge);
         this.bridge.addEventListener(this.handleEvent);
         this.addEventListener("REGISTER_CHANGED", this.handleLocationChanged);
     }
+    /**
+     * @inheritDoc
+     */
     destroy() {
         this.bridge.destroy();
     }
+    /**
+     * Calls any registered listeners for the received event
+     */
     emit(event, data = {}, id) {
-        if (ApplicationEvents_1.directShopfrontEvents.includes(event)) {
-            event = event;
+        if (isDirectShopfrontEvent(event)) {
             const listeners = this.directListeners[event];
             if (typeof listeners === "undefined") {
-                return this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.NOT_LISTENING_TO_EVENT);
+                return this.bridge.sendMessage(ToShopfront.NOT_LISTENING_TO_EVENT);
             }
             const results = [];
             for (const e of listeners.values()) {
-                results.push(e(data));
+                results.push(e());
             }
             return Promise.all(results)
                 .then(() => {
                 // Ensure void is returned
             });
         }
-        event = event;
         let results = [];
         if (typeof this.listeners[event] === "undefined") {
-            return this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.UNSUPPORTED_EVENT, event, id);
+            return this.bridge.sendMessage(ToShopfront.UNSUPPORTED_EVENT, event, id);
         }
         if (this.listeners[event].size === 0) {
-            return this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.NOT_LISTENING_TO_EVENT, event, id);
+            return this.bridge.sendMessage(ToShopfront.NOT_LISTENING_TO_EVENT, event, id);
         }
         for (const e of this.listeners[event].values()) {
             results.push(e.emit(data, this.bridge));
@@ -148,63 +116,71 @@ class Application {
                 results = results;
                 return Promise.all(results)
                     .then((res) => {
-                    return RequestButtons_1.RequestButtons.respond(this.bridge, res.flat(), id);
+                    return RequestButtons.respond(this.bridge, res.flat(), id);
                 });
             case "REQUEST_SETTINGS":
                 results = results;
                 return Promise.all(results)
                     .then((res) => {
-                    return RequestSettings_1.RequestSettings.respond(this.bridge, res.flat(), id);
+                    return RequestSettings.respond(this.bridge, res.flat(), id);
                 });
             case "REQUEST_TABLE_COLUMNS":
                 results = results;
                 return Promise.all(results)
                     .then((res) => {
-                    return RequestTableColumns_1.RequestTableColumns.respond(this.bridge, res.flat(), id);
+                    return RequestTableColumns.respond(this.bridge, res.flat(), id);
                 });
             case "REQUEST_SELL_SCREEN_OPTIONS":
                 results = results;
                 return Promise.all(results)
                     .then((res) => {
-                    return RequestSellScreenOptions_1.RequestSellScreenOptions.respond(this.bridge, res.flat(), id);
+                    return 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);
+                    return 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));
+                    .then(res => 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));
+                    .then(res => RequestSaleKeys.respond(this.bridge, res.flat(), id));
             case "UI_PIPELINE":
                 results = results;
                 return Promise.all(results)
                     .then(res => {
-                    return UIPipeline_1.UIPipeline.respond(this.bridge, res.flat(), id);
+                    return UIPipeline.respond(this.bridge, res.flat(), id);
+                });
+            case "GIFT_CARD_CODE_CHECK":
+                results = results;
+                return Promise.all(results)
+                    .then(res => {
+                    return GiftCardCodeCheck.respond(this.bridge, res[0], id);
                 });
             case "PAYMENT_METHODS_ENABLED":
                 results = results;
                 return Promise.all(results)
                     .then(res => {
-                    return PaymentMethodsEnabled_1.PaymentMethodsEnabled.respond(this.bridge, res.flat(), id);
+                    return PaymentMethodsEnabled.respond(this.bridge, res.flat(), id);
                 });
             case "FULFILMENT_GET_ORDER":
                 results = results;
                 return Promise.all(results)
                     .then(res => {
-                    return FulfilmentGetOrder_1.FulfilmentGetOrder.respond(this.bridge, res[0], id);
+                    return FulfilmentGetOrder.respond(this.bridge, res[0], id);
                 });
         }
     }
+    /**
+     * @inheritDoc
+     */
     addEventListener(event, callback) {
-        if (ApplicationEvents_1.directShopfrontEvents.includes(event)) {
-            event = event;
+        if (isDirectShopfrontEvent(event)) {
             if (typeof this.directListeners[event] === "undefined") {
                 this.directListeners[event] = new Set();
             }
@@ -214,93 +190,96 @@ class Application {
         }
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         let c;
-        event = event;
         switch (event) {
             case "READY":
-                c = new Ready_1.Ready(callback);
+                c = new Ready(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "REQUEST_SETTINGS":
-                c = new RequestSettings_1.RequestSettings(callback);
+                c = new RequestSettings(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "REQUEST_BUTTONS":
-                c = new RequestButtons_1.RequestButtons(callback);
+                c = new RequestButtons(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "REQUEST_TABLE_COLUMNS":
-                c = new RequestTableColumns_1.RequestTableColumns(callback);
+                c = new RequestTableColumns(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "REQUEST_SELL_SCREEN_OPTIONS":
-                c = new RequestSellScreenOptions_1.RequestSellScreenOptions(callback);
+                c = new RequestSellScreenOptions(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "INTERNAL_PAGE_MESSAGE":
-                c = new InternalPageMessage_1.InternalPageMessage(callback, this);
+                c = new InternalPageMessage(callback, this);
                 this.listeners[event].set(callback, c);
                 break;
             case "REGISTER_CHANGED":
-                c = new RegisterChanged_1.RegisterChanged(callback);
+                c = new RegisterChanged(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "REQUEST_CUSTOMER_LIST_OPTIONS":
-                c = new RequestCustomerListOptions_1.RequestCustomerListOptions(callback);
+                c = new RequestCustomerListOptions(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FORMAT_INTEGRATED_PRODUCT":
-                c = new FormatIntegratedProduct_1.FormatIntegratedProduct(callback);
+                c = new FormatIntegratedProduct(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "REQUEST_SALE_KEYS":
-                c = new RequestSaleKeys_1.RequestSaleKeys(callback);
+                c = new RequestSaleKeys(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "SALE_COMPLETE":
-                c = new SaleComplete_1.SaleComplete(callback);
+                c = new SaleComplete(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "UI_PIPELINE":
-                c = new UIPipeline_1.UIPipeline(callback);
+                c = new UIPipeline(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "PAYMENT_METHODS_ENABLED":
-                c = new PaymentMethodsEnabled_1.PaymentMethodsEnabled(callback);
+                c = new PaymentMethodsEnabled(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "AUDIO_READY":
-                c = new AudioReady_1.AudioReady(callback);
+                c = new AudioReady(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "AUDIO_PERMISSION_CHANGE":
-                c = new AudioPermissionChange_1.AudioPermissionChange(callback);
+                c = new AudioPermissionChange(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FULFILMENT_GET_ORDER":
                 if (this.listeners[event].size !== 0) {
                     throw new TypeError("Application already has 'FULFILMENT_GET_ORDER' event listener registered.");
                 }
-                c = new FulfilmentGetOrder_1.FulfilmentGetOrder(callback);
+                c = new FulfilmentGetOrder(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FULFILMENT_VOID_ORDER":
-                c = new FulfilmentVoidOrder_1.FulfilmentVoidOrder(callback);
+                c = new FulfilmentVoidOrder(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FULFILMENT_PROCESS_ORDER":
-                c = new FulfilmentProcessOrder_1.FulfilmentProcessOrder(callback);
+                c = new FulfilmentProcessOrder(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FULFILMENT_ORDER_APPROVAL":
-                c = new FulfilmentOrderApproval_1.FulfilmentOrderApproval(callback);
+                c = new FulfilmentOrderApproval(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FULFILMENT_ORDER_COLLECTED":
-                c = new FulfilmentCollectOrder_1.FulfilmentCollectOrder(callback);
+                c = new FulfilmentCollectOrder(callback);
                 this.listeners[event].set(callback, c);
                 break;
             case "FULFILMENT_ORDER_COMPLETED":
-                c = new FulfilmentCompleteOrder_1.FulfilmentCompleteOrder(callback);
+                c = new FulfilmentCompleteOrder(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "GIFT_CARD_CODE_CHECK":
+                c = new GiftCardCodeCheck(callback);
                 this.listeners[event].set(callback, c);
                 break;
         }
@@ -316,65 +295,90 @@ class Application {
             });
         }
     }
+    /**
+     * @inheritDoc
+     */
     removeEventListener(event, callback) {
-        if (ApplicationEvents_1.directShopfrontEvents.includes(event)) {
+        if (isDirectShopfrontEvent(event)) {
             this.directListeners[event]?.delete(callback);
             return;
         }
         this.listeners[event].delete(callback);
     }
+    /**
+     * @inheritDoc
+     */
     send(item) {
-        if (item instanceof Button_1.Button) {
+        if (item instanceof Button) {
             throw new TypeError("You cannot send Buttons to Shopfront without Shopfront requesting them");
         }
-        if (item instanceof BaseEmitableEvent_1.BaseEmitableEvent) {
+        if (item instanceof BaseEmitableEvent) {
             this.bridge.sendMessage(item.getEvent(), item.getData());
         }
         else {
             const serialized = item.serialize();
-            this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.SERIALIZED, serialized);
+            this.bridge.sendMessage(ToShopfront.SERIALIZED, serialized);
         }
     }
+    /**
+     * @inheritDoc
+     */
     download(file) {
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.DOWNLOAD, file);
+        this.bridge.sendMessage(ToShopfront.DOWNLOAD, file);
     }
+    /**
+     * @inheritDoc
+     */
     redirect(toLocation, externalRedirect = true) {
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REDIRECT, {
+        this.bridge.sendMessage(ToShopfront.REDIRECT, {
             to: toLocation,
             external: externalRedirect,
         });
     }
+    /**
+     * @inheritDoc
+     */
     load() {
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.LOAD, true);
-        return () => this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.LOAD, false);
+        this.bridge.sendMessage(ToShopfront.LOAD, true);
+        return () => this.bridge.sendMessage(ToShopfront.LOAD, false);
     }
+    /**
+     * Handles an event callback via the `ActionEventRegistrar`
+     */
     handleEventCallback(data) {
         if (typeof data.id === "undefined") {
             return;
         }
         const id = data.id;
-        ActionEventRegistrar_1.default.fire(id, data.data);
+        ActionEventRegistrar.fire(id, data.data);
     }
+    /**
+     * Updates the cached location data
+     */
     handleLocationChanged(data) {
         this.register = data.register;
         this.outlet = data.outlet;
         this.user = data.user;
     }
+    /**
+     * @inheritDoc
+     */
     getAuthenticationKey() {
         return this.key;
     }
+    /**
+     * Checks whether `data` is formatted as a sale event
+     */
     dataIsSaleEvent(data) {
         return typeof data.requestId === "string" && (data.saleState === false || typeof data.saleState === "object");
     }
     /**
-     * Get the current sale on the sell screen, if the current device is not a register
-     * then this will return false.
-     *
-     * @returns {Promise<CurrentSale | boolean>}
+     * @inheritDoc
      */
     async getCurrentSale() {
         const saleRequest = `SaleRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
+            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_CURRENT_SALE") {
                     return;
@@ -390,28 +394,30 @@ class Application {
             };
             this.bridge.addEventListener(listener);
         });
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REQUEST_CURRENT_SALE, {
+        this.bridge.sendMessage(ToShopfront.REQUEST_CURRENT_SALE, {
             requestId: saleRequest,
         });
         const saleState = await promise;
         if (saleState === false) {
             return saleState;
         }
-        return new CurrentSale_1.CurrentSale(this, saleState);
+        return new CurrentSale(this, saleState);
     }
+    /**
+     * Checks whether `data` is formatted as response data from a 'create sale' request
+     */
     dataIsCreateEvent(data) {
         return typeof data.requestId === "string" &&
-            typeof data.success === "boolean" && (typeof data.message === "undefined" ||
-            typeof data.message === "string");
+            typeof data.success === "boolean" &&
+            (typeof data.message === "undefined" || typeof data.message === "string");
     }
     /**
-     * Send the sale to be created on shopfront.
-     *
-     * @param sale
+     * @inheritDoc
      */
     async createSale(sale) {
         const createSaleRequest = `CreateSaleRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
+            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_CREATE_SALE") {
                     return;
@@ -430,12 +436,15 @@ class Application {
             };
             this.bridge.addEventListener(listener);
         });
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.CREATE_SALE, {
+        this.bridge.sendMessage(ToShopfront.CREATE_SALE, {
             requestId: createSaleRequest,
-            sale: (0, SaleCreate_1.buildSaleData)(sale),
+            sale: buildSaleData(sale),
         });
         return promise;
     }
+    /**
+     * Checks whether `data` is formatted as location data
+     */
     dataIsLocation(data) {
         return typeof data.requestId === "string" &&
             (typeof data.register === "string" || data.register === null) &&
@@ -443,11 +452,12 @@ class Application {
             (typeof data.user === "string" || data.user === null);
     }
     /**
-     * Get the location from Shopfront
+     * @inheritDoc
      */
     async getLocation() {
         const locationRequest = `LocationRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
+            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_LOCATION") {
                     return;
@@ -463,7 +473,7 @@ class Application {
             };
             this.bridge.addEventListener(listener);
         });
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REQUEST_LOCATION, {
+        this.bridge.sendMessage(ToShopfront.REQUEST_LOCATION, {
             requestId: locationRequest,
         });
         const location = await promise;
@@ -473,30 +483,47 @@ class Application {
             user: location.user,
         };
     }
+    /**
+     * @inheritDoc
+     */
     printReceipt(content) {
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.PRINT_RECEIPT, {
+        this.bridge.sendMessage(ToShopfront.PRINT_RECEIPT, {
             content,
             type: "text",
         });
     }
+    /**
+     * @inheritDoc
+     */
     changeSellScreenActionMode(mode) {
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.CHANGE_SELL_SCREEN_ACTION_MODE, {
-            mode
+        this.bridge.sendMessage(ToShopfront.CHANGE_SELL_SCREEN_ACTION_MODE, {
+            mode,
         });
     }
+    /**
+     * @inheritDoc
+     */
     changeSellScreenSummaryMode(mode) {
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.CHANGE_SELL_SCREEN_SUMMARY_MODE, {
-            mode
+        this.bridge.sendMessage(ToShopfront.CHANGE_SELL_SCREEN_SUMMARY_MODE, {
+            mode,
         });
     }
+    /**
+     * Checks whether `data` is formatted as an audio response
+     */
     dataIsAudioResponse(data) {
         return typeof data.requestId === "string" &&
-            typeof data.success === "boolean" && (typeof data.message === "string" ||
-            typeof data.message === "undefined");
+            typeof data.success === "boolean" &&
+            (typeof data.message === "string" ||
+                typeof data.message === "undefined");
     }
+    /**
+     * Sends an audio request to Shopfront
+     */
     sendAudioRequest(type, data) {
         const request = `AudioRequest-${type}-${Date.now().toString()}`;
         const promise = new Promise(res => {
+            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_AUDIO_REQUEST") {
                     return;
@@ -522,35 +549,40 @@ class Application {
         return promise;
     }
     /**
-     * Requests permission from the user to be able to play audio
+     * @inheritDoc
      */
     requestAudioPermission() {
-        return this.sendAudioRequest(ApplicationEvents_1.ToShopfront.AUDIO_REQUEST_PERMISSION);
+        return this.sendAudioRequest(ToShopfront.AUDIO_REQUEST_PERMISSION);
     }
     /**
-     * Requests shopfront to preload audio so that it can be pre-cached before being played
-     * @param url
+     * @inheritDoc
      */
     audioPreload(url) {
-        return this.sendAudioRequest(ApplicationEvents_1.ToShopfront.AUDIO_PRELOAD, {
-            url
+        return this.sendAudioRequest(ToShopfront.AUDIO_PRELOAD, {
+            url,
         });
     }
     /**
-     * Requests the sound to be played
-     * @param url
+     * @inheritDoc
      */
     audioPlay(url) {
-        return this.sendAudioRequest(ApplicationEvents_1.ToShopfront.AUDIO_PLAY, {
-            url
+        return this.sendAudioRequest(ToShopfront.AUDIO_PLAY, {
+            url,
         });
     }
+    /**
+     * Checks whether `data` is formatted as response data to a 'get option' request
+     */
     dataIsOption(data) {
         return typeof data.requestId === "string" && typeof data.option === "string";
     }
+    /**
+     * @inheritDoc
+     */
     async getOption(option, defaultValue) {
         const request = `OptionRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
+            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_OPTION") {
                     return;
@@ -566,7 +598,7 @@ class Application {
             };
             this.bridge.addEventListener(listener);
         });
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.GET_OPTION, {
+        this.bridge.sendMessage(ToShopfront.GET_OPTION, {
             requestId: request,
             option,
         });
@@ -576,9 +608,15 @@ class Application {
         }
         return optionValue;
     }
+    /**
+     * Checks whether `data` is formatted as response data to an embedded token request
+     */
     dataIsEmbeddedToken(data) {
         return typeof data.requestId === "string" && typeof data.data === "object" && data.data !== null;
     }
+    /**
+     * Generates a signing key and sends it to Shopfront
+     */
     async generateSigningKey() {
         if (typeof this.signingKey !== "undefined") {
             return;
@@ -587,8 +625,11 @@ class Application {
             name: "ECDSA",
             namedCurve: "P-384",
         }, true, ["sign", "verify"]);
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.ROTATE_SIGNING_KEY, await crypto.subtle.exportKey("jwk", this.signingKey.privateKey));
+        this.bridge.sendMessage(ToShopfront.ROTATE_SIGNING_KEY, await crypto.subtle.exportKey("jwk", this.signingKey.privateKey));
     }
+    /**
+     * Decodes the embedded token response from Shopfront using the signing key
+     */
     async decodeToken(signature, data, returnTokenObject) {
         if (typeof this.signingKey === "undefined") {
             // Not possible to decode
@@ -614,16 +655,23 @@ class Application {
         }
         return decoded.auth;
     }
+    /**
+     * Checks whether `data` is an error response from an embedded token request
+     */
     tokenDataContainsErrors(data) {
         if (!data || typeof data !== "object") {
             return false;
         }
         return "error" in data && "type" in data;
     }
+    /**
+     * @inheritDoc
+     */
     async getToken(returnTokenObject) {
         await this.generateSigningKey();
         const request = `TokenRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
+            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_SECURE_KEY") {
                     return;
@@ -639,7 +687,7 @@ class Application {
             };
             this.bridge.addEventListener(listener);
         });
-        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REQUEST_SECURE_KEY, {
+        this.bridge.sendMessage(ToShopfront.REQUEST_SECURE_KEY, {
             requestId: request,
         });
         const [signature, data] = await promise;
@@ -650,4 +698,3 @@ class Application {
         return this.decodeToken(signature, data, returnTokenObject);
     }
 }
-exports.Application = Application;