@shopfront/bridge 2.0.0 → 2.0.2

package/lib/Events/PaymentMethodsEnabled.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentMethodsEnabled = void 0;
-const BaseEvent_1 = require("./BaseEvent");
-const ApplicationEvents_1 = require("../ApplicationEvents");
-class PaymentMethodsEnabled extends BaseEvent_1.BaseEvent {
+import { ToShopfront, } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class PaymentMethodsEnabled extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * @inheritDoc
+     */
     async emit(data) {
         const result = await this.callback(data.data, data.context);
         if (typeof result !== "object" || result === null) {
@@ -14,8 +14,10 @@ class PaymentMethodsEnabled extends BaseEvent_1.BaseEvent {
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     static async respond(bridge, data, id) {
-        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_UI_PIPELINE, data, id);
+        bridge.sendMessage(ToShopfront.RESPONSE_UI_PIPELINE, data, id);
     }
 }
-exports.PaymentMethodsEnabled = PaymentMethodsEnabled;

package/lib/Events/Ready.d.ts

@@ -1,10 +1,15 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns, RegisterChangedEvent } from "../ApplicationEvents";
-import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns, RegisterChangedEvent } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+interface ReadyData {
+    outlet: string | null;
+    register: string | null;
+    user: string | null;
+}
 export declare class Ready extends BaseEvent<RegisterChangedEvent> {
     constructor(callback: FromShopfrontCallbacks["READY"]);
-    emit(data: {
-        outlet: string | null;
-        register: string | null;
-        user: string | null;
-    }): Promise<FromShopfrontReturns["READY"]>;
+    /**
+     * @inheritDoc
+     */
+    emit(data: ReadyData): Promise<FromShopfrontReturns["READY"]>;
 }
+export {};

package/lib/Events/Ready.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ready = void 0;
-const BaseEvent_1 = require("./BaseEvent");
-class Ready extends BaseEvent_1.BaseEvent {
+import { BaseEvent } from "./BaseEvent.js";
+export class Ready extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * @inheritDoc
+     */
     async emit(data) {
         return this.callback({
             outlet: data.outlet,
@@ -14,4 +14,3 @@ class Ready extends BaseEvent_1.BaseEvent {
         }, undefined);
     }
 }
-exports.Ready = Ready;

package/lib/Events/RegisterChanged.d.ts

@@ -1,9 +1,15 @@
-import { BaseEvent } from "./BaseEvent";
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+interface RegisterChangedData {
+    outlet: string | null;
+    register: string | null;
+    user: string | null;
+}
 export declare class RegisterChanged extends BaseEvent {
     constructor(callback: FromShopfrontCallbacks["REGISTER_CHANGED"]);
-    emit(data: {
-        outlet: string | null;
-        register: string | null;
-    }): Promise<FromShopfrontReturns["REGISTER_CHANGED"]>;
+    /**
+     * @inheritDoc
+     */
+    emit(data: RegisterChangedData): Promise<FromShopfrontReturns["REGISTER_CHANGED"]>;
 }
+export {};

package/lib/Events/RegisterChanged.js

@@ -1,13 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisterChanged = void 0;
-const BaseEvent_1 = require("./BaseEvent");
-class RegisterChanged extends BaseEvent_1.BaseEvent {
+import { BaseEvent } from "./BaseEvent.js";
+export class RegisterChanged extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * @inheritDoc
+     */
     async emit(data) {
-        this.callback(data, undefined);
+        return this.callback(data, undefined);
     }
 }
-exports.RegisterChanged = RegisterChanged;

package/lib/Events/RequestButtons.d.ts

@@ -1,17 +1,22 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
-import { Bridge, Button } from "..";
-import { BaseEvent } from "./BaseEvent";
-import { MaybePromise } from "../Utilities/MiscTypes";
-export declare class RequestButtons extends BaseEvent<{
+import { Button } from "../Actions/Button.js";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+import { MaybePromise } from "../Utilities/MiscTypes.js";
+import { BaseEvent } from "./BaseEvent.js";
+interface RequestButtonsData {
     location: string;
     id: string;
     context: unknown;
-}, MaybePromise<FromShopfrontReturns["REQUEST_BUTTONS"]>, MaybePromise<FromShopfrontReturns["REQUEST_BUTTONS"]>, string, unknown> {
+}
+export declare class RequestButtons extends BaseEvent<RequestButtonsData, MaybePromise<FromShopfrontReturns["REQUEST_BUTTONS"]>, MaybePromise<FromShopfrontReturns["REQUEST_BUTTONS"]>, string, unknown> {
     constructor(callback: FromShopfrontCallbacks["REQUEST_BUTTONS"]);
-    emit(data: {
-        location: string;
-        id: string;
-        context: unknown;
-    }): Promise<FromShopfrontReturns["REQUEST_BUTTONS"]>;
-    static respond(bridge: Bridge, buttons: Array<Button>, id: string): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    emit(data: RequestButtonsData): Promise<FromShopfrontReturns["REQUEST_BUTTONS"]>;
+    /**
+     * Sends the response data to Shopfront
+     */
+    static respond(bridge: BaseBridge, buttons: Array<Button>, id: string): Promise<void>;
 }
+export {};

package/lib/Events/RequestButtons.js

@@ -1,34 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestButtons = void 0;
-const ApplicationEvents_1 = require("../ApplicationEvents");
-const __1 = require("..");
-const BaseEvent_1 = require("./BaseEvent");
-class RequestButtons extends BaseEvent_1.BaseEvent {
+import { Button } from "../Actions/Button.js";
+import { ToShopfront } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class RequestButtons extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * @inheritDoc
+     */
     async emit(data) {
         let result = await this.callback(data.location, data.context);
         if (!Array.isArray(result)) {
             result = [result];
         }
         for (let i = 0, l = result.length; i < l; i++) {
-            if (!(result[i] instanceof __1.Button)) {
+            if (!(result[i] instanceof Button)) {
                 throw new TypeError("You must return an instance of Button");
             }
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     static async respond(bridge, buttons, id) {
         const response = [];
         for (let i = 0, l = buttons.length; i < l; i++) {
-            if (!(buttons[i] instanceof __1.Button)) {
+            if (!(buttons[i] instanceof Button)) {
                 throw new TypeError("Invalid response returned, expected button");
             }
             response.push(buttons[i].serialize());
         }
-        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_BUTTONS, response, id);
+        bridge.sendMessage(ToShopfront.RESPONSE_BUTTONS, response, id);
     }
 }
-exports.RequestButtons = RequestButtons;

package/lib/Events/RequestCustomerListOptions.d.ts

@@ -1,13 +1,19 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
-import { Bridge } from "..";
-import { BaseEvent } from "./BaseEvent";
-import { MaybePromise } from "../Utilities/MiscTypes";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+import { MaybePromise } from "../Utilities/MiscTypes.js";
+import { BaseEvent } from "./BaseEvent.js";
 export interface SellScreenCustomerListOption {
     contents: string;
     onClick: () => void;
 }
 export declare class RequestCustomerListOptions extends BaseEvent<Record<string, unknown>, MaybePromise<FromShopfrontReturns["REQUEST_CUSTOMER_LIST_OPTIONS"]>, FromShopfrontReturns["REQUEST_CUSTOMER_LIST_OPTIONS"], undefined> {
     constructor(callback: FromShopfrontCallbacks["REQUEST_CUSTOMER_LIST_OPTIONS"]);
+    /**
+     * @inheritDoc
+     */
     emit(_: Record<string, unknown>): Promise<FromShopfrontReturns["REQUEST_CUSTOMER_LIST_OPTIONS"]>;
-    static respond(bridge: Bridge, options: Array<SellScreenCustomerListOption>, id: string): Promise<void>;
+    /**
+     * Sends the response data to Shopfront
+     */
+    static respond(bridge: BaseBridge, options: Array<SellScreenCustomerListOption>, id: string): Promise<void>;
 }

package/lib/Events/RequestCustomerListOptions.js

@@ -1,14 +1,13 @@
-"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 {
+import { CustomerListOption } from "../Actions/CustomerListOption.js";
+import { ToShopfront } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class RequestCustomerListOptions extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    /**
+     * @inheritDoc
+     */
     async emit(_) {
         let result = await this.callback(undefined, undefined);
         if (!Array.isArray(result)) {
@@ -21,12 +20,14 @@ class RequestCustomerListOptions extends BaseEvent_1.BaseEvent {
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     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);
+        bridge.sendMessage(ToShopfront.RESPONSE_CUSTOMER_LIST_OPTIONS, options.map(option => {
+            const o = new CustomerListOption(option.contents);
             o.addEventListener("click", option.onClick);
             return o.serialize();
         }), id);
     }
 }
-exports.RequestCustomerListOptions = RequestCustomerListOptions;

package/lib/Events/RequestSaleKeys.d.ts

@@ -1,10 +1,16 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
-import { Bridge } from "..";
-import { BaseEvent } from "./BaseEvent";
-import { SaleKey } from "../Actions/SaleKey";
-import { MaybePromise } from "../Utilities/MiscTypes";
+import { SaleKey } from "../Actions/SaleKey.js";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+import { MaybePromise } from "../Utilities/MiscTypes.js";
+import { BaseEvent } from "./BaseEvent.js";
 export declare class RequestSaleKeys extends BaseEvent<undefined, MaybePromise<Array<SaleKey>>, Array<SaleKey>> {
     constructor(callback: FromShopfrontCallbacks["REQUEST_SALE_KEYS"]);
+    /**
+     * @inheritDoc
+     */
     emit(): Promise<FromShopfrontReturns["REQUEST_SALE_KEYS"]>;
-    static respond(bridge: Bridge, keys: Array<SaleKey>, id: string): Promise<void>;
+    /**
+     * Sends the response data to Shopfront
+     */
+    static respond(bridge: BaseBridge, keys: Array<SaleKey>, id: string): Promise<void>;
 }

package/lib/Events/RequestSaleKeys.js

@@ -1,34 +1,36 @@
-"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 {
+import { SaleKey } from "../Actions/SaleKey.js";
+import { ToShopfront } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class RequestSaleKeys extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * @inheritDoc
+     */
     async emit() {
         let result = await this.callback(undefined, undefined);
         if (!Array.isArray(result)) {
             result = [result];
         }
         for (let i = 0, l = result.length; i < l; i++) {
-            if (!(result[i] instanceof SaleKey_1.SaleKey)) {
+            if (!(result[i] instanceof SaleKey)) {
                 throw new TypeError("You must return an instance of SaleKey");
             }
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     static async respond(bridge, keys, id) {
         const response = [];
         for (let i = 0, l = keys.length; i < l; i++) {
-            if (!(keys[i] instanceof SaleKey_1.SaleKey)) {
+            if (!(keys[i] instanceof SaleKey)) {
                 throw new TypeError("Invalid response returned, expected SaleKey");
             }
             response.push(keys[i].serialize());
         }
-        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_SALE_KEYS, response, id);
+        bridge.sendMessage(ToShopfront.RESPONSE_SALE_KEYS, response, id);
     }
 }
-exports.RequestSaleKeys = RequestSaleKeys;

package/lib/Events/RequestSellScreenOptions.d.ts

@@ -1,7 +1,7 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
-import { Bridge } from "..";
-import { BaseEvent } from "./BaseEvent";
-import { MaybePromise } from "../Utilities/MiscTypes";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+import { MaybePromise } from "../Utilities/MiscTypes.js";
+import { BaseEvent } from "./BaseEvent.js";
 export interface SellScreenOption {
     url: string;
     title: string;
@@ -9,8 +9,21 @@ export interface SellScreenOption {
 }
 export declare class RequestSellScreenOptions extends BaseEvent<undefined, MaybePromise<FromShopfrontReturns["REQUEST_SELL_SCREEN_OPTIONS"]>, FromShopfrontReturns["REQUEST_SELL_SCREEN_OPTIONS"]> {
     constructor(callback: FromShopfrontCallbacks["REQUEST_SELL_SCREEN_OPTIONS"]);
+    /**
+     * Generates a unique identifier for a URL by encoding it to base64.
+     * If the URL contains non-ASCII characters, it first URI-encodes the URL before converting to base64.
+     */
     static getOptionId(url: string): string;
+    /**
+     * Validates the URL by ensuring it follows the HTTPS protocol
+     */
     static validateURL(url: string): void;
+    /**
+     * @inheritDoc
+     */
     emit(_: never): Promise<FromShopfrontReturns["REQUEST_SELL_SCREEN_OPTIONS"]>;
-    static respond(bridge: Bridge, options: Array<SellScreenOption>, id: string): Promise<void>;
+    /**
+     * Sends the response data to Shopfront
+     */
+    static respond(bridge: BaseBridge, options: Array<SellScreenOption>, id: string): Promise<void>;
 }

package/lib/Events/RequestSellScreenOptions.js

@@ -1,12 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestSellScreenOptions = void 0;
-const ApplicationEvents_1 = require("../ApplicationEvents");
-const BaseEvent_1 = require("./BaseEvent");
-class RequestSellScreenOptions extends BaseEvent_1.BaseEvent {
+import { ToShopfront } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class RequestSellScreenOptions extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * Generates a unique identifier for a URL by encoding it to base64.
+     * If the URL contains non-ASCII characters, it first URI-encodes the URL before converting to base64.
+     */
     static getOptionId(url) {
         try {
             return btoa(url);
@@ -16,13 +17,18 @@ class RequestSellScreenOptions extends BaseEvent_1.BaseEvent {
             return btoa(encodeURI(url));
         }
     }
+    /**
+     * Validates the URL by ensuring it follows the HTTPS protocol
+     */
     static validateURL(url) {
         const urlObj = new URL(url);
         if (urlObj.protocol !== "https:") {
             throw new TypeError(`The URL "${url}" is invalid, please ensure that you're using the HTTPS protocol`);
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    /**
+     * @inheritDoc
+     */
     async emit(_) {
         let result = await this.callback(undefined, undefined);
         if (!Array.isArray(result)) {
@@ -37,8 +43,10 @@ class RequestSellScreenOptions extends BaseEvent_1.BaseEvent {
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     static async respond(bridge, options, id) {
-        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_SELL_SCREEN_OPTIONS, options, id);
+        bridge.sendMessage(ToShopfront.RESPONSE_SELL_SCREEN_OPTIONS, options, id);
     }
 }
-exports.RequestSellScreenOptions = RequestSellScreenOptions;

package/lib/Events/RequestSettings.d.ts

@@ -1,9 +1,15 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
-import { BaseEvent } from "./BaseEvent";
-import { Bridge } from "../Bridge";
-import { MaybePromise } from "../Utilities/MiscTypes";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+import { MaybePromise } from "../Utilities/MiscTypes.js";
+import { BaseEvent } from "./BaseEvent.js";
 export declare class RequestSettings extends BaseEvent<undefined, MaybePromise<FromShopfrontReturns["REQUEST_SETTINGS"]>, FromShopfrontReturns["REQUEST_SETTINGS"]> {
     constructor(callback: FromShopfrontCallbacks["REQUEST_SETTINGS"]);
+    /**
+     * @inheritDoc
+     */
     emit(_: never): Promise<FromShopfrontReturns["REQUEST_SETTINGS"]>;
-    static respond(bridge: Bridge, settings: Array<FromShopfrontReturns["REQUEST_SETTINGS"]>, id: string): Promise<void>;
+    /**
+     * Sends the response data to Shopfront
+     */
+    static respond(bridge: BaseBridge, settings: Array<FromShopfrontReturns["REQUEST_SETTINGS"]>, id: string): Promise<void>;
 }

package/lib/Events/RequestSettings.js

@@ -1,13 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestSettings = void 0;
-const ApplicationEvents_1 = require("../ApplicationEvents");
-const BaseEvent_1 = require("./BaseEvent");
-class RequestSettings extends BaseEvent_1.BaseEvent {
+import { ToShopfront } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class RequestSettings extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    /**
+     * @inheritDoc
+     */
     async emit(_) {
         const result = await this.callback(undefined, undefined);
         if (typeof result !== "object" || result === null) {
@@ -15,11 +14,14 @@ class RequestSettings extends BaseEvent_1.BaseEvent {
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     static async respond(bridge, settings, id) {
         if (settings.length > 1) {
-            throw new Error("Multiple settings responses found, please ensure you are only subscribed to REQUEST_SETTINGS once");
+            throw new Error("Multiple settings responses found, " +
+                "please ensure you are only subscribed to REQUEST_SETTINGS once");
         }
-        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_SETTINGS, settings[0], id);
+        bridge.sendMessage(ToShopfront.RESPONSE_SETTINGS, settings[0], id);
     }
 }
-exports.RequestSettings = RequestSettings;

package/lib/Events/RequestTableColumns.d.ts

@@ -1,15 +1,20 @@
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
-import { BaseEvent } from "./BaseEvent";
-import { Bridge } from "../Bridge";
-import { MaybePromise } from "../Utilities/MiscTypes";
-export declare class RequestTableColumns extends BaseEvent<{
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+import { MaybePromise } from "../Utilities/MiscTypes.js";
+import { BaseEvent } from "./BaseEvent.js";
+interface RequestTableColumnsData {
     location: string;
     context: unknown;
-}, MaybePromise<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>, FromShopfrontReturns["REQUEST_TABLE_COLUMNS"], string, unknown> {
+}
+export declare class RequestTableColumns extends BaseEvent<RequestTableColumnsData, MaybePromise<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>, FromShopfrontReturns["REQUEST_TABLE_COLUMNS"], string, unknown> {
     constructor(callback: FromShopfrontCallbacks["REQUEST_TABLE_COLUMNS"]);
-    emit(data: {
-        location: string;
-        context: unknown;
-    }): Promise<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>;
-    static respond(bridge: Bridge, columns: Array<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>, id: string): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    emit(data: RequestTableColumnsData): Promise<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>;
+    /**
+     * Sends the response data to Shopfront
+     */
+    static respond(bridge: BaseBridge, columns: Array<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"]>, id: string): Promise<void>;
 }
+export {};

package/lib/Events/RequestTableColumns.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestTableColumns = void 0;
-const ApplicationEvents_1 = require("../ApplicationEvents");
-const BaseEvent_1 = require("./BaseEvent");
-class RequestTableColumns extends BaseEvent_1.BaseEvent {
+import { ToShopfront } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
+export class RequestTableColumns extends BaseEvent {
     constructor(callback) {
         super(callback);
     }
+    /**
+     * @inheritDoc
+     */
     async emit(data) {
         const result = await this.callback(data.location, data.context);
         if (typeof result !== "object") {
@@ -14,12 +14,15 @@ class RequestTableColumns extends BaseEvent_1.BaseEvent {
         }
         return result;
     }
+    /**
+     * Sends the response data to Shopfront
+     */
     static async respond(bridge, columns, id) {
         columns = columns.filter(column => column !== null);
         if (columns.length > 1) {
-            throw new Error("Multiple table column responses found, please ensure you are only subscribed to REQUEST_TABLE_COLUMNS once");
+            throw new Error("Multiple table column responses found," +
+                "please ensure you are only subscribed to REQUEST_TABLE_COLUMNS once");
         }
-        bridge.sendMessage(ApplicationEvents_1.ToShopfront.RESPONSE_TABLE_COLUMNS, columns[0], id);
+        bridge.sendMessage(ToShopfront.RESPONSE_TABLE_COLUMNS, columns[0], id);
     }
 }
-exports.RequestTableColumns = RequestTableColumns;

package/lib/Events/SaleComplete.d.ts

@@ -1,5 +1,5 @@
-import { BaseEvent } from "./BaseEvent";
-import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import { BaseEvent } from "./BaseEvent.js";
 interface CompletedSaleProduct {
     uuid: string;
     type: "Normal" | "Product" | "GiftCard" | "Voucher" | "Basket" | "Package" | "Component" | "Integrated";
@@ -28,19 +28,15 @@ interface CompletedSaleProduct {
     defaultProducts: Array<CompletedSaleProduct>;
     special: boolean;
     edited: boolean;
-    promotions: {
-        [id: string]: {
-            name: string;
-            active: boolean;
-            quantity: number;
-        };
-    };
-    rebates: {
-        [id: string]: {
-            amount: number;
-            quantity: number;
-        };
-    };
+    promotions: Record<string, {
+        name: string;
+        active: boolean;
+        quantity: number;
+    }>;
+    rebates: Record<string, {
+        amount: number;
+        quantity: number;
+    }>;
     giftCard: {
         code: string;
         amount: number;
@@ -56,9 +52,7 @@ interface CompletedSaleProduct {
     discountReason?: string;
     requestPrice?: boolean;
     lockQuantity: boolean;
-    metaData: {
-        [key: string]: unknown;
-    };
+    metaData: Record<string, unknown>;
 }
 interface CompletedSalePayment {
     method: string;
@@ -108,6 +102,9 @@ export interface CompletedSale {
 }
 export declare class SaleComplete extends BaseEvent {
     constructor(callback: FromShopfrontCallbacks["SALE_COMPLETE"]);
+    /**
+     * @inheritDoc
+     */
     emit(data: CompletedSale): Promise<FromShopfrontReturns["SALE_COMPLETE"]>;
 }
 export {};

package/lib/Events/SaleComplete.js

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