@shopfront/bridge 2.0.0 → 2.0.2

package/lib/Application.d.ts

@@ -1,90 +1,101 @@
-import { Bridge } from "./Bridge";
-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";
-import { Database } from "./APIs/Database/Database";
-import { MaybePromise } from "./Utilities/MiscTypes";
-import { BaseEvent } from "./Events/BaseEvent";
-import { CurrentSale } from "./APIs/Sale/CurrentSale";
-import { Sale } from "./APIs/Sale";
-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 class Application {
-    protected bridge: Bridge;
-    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 keyof Omit<FromShopfront, "CALLBACK">]: Map<(...args: Array<unknown>) => void, FromShopfront[key] & BaseEvent>;
-    };
-    protected directListeners: {
-        [K in DirectShopfrontEvent]?: Set<(data: unknown) => void | Promise<void>>;
-    };
-    database: Database;
+import { CurrentSale } from "./APIs/Sale/CurrentSale.js";
+import { Sale, ShopfrontSaleState } from "./APIs/Sale/index.js";
+import { DirectShopfrontEvent, DirectShopfrontEventCallback, FromShopfront, FromShopfrontCallbacks, FromShopfrontInternal, ListenableFromShopfrontEvents, RegisterChangedEvent, SellScreenActionMode, SellScreenSummaryMode, SoundEvents } from "./ApplicationEvents.js";
+import { BaseApplication, ShopfrontEmbeddedTokenError, ShopfrontEmbeddedVerificationToken, ShopfrontResponse } from "./BaseApplication.js";
+import { Bridge } from "./Bridge.js";
+import { Serializable } from "./Common/Serializable.js";
+import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent.js";
+import { MaybePromise } from "./Utilities/MiscTypes.js";
+export declare class Application extends BaseApplication {
     constructor(bridge: Bridge);
+    /**
+     * @inheritDoc
+     */
     destroy(): void;
+    /**
+     * Handles an application event
+     */
     protected handleEvent: (event: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
-    protected emit(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, data: Record<string, unknown> | undefined, id: string): void | Promise<void>;
-    addEventListener<E extends keyof FromShopfrontCallbacks>(event: E, callback: FromShopfrontCallbacks[E]): void;
-    addEventListener<D>(event: DirectShopfrontEvent, callback: (event: D) => MaybePromise<void>): void;
+    /**
+     * Calls any registered listeners for the received event
+     */
+    protected emit(event: ListenableFromShopfrontEvents | DirectShopfrontEvent, data: Record<string, unknown> | undefined, id: string): MaybePromise<void>;
+    /**
+     * @inheritDoc
+     */
+    addEventListener<E extends ListenableFromShopfrontEvents>(event: E, callback: FromShopfrontCallbacks[E]): void;
+    /**
+     * @inheritDoc
+     */
+    addEventListener(event: DirectShopfrontEvent, callback: DirectShopfrontEventCallback): void;
+    /**
+     * @inheritDoc
+     */
     removeEventListener<E extends keyof FromShopfrontCallbacks>(event: E, callback: FromShopfrontCallbacks[E]): void;
+    /**
+     * @inheritDoc
+     */
     removeEventListener<D>(event: DirectShopfrontEvent, callback: (event: D) => MaybePromise<void>): void;
-    send(item: BaseEmitableEvent<unknown>): void;
-    send(item: Serializable<unknown>): void;
+    /**
+     * @inheritDoc
+     */
+    send(item: BaseEmitableEvent<unknown> | Serializable<unknown>): void;
+    /**
+     * @inheritDoc
+     */
     download(file: string): void;
+    /**
+     * @inheritDoc
+     */
     redirect(toLocation: string, externalRedirect?: boolean): void;
+    /**
+     * @inheritDoc
+     */
     load(): () => void;
+    /**
+     * Handles an event callback via the `ActionEventRegistrar`
+     */
     protected handleEventCallback(data: {
         id?: string;
         data: unknown;
     }): void;
-    protected handleLocationChanged(data: RegisterChangedEvent): void;
+    /**
+     * Updates the cached location data
+     */
+    protected handleLocationChanged(data: RegisterChangedEvent): undefined;
+    /**
+     * @inheritDoc
+     */
     getAuthenticationKey(): string;
+    /**
+     * Checks whether `data` is formatted as a sale event
+     */
     protected dataIsSaleEvent(data: Record<string, unknown>): data is {
         requestId: string;
         saleState: ShopfrontSaleState | false;
     };
     /**
-     * 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
      */
     getCurrentSale(): Promise<CurrentSale | false>;
+    /**
+     * Checks whether `data` is formatted as response data from a 'create sale' request
+     */
     protected dataIsCreateEvent(data: Record<string, unknown>): data is {
         requestId: string;
         success: boolean;
         message?: string;
     };
     /**
-     * Send the sale to be created on shopfront.
-     *
-     * @param sale
+     * @inheritDoc
      */
     createSale(sale: Sale): Promise<{
         success: boolean;
         message?: string;
     }>;
+    /**
+     * Checks whether `data` is formatted as location data
+     */
     protected dataIsLocation(data: Record<string, unknown>): data is {
         requestId: string;
         register: string | null;
@@ -92,62 +103,87 @@ export declare class Application {
         user: string | null;
     };
     /**
-     * Get the location from Shopfront
+     * @inheritDoc
      */
     getLocation(): Promise<{
         register: string | null;
         outlet: string | null;
         user: string | null;
     }>;
+    /**
+     * @inheritDoc
+     */
     printReceipt(content: string): void;
+    /**
+     * @inheritDoc
+     */
     changeSellScreenActionMode(mode: SellScreenActionMode): void;
+    /**
+     * @inheritDoc
+     */
     changeSellScreenSummaryMode(mode: SellScreenSummaryMode): void;
+    /**
+     * Checks whether `data` is formatted as an audio response
+     */
     protected dataIsAudioResponse(data: Record<string, unknown>): data is {
         requestId: string;
         success: boolean;
         message?: string;
     };
-    protected sendAudioRequest(type: SoundEvents, data?: unknown): Promise<{
-        success: boolean;
-        message?: string;
-    }>;
     /**
-     * Requests permission from the user to be able to play audio
+     * Sends an audio request to Shopfront
      */
-    requestAudioPermission(): Promise<{
-        success: boolean;
-        message?: string;
-    }>;
+    protected sendAudioRequest(type: SoundEvents, data?: unknown): Promise<ShopfrontResponse>;
     /**
-     * Requests shopfront to preload audio so that it can be pre-cached before being played
-     * @param url
+     * @inheritDoc
      */
-    audioPreload(url: string): Promise<{
-        success: boolean;
-        message?: string;
-    }>;
+    requestAudioPermission(): Promise<ShopfrontResponse>;
     /**
-     * Requests the sound to be played
-     * @param url
+     * @inheritDoc
+     */
+    audioPreload(url: string): Promise<ShopfrontResponse>;
+    /**
+     * @inheritDoc
+     */
+    audioPlay(url: string): Promise<ShopfrontResponse>;
+    /**
+     * Checks whether `data` is formatted as response data to a 'get option' request
      */
-    audioPlay(url: string): Promise<{
-        success: boolean;
-        message?: string;
-    }>;
     protected dataIsOption<TValueType>(data: Record<string, unknown>): data is {
         requestId: string;
         option: string;
         value: TValueType | undefined;
     };
+    /**
+     * @inheritDoc
+     */
     getOption<TValueType>(option: string, defaultValue: TValueType): Promise<TValueType>;
+    /**
+     * Checks whether `data` is formatted as response data to an embedded token request
+     */
     protected dataIsEmbeddedToken(data: Record<string, unknown>): data is {
         requestId: string;
         data: BufferSource;
         signature: BufferSource;
     };
+    /**
+     * Generates a signing key and sends it to Shopfront
+     */
     protected generateSigningKey(): Promise<void>;
+    /**
+     * Decodes the embedded token response from Shopfront using the signing key
+     */
     protected decodeToken(signature: BufferSource, data: BufferSource, returnTokenObject?: boolean): Promise<ShopfrontEmbeddedVerificationToken | string>;
+    /**
+     * Checks whether `data` is an error response from an embedded token request
+     */
     protected tokenDataContainsErrors(data: unknown): data is ShopfrontEmbeddedTokenError;
+    /**
+     * @inheritDoc
+     */
     getToken(returnTokenObject: true): Promise<ShopfrontEmbeddedVerificationToken>;
+    /**
+     * @inheritDoc
+     */
     getToken(returnTokenObject?: false): Promise<string>;
 }