@shopfront/bridge 2.0.0 → 2.0.2

package/lib/ApplicationEvents.d.ts

@@ -1,32 +1,32 @@
-import { Ready } from "./Events/Ready";
-import { Button } from "./Actions/Button";
-import { RequestSettings } from "./Events/RequestSettings";
-import { RequestButtons } from "./Events/RequestButtons";
-import { Callback } from "./Events/Callback";
-import { RequestTableColumns } from "./Events/RequestTableColumns";
-import { RequestSellScreenOptions, SellScreenOption } from "./Events/RequestSellScreenOptions";
-import { ShopfrontSaleState } from "./APIs/Sale";
-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";
-import { UIPipeline } from "./Events/UIPipeline";
-import { PaymentMethodsEnabled } from "./Events/PaymentMethodsEnabled";
-import { AudioPermissionChange } from "./Events/AudioPermissionChange";
-import { FulfilmentGetOrder } from "./Events/FulfilmentGetOrder";
-import { FulfilmentVoidOrder } from "./Events/FulfilmentVoidOrder";
-import { FulfilmentProcessOrder } from "./Events/FulfilmentProcessOrder";
-import { FulfilmentOrderApproval } from "./Events/FulfilmentOrderApproval";
-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";
+import { Button } from "./Actions/Button.js";
+import { SaleKey } from "./Actions/SaleKey.js";
+import { OrderDetails } from "./APIs/Fulfilment/FulfilmentTypes.js";
+import { InternalMessageSource } from "./APIs/InternalMessages/InternalMessageSource.js";
+import { Sale, ShopfrontSaleState } from "./APIs/Sale/index.js";
+import { AudioPermissionChange } from "./Events/AudioPermissionChange.js";
+import { AudioReady } from "./Events/AudioReady.js";
+import { Callback } from "./Events/Callback.js";
+import { FormatIntegratedProduct, FormattedSaleProduct } 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, SellScreenCustomerListOption } from "./Events/RequestCustomerListOptions.js";
+import { RequestSaleKeys } from "./Events/RequestSaleKeys.js";
+import { RequestSellScreenOptions, SellScreenOption } from "./Events/RequestSellScreenOptions.js";
+import { RequestSettings } from "./Events/RequestSettings.js";
+import { RequestTableColumns } from "./Events/RequestTableColumns.js";
+import { CompletedSale, SaleComplete } from "./Events/SaleComplete.js";
+import { UIPipeline } from "./Events/UIPipeline.js";
+import { MaybePromise } from "./Utilities/MiscTypes.js";
 export declare enum ToShopfront {
     READY = "READY",
     SERIALIZED = "SERIALIZED",
@@ -48,6 +48,7 @@ export declare enum ToShopfront {
     REDIRECT = "REDIRECT",
     GET_OPTION = "GET_OPTION",
     RESPONSE_UI_PIPELINE = "RESPONSE_UI_PIPELINE",
+    RESPONSE_GIFT_CARD_CODE_CHECK = "RESPONSE_GIFT_CARD_CODE_CHECK",
     REQUEST_SECURE_KEY = "REQUEST_SECURE_KEY",
     ROTATE_SIGNING_KEY = "ROTATE_SIGNING_KEY",
     AUDIO_REQUEST_PERMISSION = "AUDIO_REQUEST_PERMISSION",
@@ -69,9 +70,9 @@ export declare enum ToShopfront {
     CREATE_SALE = "CREATE_SALE",
     FULFILMENT_GET_ORDER = "FULFILMENT_GET_ORDER"
 }
-export declare type SoundEvents = ToShopfront.AUDIO_REQUEST_PERMISSION | ToShopfront.AUDIO_PRELOAD | ToShopfront.AUDIO_PLAY;
+export type SoundEvents = ToShopfront.AUDIO_REQUEST_PERMISSION | ToShopfront.AUDIO_PRELOAD | ToShopfront.AUDIO_PLAY;
 export interface FromShopfrontReturns {
-    READY: void;
+    READY: unknown;
     REQUEST_SETTINGS: {
         logo: null | string;
         description: null | string;
@@ -84,21 +85,17 @@ export interface FromShopfrontReturns {
             key: string;
             weight: number;
         }>;
-        body: Array<{
-            [key: string]: string;
-        }>;
-        footer: {
-            [key: string]: string;
-        };
+        body: Array<Record<string, string>>;
+        footer: Record<string, string>;
     };
     REQUEST_SELL_SCREEN_OPTIONS: Array<SellScreenOption>;
-    CALLBACK: void;
+    CALLBACK: unknown;
     RESPONSE_CURRENT_SALE: {
         requestId: string;
         saleState: ShopfrontSaleState;
     };
-    INTERNAL_PAGE_MESSAGE: void;
-    REGISTER_CHANGED: void;
+    INTERNAL_PAGE_MESSAGE: unknown;
+    REGISTER_CHANGED: unknown;
     RESPONSE_LOCATION: {
         requestId: string;
         register: string | null;
@@ -113,22 +110,26 @@ export interface FromShopfrontReturns {
     FORMAT_INTEGRATED_PRODUCT: FormatIntegratedProductEvent;
     REQUEST_CUSTOMER_LIST_OPTIONS: Array<SellScreenCustomerListOption>;
     REQUEST_SALE_KEYS: Array<SaleKey>;
-    SALE_COMPLETE: void;
+    SALE_COMPLETE: unknown;
     UI_PIPELINE: Array<UIPipelineResponse>;
     PAYMENT_METHODS_ENABLED: Array<SellScreenPaymentMethod>;
-    AUDIO_READY: void;
-    AUDIO_PERMISSION_CHANGE: void;
+    AUDIO_READY: unknown;
+    AUDIO_PERMISSION_CHANGE: unknown;
     FULFILMENT_GET_ORDER: OrderDetails;
-    FULFILMENT_VOID_ORDER: void;
-    FULFILMENT_PROCESS_ORDER: void;
-    FULFILMENT_ORDER_APPROVAL: void;
-    FULFILMENT_ORDER_COLLECTED: void;
-    FULFILMENT_ORDER_COMPLETED: void;
+    FULFILMENT_VOID_ORDER: unknown;
+    FULFILMENT_PROCESS_ORDER: unknown;
+    FULFILMENT_ORDER_APPROVAL: unknown;
+    FULFILMENT_ORDER_COLLECTED: unknown;
+    FULFILMENT_ORDER_COMPLETED: unknown;
     RESPONSE_CREATE_SALE: {
         requestId: string;
         success: boolean;
         message?: string;
     };
+    GIFT_CARD_CODE_CHECK: {
+        code: string;
+        message: string | null;
+    };
 }
 export interface InternalPageMessageEvent {
     method: "REQUEST_SETTINGS" | "REQUEST_SELL_SCREEN_OPTIONS" | "EXTERNAL_APPLICATION";
@@ -141,6 +142,10 @@ export interface RegisterChangedEvent {
     outlet: null | string;
     user: null | string;
 }
+export interface GiftCardCodeCheckEvent {
+    code: string;
+    message: string | null;
+}
 export interface FormatIntegratedProductEvent {
     product: FormattedSaleProduct;
 }
@@ -158,10 +163,10 @@ export interface FulfilmentApprovalEvent {
     id: string;
     approved: boolean;
 }
-export declare type UIPipelineResponse = {
+export interface UIPipelineResponse {
     name: string;
     content: string;
-};
+}
 export interface UIPipelineBaseContext {
     location: string;
 }
@@ -205,6 +210,7 @@ export interface FromShopfrontCallbacks {
     FULFILMENT_ORDER_APPROVAL: (event: FulfilmentApprovalEvent) => MaybePromise<FromShopfrontReturns["FULFILMENT_ORDER_APPROVAL"]>;
     FULFILMENT_ORDER_COLLECTED: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_ORDER_COLLECTED"]>;
     FULFILMENT_ORDER_COMPLETED: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_ORDER_COMPLETED"]>;
+    GIFT_CARD_CODE_CHECK: (event: GiftCardCodeCheckEvent, context: unknown) => MaybePromise<FromShopfrontReturns["GIFT_CARD_CODE_CHECK"]>;
 }
 export interface FromShopfront {
     READY: Ready;
@@ -229,9 +235,16 @@ export interface FromShopfront {
     FULFILMENT_ORDER_APPROVAL: FulfilmentOrderApproval;
     FULFILMENT_ORDER_COLLECTED: FulfilmentCollectOrder;
     FULFILMENT_ORDER_COMPLETED: FulfilmentCompleteOrder;
+    GIFT_CARD_CODE_CHECK: GiftCardCodeCheck;
 }
+export type ListenableFromShopfrontEvents = keyof Omit<FromShopfront, "CALLBACK">;
 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];
+/**
+ * Checks whether the event is a direct Shopfront event
+ */
+export declare const isDirectShopfrontEvent: (event: DirectShopfrontEvent | ListenableFromShopfrontEvents) => event is DirectShopfrontEvent;
+export type DirectShopfrontEvent = typeof directShopfrontEvents[number];
+export type DirectShopfrontEventCallback = () => void | Promise<void>;
 export interface FromShopfrontInternal {
     CYCLE_KEY: "CYCLE_KEY";
     LOCATION_CHANGED: "LOCATION_CHANGED";
@@ -243,5 +256,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";
+export type SellScreenActionMode = "search" | "keys" | "held-sales" | "payment" | "customers" | "promotions" | "show-backorders" | "fulfilment-orders";
+export type SellScreenSummaryMode = "transaction" | "payments" | "receipts";

package/lib/ApplicationEvents.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.directShopfrontEvents = exports.ToShopfront = void 0;
-var ToShopfront;
+export var ToShopfront;
 (function (ToShopfront) {
     ToShopfront["READY"] = "READY";
     ToShopfront["SERIALIZED"] = "SERIALIZED";
@@ -23,6 +20,7 @@ var ToShopfront;
     ToShopfront["REDIRECT"] = "REDIRECT";
     ToShopfront["GET_OPTION"] = "GET_OPTION";
     ToShopfront["RESPONSE_UI_PIPELINE"] = "RESPONSE_UI_PIPELINE";
+    ToShopfront["RESPONSE_GIFT_CARD_CODE_CHECK"] = "RESPONSE_GIFT_CARD_CODE_CHECK";
     ToShopfront["REQUEST_SECURE_KEY"] = "REQUEST_SECURE_KEY";
     ToShopfront["ROTATE_SIGNING_KEY"] = "ROTATE_SIGNING_KEY";
     // Audio Events
@@ -49,8 +47,8 @@ var ToShopfront;
     ToShopfront["CREATE_SALE"] = "CREATE_SALE";
     // Fulfilment Response Events
     ToShopfront["FULFILMENT_GET_ORDER"] = "FULFILMENT_GET_ORDER";
-})(ToShopfront = exports.ToShopfront || (exports.ToShopfront = {}));
-exports.directShopfrontEvents = [
+})(ToShopfront || (ToShopfront = {}));
+export const directShopfrontEvents = [
     "SALE_ADD_PRODUCT",
     "SALE_REMOVE_PRODUCT",
     "SALE_UPDATE_PRODUCTS",
@@ -59,3 +57,9 @@ exports.directShopfrontEvents = [
     "SALE_REMOVE_CUSTOMER",
     "SALE_CLEAR",
 ];
+/**
+ * Checks whether the event is a direct Shopfront event
+ */
+export const isDirectShopfrontEvent = (event) => {
+    return directShopfrontEvents.includes(event);
+};

package/lib/BaseApplication.d.ts

@@ -0,0 +1,169 @@
+import { BaseDatabase } from "./APIs/Database/BaseDatabase.js";
+import { BaseCurrentSale } from "./APIs/Sale/BaseCurrentSale.js";
+import { Sale } from "./APIs/Sale/index.js";
+import { DirectShopfrontEvent, DirectShopfrontEventCallback, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, ListenableFromShopfrontEvents, RegisterChangedEvent, SellScreenActionMode, SellScreenSummaryMode, SoundEvents } from "./ApplicationEvents.js";
+import { BaseBridge } from "./BaseBridge.js";
+import { Serializable } from "./Common/Serializable.js";
+import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent.js";
+import { BaseEvent } from "./Events/BaseEvent.js";
+import { MaybePromise } from "./Utilities/MiscTypes.js";
+export interface ShopfrontResponse {
+    success: boolean;
+    message?: string;
+}
+export interface ShopfrontEmbeddedVerificationToken {
+    auth: string;
+    id: string;
+    app: string;
+    user: string;
+    url: {
+        raw: string;
+        loaded: string;
+    };
+}
+export interface ShopfrontEmbeddedTokenError {
+    error: boolean;
+    type: string;
+}
+export declare class ShopfrontTokenDecodingError extends Error {
+}
+export declare class ShopfrontTokenRequestError extends Error {
+}
+export declare abstract class BaseApplication {
+    protected bridge: BaseBridge;
+    protected isReady: boolean;
+    protected key: string;
+    protected register: string | null;
+    protected outlet: string | null;
+    protected user: string | null;
+    protected signingKey: CryptoKeyPair | undefined;
+    protected listeners: {
+        [key in ListenableFromShopfrontEvents]: Map<(...args: Array<unknown>) => void, FromShopfront[key] & BaseEvent>;
+    };
+    protected directListeners: Partial<Record<DirectShopfrontEvent, Set<DirectShopfrontEventCallback>>>;
+    database: BaseDatabase;
+    protected constructor(bridge: BaseBridge, database: BaseDatabase);
+    /**
+     * Destroy the bridge instance
+     */
+    abstract destroy(): void;
+    /**
+     * Handles an application event
+     */
+    protected abstract handleEvent(event: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string): void;
+    /**
+     * Calls any registered listeners for the received event
+     */
+    protected abstract emit(event: ListenableFromShopfrontEvents | DirectShopfrontEvent, data: Record<string, unknown>, id: string): MaybePromise<void>;
+    /**
+     * Register a listener for a Shopfront event
+     */
+    abstract addEventListener<E extends ListenableFromShopfrontEvents>(event: E, callback: FromShopfrontCallbacks[E]): void;
+    /**
+     * Register a listener for a Shopfront event
+     */
+    abstract addEventListener(event: DirectShopfrontEvent, callback: DirectShopfrontEventCallback): void;
+    /**
+     * Register a listener for a Shopfront event
+     */
+    abstract addEventListener(event: ListenableFromShopfrontEvents | DirectShopfrontEvent, callback: (...args: Array<unknown>) => void): void;
+    /**
+     * Removed a registered listener for a Shopfront event
+     */
+    abstract removeEventListener<E extends keyof FromShopfrontCallbacks>(event: E, callback: FromShopfrontCallbacks[E]): void;
+    /**
+     * Removed a registered listener for a Shopfront event
+     */
+    abstract removeEventListener<D>(event: DirectShopfrontEvent, callback: (event: D) => MaybePromise<void>): void;
+    /**
+     * Removed a registered listener for a Shopfront event
+     */
+    abstract removeEventListener(event: ListenableFromShopfrontEvents | DirectShopfrontEvent, callback: (...args: Array<unknown>) => MaybePromise<void>): void;
+    /**
+     * Send data to Shopfront
+     */
+    abstract send(item: BaseEmitableEvent<unknown> | Serializable<unknown>): void;
+    /**
+     * Requests permission from the user to download the specified file
+     */
+    abstract download(file: string): void;
+    /**
+     * Redirects the user to the specified location.
+     * If `externalRedirect` is `true`, the user is prompted to confirm the redirect.
+     */
+    abstract redirect(toLocation: string, externalRedirect: boolean): void;
+    /**
+     * Shows a loading screen in Shopfront
+     */
+    abstract load(): void;
+    protected abstract handleEventCallback(data: {
+        id?: string;
+        data: unknown;
+    }): void;
+    protected abstract handleLocationChanged(data: RegisterChangedEvent): void;
+    /**
+     * Retrieves the cached authentication key
+     */
+    abstract getAuthenticationKey(): string;
+    /**
+     * Get the current sale on the sell screen, if the current device is not a register
+     * then this will return false.
+     */
+    abstract getCurrentSale(): Promise<BaseCurrentSale | false>;
+    /**
+     * Send the sale to be created on shopfront.
+     */
+    abstract createSale(sale: Sale): Promise<ShopfrontResponse>;
+    /**
+     * Retrieves the current location data from Shopfront
+     */
+    abstract getLocation(): Promise<{
+        register: string | null;
+        outlet: string | null;
+        user: string | null;
+    }>;
+    /**
+     * Prints the provided content as a receipt
+     */
+    abstract printReceipt(content: string): void;
+    /**
+     * Changes the display mode of the sell screen's `action` container
+     */
+    abstract changeSellScreenActionMode(mode: SellScreenActionMode): void;
+    /**
+     * Changes the display mode of the sell screen's 'summary' container
+     */
+    abstract changeSellScreenSummaryMode(mode: SellScreenSummaryMode): void;
+    /**
+     * Sends an audio request to Shopfront
+     */
+    protected abstract sendAudioRequest(type: SoundEvents, data?: unknown): Promise<ShopfrontResponse>;
+    /**
+     * Requests permission from the user to be able to play audio
+     */
+    abstract requestAudioPermission(): Promise<ShopfrontResponse>;
+    /**
+     * Requests Shopfront to preload audio so that it can be pre-cached before being played
+     */
+    abstract audioPreload(url: string): Promise<ShopfrontResponse>;
+    /**
+     * Attempts to play the provided audio in Shopfront
+     */
+    abstract audioPlay(url: string): Promise<ShopfrontResponse>;
+    /**
+     * Retrieve the value of the specified option from Shopfront
+     */
+    abstract getOption<TValueType>(option: string, defaultValue: TValueType): Promise<TValueType>;
+    /**
+     * Retrieves an embedded token from Shopfront that can be used to validate server requests
+     */
+    abstract getToken(returnTokenObject: true): Promise<ShopfrontEmbeddedVerificationToken>;
+    /**
+     * Retrieves an embedded token from Shopfront that can be used to validate server requests
+     */
+    abstract getToken(returnTokenObject?: false): Promise<string>;
+    /**
+     * Retrieves an embedded token from Shopfront that can be used to validate server requests
+     */
+    abstract getToken(returnTokenObject?: boolean): Promise<string | ShopfrontEmbeddedVerificationToken>;
+}

package/lib/BaseApplication.js

@@ -0,0 +1,40 @@
+export class ShopfrontTokenDecodingError extends Error {
+}
+export class ShopfrontTokenRequestError extends Error {
+}
+export class BaseApplication {
+    constructor(bridge, database) {
+        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(),
+            GIFT_CARD_CODE_CHECK: new Map(),
+        };
+        this.directListeners = {};
+        this.bridge = bridge;
+        this.isReady = false;
+        this.key = "";
+        this.register = null;
+        this.outlet = null;
+        this.user = null;
+        this.database = database;
+    }
+}

package/lib/BaseBridge.d.ts

@@ -0,0 +1,33 @@
+import * as ApplicationEvents from "./ApplicationEvents.js";
+import { ApplicationEventListener } from "./Bridge.js";
+export declare abstract class BaseBridge {
+    key: string;
+    url: URL;
+    protected listeners: Array<ApplicationEventListener>;
+    protected hasListener: boolean;
+    protected constructor(key: string, url: string);
+    /**
+     * Destroys the Bridge by unregistering all listeners
+     */
+    abstract destroy(): void;
+    /**
+     * Register the event listener for any window messages
+     */
+    protected abstract registerListeners(): void;
+    /**
+     * Removes the window message event listener
+     */
+    protected abstract unregisterListeners(): void;
+    /**
+     * Sends an event to Shopfront
+     */
+    abstract sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    /**
+     * Adds a listener for a Shopfront event
+     */
+    abstract addEventListener(listener: ApplicationEventListener): void;
+    /**
+     * Removes a listener for a Shopfront event
+     */
+    abstract removeEventListener(listener: ApplicationEventListener): void;
+}

package/lib/BaseBridge.js

@@ -0,0 +1,16 @@
+import * as ApplicationEvents from "./ApplicationEvents.js";
+export class BaseBridge {
+    constructor(key, url) {
+        this.listeners = [];
+        this.hasListener = false;
+        this.key = key;
+        if (url.split(".").length === 1) {
+            this.url = new URL(`https://${url}.onshopfront.com`);
+        }
+        else {
+            this.url = new URL(url);
+        }
+        this.registerListeners();
+        this.sendMessage(ApplicationEvents.ToShopfront.READY);
+    }
+}

package/lib/Bridge.d.ts

@@ -1,26 +1,63 @@
-import { Application } from "./Application";
-import * as ApplicationEvents from "./ApplicationEvents";
+import { Application } from "./Application.js";
+import * as ApplicationEvents from "./ApplicationEvents.js";
+import { BaseBridge } from "./BaseBridge.js";
 interface ApplicationOptions {
     id: string;
     vendor: string;
 }
-export interface ApplicationEventListener {
-    (event: keyof ApplicationEvents.FromShopfront | keyof ApplicationEvents.FromShopfrontInternal, data: Record<string, unknown>, id: string): void;
+export type ApplicationEventListener = (event: keyof ApplicationEvents.FromShopfront | keyof ApplicationEvents.FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
+export interface BridgeInterface {
+    /**
+     * Destroys the Bridge by unregistering all listeners
+     */
+    destroy(): void;
+    /**
+     * Sends an event to Shopfront
+     */
+    sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    /**
+     * Adds a listener for a Shopfront event
+     */
+    addEventListener(listener: ApplicationEventListener): void;
+    /**
+     * Removes a listener for a Shopfront event
+     */
+    removeEventListener(listener: ApplicationEventListener): void;
 }
-export declare class Bridge {
+export declare class Bridge extends BaseBridge {
+    /**
+     * A static method for instantiating an Application
+     */
     static createApplication(options: ApplicationOptions): Application;
-    key: string;
-    url: URL;
-    protected listeners: Array<ApplicationEventListener>;
-    protected hasListener: boolean;
     protected target: Window | null;
     constructor(key: string, url: string);
+    /**
+     * @inheritDoc
+     */
     destroy(): void;
+    /**
+     * @inheritDoc
+     */
     protected registerListeners(): void;
+    /**
+     * @inheritDoc
+     */
     protected unregisterListeners(): void;
+    /**
+     * @inheritDoc
+     */
     protected handleMessage: (event: MessageEvent) => void;
+    /**
+     * @inheritDoc
+     */
     sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    /**
+     * @inheritDoc
+     */
     addEventListener(listener: ApplicationEventListener): void;
+    /**
+     * @inheritDoc
+     */
     removeEventListener(listener: ApplicationEventListener): void;
 }
 export {};