@shopfront/bridge 3.0.2 → 3.0.3--canary.21.f9983a3.0

package/lib/APIs/InternalMessages/InternalMessageSource.d.ts

@@ -1,5 +1,5 @@
 import { Application } from "../../Application.js";
-import { type FromShopfront } from "../../ApplicationEvents.js";
+import { type FromShopfront } from "../../ApplicationEvents/ToShopfront.js";
 export type InternalPageMessageMethod = keyof FromShopfront | "EXTERNAL_APPLICATION";
 export declare class InternalMessageSource {
     protected application: Application;

package/lib/APIs/Sale/index.d.ts

@@ -1,4 +1,4 @@
-export type { SaleData, SalePaymentData, SaleProductData, } from "../../Utilities/SaleCreate.js";
+export type { SaleData as SaleCreateData, SalePaymentData as SaleCreatePaymentData, SaleProductData as SaleCreateProductData, } from "../../Utilities/SaleCreate.js";
 export { BaseSale } from "./BaseSale.js";
 export * as Exceptions from "./Exceptions.js";
 export { Sale } from "./Sale.js";

package/lib/Actions/index.d.ts

@@ -0,0 +1,6 @@
+export { Button } from "./Button.js";
+export { Dialog } from "./Dialog.js";
+export { Redirect } from "./Redirect.js";
+export { SaleKey } from "./SaleKey.js";
+export { Toast, type ToastType } from "./Toast.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/Application.d.ts

@@ -1,7 +1,8 @@
 import { CurrentSale } from "./APIs/Sale/CurrentSale.js";
 import { Sale, type ShopfrontSaleState } from "./APIs/Sale/index.js";
-import { type DirectShopfrontEvent, type FromShopfront, type FromShopfrontInternal, type ListenableFromShopfrontEvent, type RegisterChangedEvent, type SellScreenActionMode, type SellScreenSummaryMode, type SoundEvents } from "./ApplicationEvents.js";
-import { BaseApplication, type ShopfrontEmbeddedTokenError, type ShopfrontEmbeddedVerificationToken, type ShopfrontResponse } from "./BaseApplication.js";
+import { type DirectShopfrontEvent } from "./ApplicationEvents/DirectShopfront.js";
+import { type FromShopfront, type FromShopfrontInternal, type ListenableFromShopfrontEvent, type RegisterChangedEvent, type SoundEvents } from "./ApplicationEvents/ToShopfront.js";
+import { BaseApplication, type SellScreenActionMode, type SellScreenSummaryMode, type ShopfrontEmbeddedTokenError, type ShopfrontEmbeddedVerificationToken, type ShopfrontResponse } from "./BaseApplication.js";
 import { Bridge, type JavaScriptCommunicatorExports } from "./Bridge.js";
 import { type Serializable } from "./Common/Serializable.js";
 import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent.js";

package/lib/ApplicationEvents/DirectShopfront.d.ts

@@ -0,0 +1,64 @@
+import { SaleAddCustomer } from "../Events/DirectEvents/SaleAddCustomer.js";
+import { SaleAddProduct } from "../Events/DirectEvents/SaleAddProduct.js";
+import { SaleChangeQuantity } from "../Events/DirectEvents/SaleChangeQuantity.js";
+import { SaleClear } from "../Events/DirectEvents/SaleClear.js";
+import { SaleRemoveCustomer } from "../Events/DirectEvents/SaleRemoveCustomer.js";
+import { SaleRemoveProduct } from "../Events/DirectEvents/SaleRemoveProduct.js";
+import { SaleUpdateProducts } from "../Events/DirectEvents/SaleUpdateProducts.js";
+import type { SaleEventProduct } from "../Events/DirectEvents/types/SaleEventData.js";
+import type { MaybePromise } from "../Utilities/MiscTypes.js";
+import type { ListenableFromShopfrontEvent } from "./ToShopfront.js";
+export interface SaleAddProductEvent {
+    product: SaleEventProduct;
+    indexAddress: Array<number>;
+}
+export interface SaleRemoveProductEvent {
+    indexAddress: Array<number>;
+}
+export interface SaleChangeQuantityEvent {
+    indexAddress: Array<number>;
+    amount: number;
+    absolute: boolean;
+}
+export interface SaleUpdateProductsEvent {
+    products: Array<SaleEventProduct>;
+}
+export interface SaleAddCustomerEvent {
+    customer: {
+        uuid: string;
+    };
+}
+export interface DirectShopfrontEventData {
+    SALE_ADD_PRODUCT: SaleAddProductEvent;
+    SALE_REMOVE_PRODUCT: SaleRemoveProductEvent;
+    SALE_CHANGE_QUANTITY: SaleChangeQuantityEvent;
+    SALE_UPDATE_PRODUCTS: SaleUpdateProductsEvent;
+    SALE_ADD_CUSTOMER: SaleAddCustomerEvent;
+    SALE_REMOVE_CUSTOMER: undefined;
+    SALE_CLEAR: undefined;
+}
+export interface DirectShopfrontCallbacks {
+    SALE_ADD_PRODUCT: (event: DirectShopfrontEventData["SALE_ADD_PRODUCT"]) => MaybePromise<void>;
+    SALE_REMOVE_PRODUCT: (event: DirectShopfrontEventData["SALE_REMOVE_PRODUCT"]) => MaybePromise<void>;
+    SALE_CHANGE_QUANTITY: (event: DirectShopfrontEventData["SALE_CHANGE_QUANTITY"]) => MaybePromise<void>;
+    SALE_UPDATE_PRODUCTS: (event: DirectShopfrontEventData["SALE_UPDATE_PRODUCTS"]) => MaybePromise<void>;
+    SALE_ADD_CUSTOMER: (event: DirectShopfrontEventData["SALE_ADD_CUSTOMER"]) => MaybePromise<void>;
+    SALE_REMOVE_CUSTOMER: () => MaybePromise<void>;
+    SALE_CLEAR: () => MaybePromise<void>;
+}
+export interface DirectShopfront {
+    SALE_ADD_PRODUCT: SaleAddProduct;
+    SALE_REMOVE_PRODUCT: SaleRemoveProduct;
+    SALE_CHANGE_QUANTITY: SaleChangeQuantity;
+    SALE_UPDATE_PRODUCTS: SaleUpdateProducts;
+    SALE_ADD_CUSTOMER: SaleAddCustomer;
+    SALE_REMOVE_CUSTOMER: SaleRemoveCustomer;
+    SALE_CLEAR: SaleClear;
+}
+export type DirectShopfrontEvent = keyof DirectShopfront;
+export declare const directShopfrontEvents: Array<DirectShopfrontEvent>;
+/**
+ * Checks whether the event is a direct Shopfront event
+ */
+export declare const isDirectShopfrontEvent: (event: DirectShopfrontEvent | ListenableFromShopfrontEvent) => event is DirectShopfrontEvent;
+//# sourceMappingURL=DirectShopfront.d.ts.map

package/lib/ApplicationEvents/ToShopfront.d.ts

@@ -0,0 +1,268 @@
+import { Button } from "../Actions/Button.js";
+import { SaleKey } from "../Actions/SaleKey.js";
+import { type OrderDetails } from "../APIs/Fulfilment/FulfilmentTypes.js";
+import { InternalMessageSource } from "../APIs/InternalMessages/InternalMessageSource.js";
+import { Sale, type 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, type 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, type SellScreenCustomerListOption } from "../Events/RequestCustomerListOptions.js";
+import { RequestSaleKeys } from "../Events/RequestSaleKeys.js";
+import { RequestSellScreenOptions, type SellScreenOption } from "../Events/RequestSellScreenOptions.js";
+import { RequestSettings } from "../Events/RequestSettings.js";
+import { RequestTableColumns } from "../Events/RequestTableColumns.js";
+import { type CompletedSale, SaleComplete } from "../Events/SaleComplete.js";
+import { UIPipeline } from "../Events/UIPipeline.js";
+import { type MaybePromise } from "../Utilities/MiscTypes.js";
+export declare enum ToShopfront {
+    READY = "READY",
+    SERIALIZED = "SERIALIZED",
+    RESPONSE_BUTTONS = "RESPONSE_BUTTONS",
+    RESPONSE_SETTINGS = "RESPONSE_SETTINGS",
+    RESPONSE_TABLE_COLUMNS = "RESPONSE_TABLE_COLUMNS",
+    RESPONSE_SELL_SCREEN_OPTIONS = "RESPONSE_SELL_SCREEN_OPTIONS",
+    DOWNLOAD = "DOWNLOAD",
+    LOAD = "LOAD",
+    REQUEST_CURRENT_SALE = "REQUEST_CURRENT_SALE",
+    DATABASE_REQUEST = "DATABASE_REQUEST",
+    UNSUPPORTED_EVENT = "UNSUPPORTED_EVENT",
+    NOT_LISTENING_TO_EVENT = "NOT_LISTENING_TO_EVENT",
+    REQUEST_LOCATION = "REQUEST_LOCATION",
+    RESPONSE_FORMAT_PRODUCT = "RESPONSE_FORMAT_PRODUCT",
+    RESPONSE_CUSTOMER_LIST_OPTIONS = "RESPONSE_CUSTOMER_LIST_OPTIONS",
+    RESPONSE_SALE_KEYS = "RESPONSE_SALE_KEYS",
+    PRINT_RECEIPT = "PRINT_RECEIPT",
+    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",
+    AUDIO_PRELOAD = "AUDIO_PRELOAD",
+    AUDIO_PLAY = "AUDIO_PLAY",
+    CHANGE_SELL_SCREEN_ACTION_MODE = "CHANGE_SELL_SCREEN_ACTION_MODE",
+    CHANGE_SELL_SCREEN_SUMMARY_MODE = "CHANGE_SELL_SCREEN_SUMMARY_MODE",
+    SELL_SCREEN_OPTION_CHANGE = "SELL_SCREEN_OPTION_CHANGE",
+    INTERNAL_PAGE_MESSAGE = "INTERNAL_PAGE_MESSAGE",
+    TABLE_UPDATE = "TABLE_UPDATE",
+    PIPELINE_TRIGGER = "PIPELINE_TRIGGER",
+    SELL_SCREEN_PROMOTION_APPLICABLE = "SELL_SCREEN_PROMOTION_APPLICABLE",
+    FULFILMENT_OPT_IN = "FULFILMENT_OPT_IN",
+    FULFILMENT_OPTIONS = "FULFILMENT_OPTIONS",
+    FULFILMENT_ORDERS_SYNC = "FULFILMENT_ORDERS_SYNC",
+    FULFILMENT_ORDERS_CREATE = "FULFILMENT_ORDERS_CREATE",
+    FULFILMENT_ORDERS_UPDATE = "FULFILMENT_ORDERS_UPDATE",
+    FULFILMENT_ORDERS_CANCEL = "FULFILMENT_ORDERS_CANCEL",
+    CREATE_SALE = "CREATE_SALE",
+    FULFILMENT_GET_ORDER = "FULFILMENT_GET_ORDER"
+}
+export interface SellScreenPaymentMethod {
+    uuid: string;
+    name: string;
+    type: "global" | "cash" | "eftpos" | "giftcard" | "voucher" | "cheque" | "pc-eftpos" | "linkly-vaa" | "direct-deposit" | "tyro" | "custom";
+    default_pay_exact: boolean;
+    background_colour?: string;
+    text_colour?: string;
+}
+export type SoundEvents = ToShopfront.AUDIO_REQUEST_PERMISSION | ToShopfront.AUDIO_PRELOAD | ToShopfront.AUDIO_PLAY;
+export interface UIPipelineData {
+    name: string;
+    content: string;
+}
+export interface RequestSettingsResponse {
+    logo?: string;
+    description?: string;
+    url?: string;
+    html?: string;
+}
+export type RequestButtonsResponse = Array<Button>;
+export type RequestTableColumnsResponse = null | {
+    headers: Array<{
+        label: string;
+        key: string;
+        weight: number;
+    }>;
+    body: Array<Record<string, string>>;
+    footer: Record<string, string>;
+};
+export type RequestSellScreenOptionsResponse = Array<SellScreenOption>;
+export type FormatIntegratedProductResponse = FormatIntegratedProductEvent;
+export type RequestCustomerListOptionsResponse = Array<SellScreenCustomerListOption>;
+export type RequestSaleKeysResponse = Array<SaleKey>;
+export type UIPipelineResponse = Array<UIPipelineData>;
+export type PaymentMethodsEnabledResponse = Array<SellScreenPaymentMethod>;
+export type FulfilmentGetOrderResponse = OrderDetails;
+export interface GiftCardCodeCheckResponse {
+    code: string;
+    message: string | null;
+}
+interface InternalShopfrontResponse {
+    requestId: string;
+}
+export interface ResponseCurrentSaleResponse extends InternalShopfrontResponse {
+    saleState: ShopfrontSaleState;
+}
+export interface ResponseLocationResponse extends InternalShopfrontResponse {
+    register: string | null;
+    outlet: string | null;
+    user: string | null;
+}
+interface GenericRequestResponse extends InternalShopfrontResponse {
+    success: boolean;
+    message?: string;
+}
+export type ResponseAudioRequestResponse = GenericRequestResponse;
+export type ResponseCreateSaleResponse = GenericRequestResponse;
+export interface FromShopfrontResponse {
+    READY: unknown;
+    REQUEST_SETTINGS: RequestSettingsResponse;
+    REQUEST_BUTTONS: RequestButtonsResponse;
+    REQUEST_TABLE_COLUMNS: RequestTableColumnsResponse;
+    REQUEST_SELL_SCREEN_OPTIONS: RequestSellScreenOptionsResponse;
+    CALLBACK: unknown;
+    RESPONSE_CURRENT_SALE: ResponseCurrentSaleResponse;
+    INTERNAL_PAGE_MESSAGE: unknown;
+    REGISTER_CHANGED: unknown;
+    RESPONSE_LOCATION: ResponseLocationResponse;
+    RESPONSE_AUDIO_REQUEST: ResponseAudioRequestResponse;
+    FORMAT_INTEGRATED_PRODUCT: FormatIntegratedProductResponse;
+    REQUEST_CUSTOMER_LIST_OPTIONS: RequestCustomerListOptionsResponse;
+    REQUEST_SALE_KEYS: RequestSaleKeysResponse;
+    SALE_COMPLETE: unknown;
+    UI_PIPELINE: UIPipelineResponse;
+    PAYMENT_METHODS_ENABLED: PaymentMethodsEnabledResponse;
+    AUDIO_READY: unknown;
+    AUDIO_PERMISSION_CHANGE: unknown;
+    FULFILMENT_GET_ORDER: FulfilmentGetOrderResponse;
+    FULFILMENT_VOID_ORDER: unknown;
+    FULFILMENT_PROCESS_ORDER: unknown;
+    FULFILMENT_ORDER_APPROVAL: unknown;
+    FULFILMENT_ORDER_COLLECTED: unknown;
+    FULFILMENT_ORDER_COMPLETED: unknown;
+    RESPONSE_CREATE_SALE: ResponseCreateSaleResponse;
+    GIFT_CARD_CODE_CHECK: GiftCardCodeCheckResponse;
+}
+export interface InternalPageMessageEvent {
+    method: "REQUEST_SETTINGS" | "REQUEST_SELL_SCREEN_OPTIONS" | "EXTERNAL_APPLICATION";
+    url: string;
+    message: unknown;
+    reference: InternalMessageSource;
+}
+export interface RegisterChangedEvent {
+    register: null | string;
+    outlet: null | string;
+    user: null | string;
+}
+export interface GiftCardCodeCheckEvent {
+    code: string;
+    message: string | null;
+}
+export interface FormatIntegratedProductEvent {
+    product: FormattedSaleProduct;
+}
+export interface SaleCompletedEvent {
+    sale: CompletedSale;
+}
+export interface AudioPermissionChangeEvent {
+    permitted: boolean;
+}
+export interface FulfilmentProcessEvent {
+    id: string;
+    sale: Sale;
+}
+export interface FulfilmentApprovalEvent {
+    id: string;
+    approved: boolean;
+}
+export type UIPipelineEvent = Array<UIPipelineData>;
+export interface UIPipelineBaseContext {
+    location: string;
+}
+export interface UIPipelineContext extends UIPipelineBaseContext {
+    trigger?: () => void;
+}
+export type PaymentMethodsEnabledEvent = Array<SellScreenPaymentMethod>;
+export interface PaymentMethodEnabledContext {
+    register: string;
+    customer: false | {
+        uuid: string;
+    };
+}
+export interface FromShopfrontCallbacks {
+    READY: (event: RegisterChangedEvent) => MaybePromise<FromShopfrontResponse["READY"]>;
+    REQUEST_SETTINGS: () => MaybePromise<FromShopfrontResponse["REQUEST_SETTINGS"]>;
+    REQUEST_BUTTONS: (location: string, context: unknown) => MaybePromise<FromShopfrontResponse["REQUEST_BUTTONS"]>;
+    REQUEST_TABLE_COLUMNS: (location: string, data: unknown) => MaybePromise<FromShopfrontResponse["REQUEST_TABLE_COLUMNS"]>;
+    REQUEST_SELL_SCREEN_OPTIONS: () => MaybePromise<FromShopfrontResponse["REQUEST_SELL_SCREEN_OPTIONS"]>;
+    INTERNAL_PAGE_MESSAGE: (event: InternalPageMessageEvent) => MaybePromise<FromShopfrontResponse["INTERNAL_PAGE_MESSAGE"]>;
+    REGISTER_CHANGED: (event: RegisterChangedEvent) => MaybePromise<FromShopfrontResponse["REGISTER_CHANGED"]>;
+    CALLBACK: () => MaybePromise<FromShopfrontResponse["CALLBACK"]>;
+    FORMAT_INTEGRATED_PRODUCT: (event: FormatIntegratedProductEvent) => MaybePromise<FromShopfrontResponse["FORMAT_INTEGRATED_PRODUCT"]>;
+    REQUEST_CUSTOMER_LIST_OPTIONS: () => MaybePromise<FromShopfrontResponse["REQUEST_CUSTOMER_LIST_OPTIONS"]>;
+    REQUEST_SALE_KEYS: () => MaybePromise<FromShopfrontResponse["REQUEST_SALE_KEYS"]>;
+    SALE_COMPLETE: (event: SaleCompletedEvent) => MaybePromise<FromShopfrontResponse["SALE_COMPLETE"]>;
+    UI_PIPELINE: (event: UIPipelineEvent, context: UIPipelineContext) => MaybePromise<FromShopfrontResponse["UI_PIPELINE"]>;
+    PAYMENT_METHODS_ENABLED: (event: PaymentMethodsEnabledEvent, context: PaymentMethodEnabledContext) => MaybePromise<FromShopfrontResponse["PAYMENT_METHODS_ENABLED"]>;
+    AUDIO_READY: () => MaybePromise<FromShopfrontResponse["AUDIO_READY"]>;
+    AUDIO_PERMISSION_CHANGE: (event: AudioPermissionChangeEvent) => MaybePromise<FromShopfrontResponse["AUDIO_PERMISSION_CHANGE"]>;
+    FULFILMENT_GET_ORDER: (id: string) => MaybePromise<FromShopfrontResponse["FULFILMENT_GET_ORDER"]>;
+    FULFILMENT_VOID_ORDER: (id: string) => MaybePromise<FromShopfrontResponse["FULFILMENT_VOID_ORDER"]>;
+    FULFILMENT_PROCESS_ORDER: (event: FulfilmentProcessEvent) => MaybePromise<FromShopfrontResponse["FULFILMENT_PROCESS_ORDER"]>;
+    FULFILMENT_ORDER_APPROVAL: (event: FulfilmentApprovalEvent) => MaybePromise<FromShopfrontResponse["FULFILMENT_ORDER_APPROVAL"]>;
+    FULFILMENT_ORDER_COLLECTED: (id: string) => MaybePromise<FromShopfrontResponse["FULFILMENT_ORDER_COLLECTED"]>;
+    FULFILMENT_ORDER_COMPLETED: (id: string) => MaybePromise<FromShopfrontResponse["FULFILMENT_ORDER_COMPLETED"]>;
+    GIFT_CARD_CODE_CHECK: (event: GiftCardCodeCheckEvent, context: unknown) => MaybePromise<FromShopfrontResponse["GIFT_CARD_CODE_CHECK"]>;
+}
+export interface FromShopfront {
+    READY: Ready;
+    REQUEST_SETTINGS: RequestSettings;
+    REQUEST_BUTTONS: RequestButtons;
+    REQUEST_TABLE_COLUMNS: RequestTableColumns;
+    REQUEST_SELL_SCREEN_OPTIONS: RequestSellScreenOptions;
+    CALLBACK: Callback;
+    INTERNAL_PAGE_MESSAGE: InternalPageMessage;
+    REGISTER_CHANGED: RegisterChanged;
+    FORMAT_INTEGRATED_PRODUCT: FormatIntegratedProduct;
+    REQUEST_CUSTOMER_LIST_OPTIONS: RequestCustomerListOptions;
+    SALE_COMPLETE: SaleComplete;
+    REQUEST_SALE_KEYS: RequestSaleKeys;
+    UI_PIPELINE: UIPipeline;
+    PAYMENT_METHODS_ENABLED: PaymentMethodsEnabled;
+    AUDIO_READY: AudioReady;
+    AUDIO_PERMISSION_CHANGE: AudioPermissionChange;
+    FULFILMENT_GET_ORDER: FulfilmentGetOrder;
+    FULFILMENT_VOID_ORDER: FulfilmentVoidOrder;
+    FULFILMENT_PROCESS_ORDER: FulfilmentProcessOrder;
+    FULFILMENT_ORDER_APPROVAL: FulfilmentOrderApproval;
+    FULFILMENT_ORDER_COLLECTED: FulfilmentCollectOrder;
+    FULFILMENT_ORDER_COMPLETED: FulfilmentCompleteOrder;
+    GIFT_CARD_CODE_CHECK: GiftCardCodeCheck;
+}
+export type ListenableFromShopfrontEvent = keyof Omit<FromShopfront, "CALLBACK">;
+export interface FromShopfrontInternal {
+    CYCLE_KEY: "CYCLE_KEY";
+    LOCATION_CHANGED: "LOCATION_CHANGED";
+    RESPONSE_CURRENT_SALE: "RESPONSE_CURRENT_SALE";
+    RESPONSE_DATABASE_REQUEST: "RESPONSE_DATABASE_REQUEST";
+    RESPONSE_LOCATION: "RESPONSE_LOCATION";
+    RESPONSE_OPTION: "RESPONSE_OPTION";
+    RESPONSE_AUDIO_REQUEST: "RESPONSE_AUDIO_REQUEST";
+    RESPONSE_SECURE_KEY: "RESPONSE_SECURE_KEY";
+    RESPONSE_CREATE_SALE: "RESPONSE_CREATE_SALE";
+}
+export {};
+//# sourceMappingURL=ToShopfront.d.ts.map

package/lib/ApplicationEvents/index.d.ts

@@ -0,0 +1,3 @@
+export type { SaleAddCustomerEvent, SaleAddProductEvent, SaleChangeQuantityEvent, SaleRemoveProductEvent, SaleUpdateProductsEvent, } from "./DirectShopfront.js";
+export type { AudioPermissionChangeEvent, FormatIntegratedProductEvent, FormatIntegratedProductResponse, FulfilmentApprovalEvent, FulfilmentGetOrderResponse, FulfilmentProcessEvent, GiftCardCodeCheckEvent, GiftCardCodeCheckResponse, InternalPageMessageEvent, PaymentMethodEnabledContext, PaymentMethodsEnabledEvent, PaymentMethodsEnabledResponse, RegisterChangedEvent, RequestButtonsResponse, RequestCustomerListOptionsResponse, RequestSaleKeysResponse, RequestSellScreenOptionsResponse, RequestSettingsResponse, RequestTableColumnsResponse, UIPipelineContext, UIPipelineEvent, UIPipelineResponse, } from "./ToShopfront.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/BaseApplication.d.ts

@@ -1,7 +1,8 @@
 import type { BaseDatabase } from "./APIs/Database/BaseDatabase.js";
 import type { BaseCurrentSale } from "./APIs/Sale/BaseCurrentSale.js";
 import type { Sale } from "./APIs/Sale/index.js";
-import { type DirectShopfront, type DirectShopfrontCallbacks, type DirectShopfrontEvent, type FromShopfront, type FromShopfrontCallbacks, type FromShopfrontInternal, type ListenableFromShopfrontEvent, type RegisterChangedEvent, type SellScreenActionMode, type SellScreenSummaryMode, type SoundEvents } from "./ApplicationEvents.js";
+import { type DirectShopfront, type DirectShopfrontCallbacks, type DirectShopfrontEvent } from "./ApplicationEvents/DirectShopfront.js";
+import { type FromShopfront, type FromShopfrontCallbacks, type FromShopfrontInternal, type ListenableFromShopfrontEvent, type RegisterChangedEvent, type SoundEvents } from "./ApplicationEvents/ToShopfront.js";
 import type { BaseBridge } from "./BaseBridge.js";
 import type { Serializable } from "./Common/Serializable.js";
 import type { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent.js";
@@ -29,6 +30,8 @@ export declare class ShopfrontTokenDecodingError extends Error {
 }
 export declare class ShopfrontTokenRequestError extends Error {
 }
+export type SellScreenActionMode = "search" | "keys" | "held-sales" | "payment" | "customers" | "promotions" | "show-backorders" | "fulfilment-orders";
+export type SellScreenSummaryMode = "transaction" | "payments" | "receipts";
 export declare abstract class BaseApplication {
     protected bridge: BaseBridge;
     protected isReady: boolean;

package/lib/BaseBridge.d.ts

@@ -1,5 +1,5 @@
-import * as ApplicationEvents from "./ApplicationEvents.js";
-export type ApplicationEventListener = (event: keyof ApplicationEvents.FromShopfront | keyof ApplicationEvents.FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
+import { type FromShopfront, type FromShopfrontInternal, ToShopfront } from "./ApplicationEvents/ToShopfront.js";
+export type ApplicationEventListener = (event: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
 export declare abstract class BaseBridge {
     key: string;
     url: URL;
@@ -22,7 +22,7 @@ export declare abstract class BaseBridge {
     /**
      * Sends an event to Shopfront
      */
-    abstract sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    abstract sendMessage(type: ToShopfront, data?: unknown, id?: string): void;
     /**
      * Adds a listener for a Shopfront event
      */

package/lib/Bridge.d.ts

@@ -1,5 +1,5 @@
 import { Application } from "./Application.js";
-import * as ApplicationEvents from "./ApplicationEvents.js";
+import { type FromShopfront, type FromShopfrontInternal, ToShopfront } from "./ApplicationEvents/ToShopfront.js";
 import { type ApplicationEventListener, BaseBridge } from "./BaseBridge.js";
 interface FrameApplicationOptions {
     id: string;
@@ -17,7 +17,7 @@ type JavaScriptSendMessageCallback = (message: {
     data: unknown;
     id?: string;
 }) => void;
-export type JavaScriptReceiveMessageCallback = (type: keyof ApplicationEvents.FromShopfront | keyof ApplicationEvents.FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
+export type JavaScriptReceiveMessageCallback = (type: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string) => void;
 export interface JavaScriptCommunicatorExports {
     execute: () => void;
     registerSendMessage: (callback: JavaScriptSendMessageCallback) => void;
@@ -51,7 +51,7 @@ export declare class Bridge extends BaseBridge {
     /**
      * Emit an event to the currently registered listeners
      */
-    protected emitToListeners(type: keyof ApplicationEvents.FromShopfront | keyof ApplicationEvents.FromShopfrontInternal, data: Record<string, unknown>, id: string): void;
+    protected emitToListeners(type: keyof FromShopfront | keyof FromShopfrontInternal, data: Record<string, unknown>, id: string): void;
     /**
      * Receive a message from the application frame and distribute it to the correct listener
      */
@@ -59,11 +59,11 @@ export declare class Bridge extends BaseBridge {
     /**
      * Send a message via the JavaScript communicator
      */
-    protected sendMessageViaJavaScript(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    protected sendMessageViaJavaScript(type: ToShopfront, data?: unknown, id?: string): void;
     /**
      * @inheritDoc
      */
-    sendMessage(type: ApplicationEvents.ToShopfront, data?: unknown, id?: string): void;
+    sendMessage(type: ToShopfront, data?: unknown, id?: string): void;
     /**
      * @inheritDoc
      */

package/lib/EmitableEvents/BaseEmitableEvent.d.ts

@@ -1,4 +1,4 @@
-import { ToShopfront } from "../ApplicationEvents.js";
+import { ToShopfront } from "../ApplicationEvents/ToShopfront.js";
 export declare class BaseEmitableEvent<T> {
     protected eventName: ToShopfront;
     protected eventData: T;

package/lib/EmitableEvents/TableUpdate.d.ts

@@ -1,9 +1,9 @@
-import { type FromShopfrontReturns } from "../ApplicationEvents.js";
+import { type FromShopfrontResponse } from "../ApplicationEvents/ToShopfront.js";
 import { BaseEmitableEvent } from "./BaseEmitableEvent.js";
 export declare class TableUpdate extends BaseEmitableEvent<{
     location: string;
-    data: Exclude<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"], null>;
+    data: Exclude<FromShopfrontResponse["REQUEST_TABLE_COLUMNS"], null>;
 }> {
-    constructor(location: string, columns: Exclude<FromShopfrontReturns["REQUEST_TABLE_COLUMNS"], null>);
+    constructor(location: string, columns: Exclude<FromShopfrontResponse["REQUEST_TABLE_COLUMNS"], null>);
 }
 //# sourceMappingURL=TableUpdate.d.ts.map

package/lib/EmitableEvents/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./Fulfilment/index.js";
+export { InternalMessage } from "./InternalMessage.js";
+export { SellScreenOption } from "./SellScreenOption.js";
+export { SellScreenPromotionApplicable } from "./SellScreenPromotionApplicable.js";
+export { TableUpdate } from "./TableUpdate.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/Events/AudioPermissionChange.d.ts

@@ -1,10 +1,10 @@
-import type { AudioPermissionChangeEvent, FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents.js";
+import type { AudioPermissionChangeEvent, FromShopfrontCallbacks, FromShopfrontResponse } from "../ApplicationEvents/ToShopfront.js";
 import { BaseEvent } from "./BaseEvent.js";
 export declare class AudioPermissionChange extends BaseEvent<AudioPermissionChangeEvent> {
     constructor(callback: FromShopfrontCallbacks["AUDIO_PERMISSION_CHANGE"]);
     /**
      * @inheritDoc
      */
-    emit(data: AudioPermissionChangeEvent): Promise<FromShopfrontReturns["AUDIO_PERMISSION_CHANGE"]>;
+    emit(data: AudioPermissionChangeEvent): Promise<FromShopfrontResponse["AUDIO_PERMISSION_CHANGE"]>;
 }
 //# sourceMappingURL=AudioPermissionChange.d.ts.map

package/lib/Events/AudioReady.d.ts

@@ -1,10 +1,10 @@
-import { type FromShopfrontCallbacks, type FromShopfrontReturns } from "../ApplicationEvents.js";
+import { type FromShopfrontCallbacks, type FromShopfrontResponse } from "../ApplicationEvents/ToShopfront.js";
 import { BaseEvent } from "./BaseEvent.js";
 export declare class AudioReady extends BaseEvent<undefined> {
     constructor(callback: FromShopfrontCallbacks["AUDIO_READY"]);
     /**
      * @inheritDoc
      */
-    emit(): Promise<FromShopfrontReturns["AUDIO_READY"]>;
+    emit(): Promise<FromShopfrontResponse["AUDIO_READY"]>;
 }
 //# sourceMappingURL=AudioReady.d.ts.map

package/lib/Events/Callback.d.ts

@@ -1,10 +1,10 @@
-import { type FromShopfrontCallbacks, type FromShopfrontReturns } from "../ApplicationEvents.js";
+import type { FromShopfrontCallbacks, FromShopfrontResponse } from "../ApplicationEvents/ToShopfront.js";
 import { BaseEvent } from "./BaseEvent.js";
 export declare class Callback extends BaseEvent {
     constructor(callback: FromShopfrontCallbacks["CALLBACK"]);
     /**
      * @inheritDoc
      */
-    emit(): Promise<FromShopfrontReturns["CALLBACK"]>;
+    emit(): Promise<FromShopfrontResponse["CALLBACK"]>;
 }
 //# sourceMappingURL=Callback.d.ts.map

package/lib/Events/DirectEvents/BaseDirectEvent.d.ts

@@ -1,4 +1,4 @@
-import type { DirectShopfrontCallbacks, DirectShopfrontEvent, DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEvent, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 export declare abstract class BaseDirectEvent<TEvent extends DirectShopfrontEvent, TData = DirectShopfrontEventData[TEvent], TCallback = DirectShopfrontCallbacks[TEvent]> {
     protected callback: TCallback;
     protected constructor(callback: TCallback);

package/lib/Events/DirectEvents/SaleAddCustomer.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleAddCustomer extends BaseDirectEvent<"SALE_ADD_CUSTOMER"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_ADD_CUSTOMER"]);

package/lib/Events/DirectEvents/SaleAddProduct.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleAddProduct extends BaseDirectEvent<"SALE_ADD_PRODUCT"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_ADD_PRODUCT"]);

package/lib/Events/DirectEvents/SaleChangeQuantity.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleChangeQuantity extends BaseDirectEvent<"SALE_CHANGE_QUANTITY"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_CHANGE_QUANTITY"]);

package/lib/Events/DirectEvents/SaleClear.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleClear extends BaseDirectEvent<"SALE_CLEAR"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_CLEAR"]);

package/lib/Events/DirectEvents/SaleRemoveCustomer.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleRemoveCustomer extends BaseDirectEvent<"SALE_REMOVE_CUSTOMER"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_REMOVE_CUSTOMER"]);

package/lib/Events/DirectEvents/SaleRemoveProduct.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleRemoveProduct extends BaseDirectEvent<"SALE_REMOVE_PRODUCT"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_REMOVE_PRODUCT"]);

package/lib/Events/DirectEvents/SaleUpdateProducts.d.ts

@@ -1,4 +1,4 @@
-import { type DirectShopfrontCallbacks, type DirectShopfrontEventData } from "../../ApplicationEvents.js";
+import type { DirectShopfrontCallbacks, DirectShopfrontEventData } from "../../ApplicationEvents/DirectShopfront.js";
 import { BaseDirectEvent } from "./BaseDirectEvent.js";
 export declare class SaleUpdateProducts extends BaseDirectEvent<"SALE_UPDATE_PRODUCTS"> {
     constructor(callback: DirectShopfrontCallbacks["SALE_UPDATE_PRODUCTS"]);

package/lib/Events/FormatIntegratedProduct.d.ts

@@ -1,4 +1,4 @@
-import { type FromShopfrontCallbacks, type FromShopfrontReturns } from "../ApplicationEvents.js";
+import { type FromShopfrontCallbacks, type FromShopfrontResponse } from "../ApplicationEvents/ToShopfront.js";
 import { BaseBridge } from "../BaseBridge.js";
 import { type MaybePromise } from "../Utilities/MiscTypes.js";
 import { BaseEvent } from "./BaseEvent.js";
@@ -64,16 +64,16 @@ interface FormattedIntegratedProductData {
     };
     context: Record<string, never>;
 }
-export declare class FormatIntegratedProduct extends BaseEvent<FormattedIntegratedProductData, MaybePromise<FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"]>, FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"], FormattedIntegratedProductData["data"], Record<string, never>> {
+export declare class FormatIntegratedProduct extends BaseEvent<FormattedIntegratedProductData, MaybePromise<FromShopfrontResponse["FORMAT_INTEGRATED_PRODUCT"]>, FromShopfrontResponse["FORMAT_INTEGRATED_PRODUCT"], FormattedIntegratedProductData["data"], Record<string, never>> {
     constructor(callback: FromShopfrontCallbacks["FORMAT_INTEGRATED_PRODUCT"]);
     /**
      * @inheritDoc
      */
-    emit(data: FormattedIntegratedProductData): Promise<FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"]>;
+    emit(data: FormattedIntegratedProductData): Promise<FromShopfrontResponse["FORMAT_INTEGRATED_PRODUCT"]>;
     /**
      * Sends the response data to Shopfront
      */
-    static respond(bridge: BaseBridge, data: Array<FromShopfrontReturns["FORMAT_INTEGRATED_PRODUCT"]>, id: string): Promise<void>;
+    static respond(bridge: BaseBridge, data: Array<FromShopfrontResponse["FORMAT_INTEGRATED_PRODUCT"]>, id: string): Promise<void>;
 }
 export {};
 //# sourceMappingURL=FormatIntegratedProduct.d.ts.map

package/lib/Events/FulfilmentCollectOrder.d.ts

@@ -1,10 +1,10 @@
-import { type FromShopfrontCallbacks, type FromShopfrontReturns } from "../ApplicationEvents.js";
+import type { FromShopfrontCallbacks, FromShopfrontResponse } from "../ApplicationEvents/ToShopfront.js";
 import { BaseEvent } from "./BaseEvent.js";
 export declare class FulfilmentCollectOrder extends BaseEvent {
     constructor(callback: FromShopfrontCallbacks["FULFILMENT_ORDER_COLLECTED"]);
     /**
      * @inheritDoc
      */
-    emit(data: string): Promise<FromShopfrontReturns["FULFILMENT_ORDER_COLLECTED"]>;
+    emit(data: string): Promise<FromShopfrontResponse["FULFILMENT_ORDER_COLLECTED"]>;
 }
 //# sourceMappingURL=FulfilmentCollectOrder.d.ts.map