@shopfront/bridge 1.16.0 → 1.18.2

package/lib/ApplicationEvents.d.ts

@@ -5,7 +5,7 @@ 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/CurrentSale/ShopfrontSaleState";
+import { ShopfrontSaleState } from "./APIs/Sale";
 import { InternalPageMessage } from "./Events/InternalPageMessage";
 import { InternalMessageSource } from "./APIs/InternalMessages/InternalMessageSource";
 import { RegisterChanged } from "./Events/RegisterChanged";
@@ -18,6 +18,14 @@ 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";
 export declare enum ToShopfront {
     READY = "READY",
     SERIALIZED = "SERIALIZED",
@@ -48,7 +56,15 @@ export declare enum ToShopfront {
     INTERNAL_PAGE_MESSAGE = "INTERNAL_PAGE_MESSAGE",
     TABLE_UPDATE = "TABLE_UPDATE",
     PIPELINE_TRIGGER = "PIPELINE_TRIGGER",
-    SELL_SCREEN_PROMOTION_APPLICABLE = "SELL_SCREEN_PROMOTION_APPLICABLE"
+    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 declare type SoundEvents = ToShopfront.AUDIO_REQUEST_PERMISSION | ToShopfront.AUDIO_PRELOAD | ToShopfront.AUDIO_PLAY;
 export interface FromShopfrontReturns {
@@ -98,6 +114,17 @@ export interface FromShopfrontReturns {
     UI_PIPELINE: Array<UIPipelineResponse>;
     PAYMENT_METHODS_ENABLED: Array<SellScreenPaymentMethod>;
     AUDIO_PERMISSION_CHANGE: void;
+    FULFILMENT_GET_ORDER: OrderDetails;
+    FULFILMENT_VOID_ORDER: void;
+    FULFILMENT_PROCESS_ORDER: void;
+    FULFILMENT_ORDER_APPROVAL: void;
+    FULFILMENT_ORDER_COLLECTED: void;
+    FULFILMENT_ORDER_COMPLETED: void;
+    RESPONSE_CREATE_SALE: {
+        requestId: string;
+        success: boolean;
+        message?: string;
+    };
 }
 export interface InternalPageMessageEvent {
     method: "REQUEST_SETTINGS" | "REQUEST_SELL_SCREEN_OPTIONS" | "EXTERNAL_APPLICATION";
@@ -119,6 +146,14 @@ export interface SaleCompletedEvent {
 export interface AudioPermissionChangeEvent {
     permitted: boolean;
 }
+export interface FulfilmentProcessEvent {
+    id: string;
+    sale: Sale;
+}
+export interface FulfilmentApprovalEvent {
+    id: string;
+    approved: boolean;
+}
 export declare type UIPipelineResponse = {
     name: string;
     content: string;
@@ -159,6 +194,12 @@ export interface FromShopfrontCallbacks {
     UI_PIPELINE: (event: Array<UIPipelineResponse>, context: UIPipelineContext) => MaybePromise<FromShopfrontReturns["UI_PIPELINE"]>;
     PAYMENT_METHODS_ENABLED: (event: Array<SellScreenPaymentMethod>, context: PaymentMethodEnabledContext) => MaybePromise<FromShopfrontReturns["PAYMENT_METHODS_ENABLED"]>;
     AUDIO_PERMISSION_CHANGE: (event: AudioPermissionChangeEvent) => MaybePromise<FromShopfrontReturns["AUDIO_PERMISSION_CHANGE"]>;
+    FULFILMENT_GET_ORDER: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_GET_ORDER"]>;
+    FULFILMENT_VOID_ORDER: (id: string) => MaybePromise<FromShopfrontReturns["FULFILMENT_VOID_ORDER"]>;
+    FULFILMENT_PROCESS_ORDER: (event: FulfilmentProcessEvent) => MaybePromise<FromShopfrontReturns["FULFILMENT_PROCESS_ORDER"]>;
+    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"]>;
 }
 export interface FromShopfront {
     READY: Ready;
@@ -176,6 +217,12 @@ export interface FromShopfront {
     UI_PIPELINE: UIPipeline;
     PAYMENT_METHODS_ENABLED: PaymentMethodsEnabled;
     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;
 }
 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];
@@ -188,4 +235,5 @@ export interface FromShopfrontInternal {
     RESPONSE_OPTION: "RESPONSE_OPTION";
     RESPONSE_AUDIO_REQUEST: "RESPONSE_AUDIO_REQUEST";
     RESPONSE_SECURE_KEY: "RESPONSE_SECURE_KEY";
+    RESPONSE_CREATE_SALE: "RESPONSE_CREATE_SALE";
 }

package/lib/ApplicationEvents.js

@@ -35,6 +35,17 @@ var ToShopfront;
     ToShopfront["TABLE_UPDATE"] = "TABLE_UPDATE";
     ToShopfront["PIPELINE_TRIGGER"] = "PIPELINE_TRIGGER";
     ToShopfront["SELL_SCREEN_PROMOTION_APPLICABLE"] = "SELL_SCREEN_PROMOTION_APPLICABLE";
+    // Fulfilment Emitable Events
+    ToShopfront["FULFILMENT_OPT_IN"] = "FULFILMENT_OPT_IN";
+    ToShopfront["FULFILMENT_OPTIONS"] = "FULFILMENT_OPTIONS";
+    ToShopfront["FULFILMENT_ORDERS_SYNC"] = "FULFILMENT_ORDERS_SYNC";
+    ToShopfront["FULFILMENT_ORDERS_CREATE"] = "FULFILMENT_ORDERS_CREATE";
+    ToShopfront["FULFILMENT_ORDERS_UPDATE"] = "FULFILMENT_ORDERS_UPDATE";
+    ToShopfront["FULFILMENT_ORDERS_CANCEL"] = "FULFILMENT_ORDERS_CANCEL";
+    // Sale API events
+    ToShopfront["CREATE_SALE"] = "CREATE_SALE";
+    // Fulfilment Response Events
+    ToShopfront["FULFILMENT_GET_ORDER"] = "FULFILMENT_GET_ORDER";
 })(ToShopfront = exports.ToShopfront || (exports.ToShopfront = {}));
 exports.directShopfrontEvents = [
     "SALE_ADD_PRODUCT",

package/lib/EmitableEvents/Fulfilment/Options.d.ts

@@ -0,0 +1,7 @@
+import { BaseEmitableEvent } from "../BaseEmitableEvent";
+export interface FulfilmentOptions {
+    requireApproval: boolean;
+}
+export declare class Options extends BaseEmitableEvent<FulfilmentOptions> {
+    constructor(options: FulfilmentOptions);
+}

package/lib/EmitableEvents/Fulfilment/Options.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Options = void 0;
+const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
+const ApplicationEvents_1 = require("../../ApplicationEvents");
+class Options extends BaseEmitableEvent_1.BaseEmitableEvent {
+    constructor(options) {
+        super(ApplicationEvents_1.ToShopfront.FULFILMENT_OPTIONS, options);
+    }
+}
+exports.Options = Options;

package/lib/EmitableEvents/Fulfilment/OrderCancel.d.ts

@@ -0,0 +1,6 @@
+import { BaseEmitableEvent } from "../BaseEmitableEvent";
+export declare class OrderCancel extends BaseEmitableEvent<{
+    id: string;
+}> {
+    constructor(id: string);
+}

package/lib/EmitableEvents/Fulfilment/OrderCancel.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderCancel = void 0;
+const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
+const ApplicationEvents_1 = require("../../ApplicationEvents");
+class OrderCancel extends BaseEmitableEvent_1.BaseEmitableEvent {
+    constructor(id) {
+        super(ApplicationEvents_1.ToShopfront.FULFILMENT_ORDERS_CANCEL, {
+            id,
+        });
+    }
+}
+exports.OrderCancel = OrderCancel;

package/lib/EmitableEvents/Fulfilment/OrderCreate.d.ts

@@ -0,0 +1,7 @@
+import { BaseEmitableEvent } from "../BaseEmitableEvent";
+import { OrderCreateDetails } from "../../APIs/Fulfilment/FulfilmentTypes";
+export declare class OrderCreate extends BaseEmitableEvent<{
+    order: OrderCreateDetails;
+}> {
+    constructor(order: OrderCreateDetails);
+}

package/lib/EmitableEvents/Fulfilment/OrderCreate.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderCreate = void 0;
+const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
+const ApplicationEvents_1 = require("../../ApplicationEvents");
+class OrderCreate extends BaseEmitableEvent_1.BaseEmitableEvent {
+    constructor(order) {
+        super(ApplicationEvents_1.ToShopfront.FULFILMENT_ORDERS_CREATE, {
+            order,
+        });
+    }
+}
+exports.OrderCreate = OrderCreate;

package/lib/EmitableEvents/Fulfilment/OrderUpdate.d.ts

@@ -0,0 +1,7 @@
+import { BaseEmitableEvent } from "../BaseEmitableEvent";
+import { OrderSummaryDetails } from "../../APIs/Fulfilment/FulfilmentTypes";
+export declare class OrderUpdate extends BaseEmitableEvent<{
+    order: OrderSummaryDetails;
+}> {
+    constructor(order: OrderSummaryDetails);
+}

package/lib/EmitableEvents/Fulfilment/OrderUpdate.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderUpdate = void 0;
+const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
+const ApplicationEvents_1 = require("../../ApplicationEvents");
+class OrderUpdate extends BaseEmitableEvent_1.BaseEmitableEvent {
+    constructor(order) {
+        super(ApplicationEvents_1.ToShopfront.FULFILMENT_ORDERS_UPDATE, {
+            order,
+        });
+    }
+}
+exports.OrderUpdate = OrderUpdate;

package/lib/EmitableEvents/Fulfilment/OrdersSync.d.ts

@@ -0,0 +1,8 @@
+import { BaseEmitableEvent } from "../BaseEmitableEvent";
+import { OrderCreateDetails } from "../../APIs/Fulfilment/FulfilmentTypes";
+export declare class OrdersSync extends BaseEmitableEvent<{
+    orders: Array<OrderCreateDetails>;
+    merge: boolean;
+}> {
+    constructor(orders: Array<OrderCreateDetails>, merge: boolean);
+}

package/lib/EmitableEvents/Fulfilment/OrdersSync.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrdersSync = void 0;
+const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
+const ApplicationEvents_1 = require("../../ApplicationEvents");
+class OrdersSync extends BaseEmitableEvent_1.BaseEmitableEvent {
+    constructor(orders, merge) {
+        super(ApplicationEvents_1.ToShopfront.FULFILMENT_ORDERS_SYNC, {
+            orders,
+            merge,
+        });
+    }
+}
+exports.OrdersSync = OrdersSync;

package/lib/EmitableEvents/Fulfilment/RegisterIntent.d.ts

@@ -0,0 +1,11 @@
+import { BaseEmitableEvent } from "../BaseEmitableEvent";
+import { FulfilmentOptions } from "./Options";
+/**
+ * Registers intent from the application to use the Fulfilment API
+ * this event is not required but recommended to show the Fulfilment UI in shopfront sooner
+ */
+export declare class RegisterIntent extends BaseEmitableEvent<{
+    options?: FulfilmentOptions;
+}> {
+    constructor(options: FulfilmentOptions);
+}

package/lib/EmitableEvents/Fulfilment/RegisterIntent.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterIntent = void 0;
+const BaseEmitableEvent_1 = require("../BaseEmitableEvent");
+const ApplicationEvents_1 = require("../../ApplicationEvents");
+/**
+ * Registers intent from the application to use the Fulfilment API
+ * this event is not required but recommended to show the Fulfilment UI in shopfront sooner
+ */
+class RegisterIntent extends BaseEmitableEvent_1.BaseEmitableEvent {
+    constructor(options) {
+        super(ApplicationEvents_1.ToShopfront.FULFILMENT_OPT_IN, {
+            options,
+        });
+    }
+}
+exports.RegisterIntent = RegisterIntent;

package/lib/EmitableEvents/Fulfilment/index.d.ts

@@ -0,0 +1,7 @@
+export { OrderCancel } from "./OrderCancel";
+export { OrderCreate } from "./OrderCreate";
+export { OrderUpdate } from "./OrderUpdate";
+export { OrdersSync } from "./OrdersSync";
+export { Options, FulfilmentOptions } from "./Options";
+export { RegisterIntent } from "./RegisterIntent";
+export { OrderStatus, OrderCreateDetails, OrderSummaryDetails, OrderDetails, OrderItemMatch, OrderItem } from "../../APIs/Fulfilment/FulfilmentTypes";

package/lib/EmitableEvents/Fulfilment/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterIntent = exports.Options = exports.OrdersSync = exports.OrderUpdate = exports.OrderCreate = exports.OrderCancel = void 0;
+var OrderCancel_1 = require("./OrderCancel");
+Object.defineProperty(exports, "OrderCancel", { enumerable: true, get: function () { return OrderCancel_1.OrderCancel; } });
+var OrderCreate_1 = require("./OrderCreate");
+Object.defineProperty(exports, "OrderCreate", { enumerable: true, get: function () { return OrderCreate_1.OrderCreate; } });
+var OrderUpdate_1 = require("./OrderUpdate");
+Object.defineProperty(exports, "OrderUpdate", { enumerable: true, get: function () { return OrderUpdate_1.OrderUpdate; } });
+var OrdersSync_1 = require("./OrdersSync");
+Object.defineProperty(exports, "OrdersSync", { enumerable: true, get: function () { return OrdersSync_1.OrdersSync; } });
+var Options_1 = require("./Options");
+Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return Options_1.Options; } });
+var RegisterIntent_1 = require("./RegisterIntent");
+Object.defineProperty(exports, "RegisterIntent", { enumerable: true, get: function () { return RegisterIntent_1.RegisterIntent; } });

package/lib/Events/FulfilmentCollectOrder.d.ts

@@ -0,0 +1,6 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+export declare class FulfilmentCollectOrder extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["FULFILMENT_ORDER_COLLECTED"]);
+    emit(data: string): Promise<FromShopfrontReturns["FULFILMENT_ORDER_COLLECTED"]>;
+}

package/lib/Events/FulfilmentCollectOrder.js

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

package/lib/Events/FulfilmentCompleteOrder.d.ts

@@ -0,0 +1,6 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+export declare class FulfilmentCompleteOrder extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["FULFILMENT_ORDER_COMPLETED"]);
+    emit(data: string): Promise<FromShopfrontReturns["FULFILMENT_ORDER_COLLECTED"]>;
+}

package/lib/Events/FulfilmentCompleteOrder.js

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

package/lib/Events/FulfilmentGetOrder.d.ts

@@ -0,0 +1,10 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+import { MaybePromise } from "../Utilities/MiscTypes";
+import { Bridge } from "../Bridge";
+import { OrderDetails } from "../APIs/Fulfilment/FulfilmentTypes";
+export declare class FulfilmentGetOrder extends BaseEvent<string, MaybePromise<FromShopfrontReturns["FULFILMENT_GET_ORDER"]>, MaybePromise<FromShopfrontReturns["FULFILMENT_GET_ORDER"]>> {
+    constructor(callback: FromShopfrontCallbacks["FULFILMENT_GET_ORDER"]);
+    emit(data: string): Promise<FromShopfrontReturns["FULFILMENT_GET_ORDER"]>;
+    static respond(bridge: Bridge, order: OrderDetails, id: string): Promise<void>;
+}

package/lib/Events/FulfilmentGetOrder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FulfilmentGetOrder = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+const ApplicationEvents_1 = require("../ApplicationEvents");
+class FulfilmentGetOrder extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        return this.callback(data, undefined);
+    }
+    static async respond(bridge, order, id) {
+        bridge.sendMessage(ApplicationEvents_1.ToShopfront.FULFILMENT_GET_ORDER, order, id);
+    }
+}
+exports.FulfilmentGetOrder = FulfilmentGetOrder;

package/lib/Events/FulfilmentOrderApproval.d.ts

@@ -0,0 +1,6 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns, FulfilmentApprovalEvent } from "../ApplicationEvents";
+export declare class FulfilmentOrderApproval extends BaseEvent<FulfilmentApprovalEvent, FromShopfrontReturns["FULFILMENT_ORDER_APPROVAL"], FromShopfrontReturns["FULFILMENT_ORDER_APPROVAL"]> {
+    constructor(callback: FromShopfrontCallbacks["FULFILMENT_ORDER_APPROVAL"]);
+    emit(data: FulfilmentApprovalEvent): Promise<FromShopfrontReturns["FULFILMENT_ORDER_APPROVAL"]>;
+}

package/lib/Events/FulfilmentOrderApproval.js

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

package/lib/Events/FulfilmentProcessOrder.d.ts

@@ -0,0 +1,14 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns, FulfilmentProcessEvent } from "../ApplicationEvents";
+import { ShopfrontSaleState } from "../APIs/Sale";
+import { MaybePromise } from "../Utilities/MiscTypes";
+export declare class FulfilmentProcessOrder extends BaseEvent<{
+    id: string;
+    sale: ShopfrontSaleState;
+}, MaybePromise<FromShopfrontReturns["FULFILMENT_PROCESS_ORDER"]>, MaybePromise<FromShopfrontReturns["FULFILMENT_PROCESS_ORDER"]>, FulfilmentProcessEvent> {
+    constructor(callback: FromShopfrontCallbacks["FULFILMENT_PROCESS_ORDER"]);
+    emit(data: {
+        id: string;
+        sale: ShopfrontSaleState;
+    }): Promise<FromShopfrontReturns["FULFILMENT_PROCESS_ORDER"]>;
+}

package/lib/Events/FulfilmentProcessOrder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FulfilmentProcessOrder = void 0;
+const BaseEvent_1 = require("./BaseEvent");
+const Sale_1 = require("../APIs/Sale");
+class FulfilmentProcessOrder extends BaseEvent_1.BaseEvent {
+    constructor(callback) {
+        super(callback);
+    }
+    async emit(data) {
+        return this.callback({
+            id: data.id,
+            sale: new Sale_1.Sale(Sale_1.Sale.buildSaleData(data.sale)),
+        }, undefined);
+    }
+}
+exports.FulfilmentProcessOrder = FulfilmentProcessOrder;

package/lib/Events/FulfilmentVoidOrder.d.ts

@@ -0,0 +1,6 @@
+import { BaseEvent } from "./BaseEvent";
+import { FromShopfrontCallbacks, FromShopfrontReturns } from "../ApplicationEvents";
+export declare class FulfilmentVoidOrder extends BaseEvent {
+    constructor(callback: FromShopfrontCallbacks["FULFILMENT_VOID_ORDER"]);
+    emit(data: string): Promise<FromShopfrontReturns["FULFILMENT_VOID_ORDER"]>;
+}

package/lib/Events/FulfilmentVoidOrder.js

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

package/lib/Utilities/SaleCreate.d.ts

@@ -0,0 +1,26 @@
+import { Sale, ShopfrontSalePaymentStatus } from "../APIs/Sale";
+import { BaseSaleData } from "../APIs/Sale/BaseSale";
+export interface SaleProductData {
+    uuid: string;
+    caseQuantity: number;
+    quantity: number;
+    price: number;
+    metaData: Record<string, unknown>;
+    products: Array<SaleProductData>;
+    note: string;
+}
+export interface SalePaymentData {
+    method: string;
+    type: undefined | string;
+    amount: number;
+    status: undefined | ShopfrontSalePaymentStatus;
+    rounding: number;
+    cashout: number;
+    metaData: Record<string, unknown>;
+}
+export interface SaleData extends BaseSaleData {
+    customer: null | string;
+    payments: Array<SalePaymentData>;
+    products: Array<SaleProductData>;
+}
+export declare function buildSaleData(sale: Sale): SaleData;

package/lib/Utilities/SaleCreate.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSaleData = void 0;
+function buildSaleProductData(product) {
+    const price = product.getPrice();
+    if (typeof price !== "number") {
+        throw new TypeError("Sale Product must have price when creating the sale.");
+    }
+    const caseQuantity = product.getCaseQuantity();
+    if (typeof caseQuantity !== "number") {
+        throw new TypeError("Sale Product must have case quantity when creating the sale.");
+    }
+    return {
+        uuid: product.getId(),
+        quantity: product.getQuantity(),
+        metaData: product.getMetaData(),
+        products: product.getContains().map(buildSaleProductData),
+        note: product.getNote(),
+        caseQuantity,
+        price,
+    };
+}
+function buildSaleData(sale) {
+    const customer = sale.getCustomer();
+    return {
+        register: sale.getRegister(),
+        clientId: sale.getClientId(),
+        notes: {
+            internal: sale.getInternalNote(),
+            sale: sale.getExternalNote(),
+        },
+        totals: {
+            sale: sale.getSaleTotal(),
+            paid: sale.getPaidTotal(),
+            savings: sale.getSavingsTotal(),
+            discount: sale.getDiscountTotal(),
+        },
+        linkedTo: sale.getLinkedTo(),
+        orderReference: sale.getOrderReference(),
+        refundReason: sale.getRefundReason(),
+        priceSet: sale.getPriceSet(),
+        metaData: sale.getMetaData(),
+        customer: customer ? customer.getId() : null,
+        products: sale.getProducts().map(buildSaleProductData),
+        payments: sale.getPayments().map(payment => ({
+            method: payment.getId(),
+            type: payment.getType(),
+            amount: payment.getAmount(),
+            status: payment.getStatus(),
+            rounding: payment.getRounding() || 0,
+            cashout: payment.getCashout() || 0,
+            metaData: payment.getMetaData()
+        })),
+    };
+}
+exports.buildSaleData = buildSaleData;

package/lib/Utilities/UUID.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Fast UUID generator, RFC4122 version 4 compliant.
+ * @author Jeff Ward (jcward.com).
+ * @license MIT license
+ * @link http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136
+ **/
+export default class UUID {
+    protected lut: Array<string>;
+    constructor();
+    generate(): string;
+    static generate(): string;
+}

package/lib/Utilities/UUID.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Fast UUID generator, RFC4122 version 4 compliant.
+ * @author Jeff Ward (jcward.com).
+ * @license MIT license
+ * @link http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136
+ **/
+class UUID {
+    constructor() {
+        this.lut = [];
+        for (let i = 0; i < 256; i++) {
+            this.lut[i] = (i < 16 ? "0" : "") + (i).toString(16);
+        }
+        this.generate = this.generate.bind(this);
+    }
+    generate() {
+        const d0 = Math.random() * 0xffffffff | 0;
+        const d1 = Math.random() * 0xffffffff | 0;
+        const d2 = Math.random() * 0xffffffff | 0;
+        const d3 = Math.random() * 0xffffffff | 0;
+        return this.lut[d0 & 0xff] +
+            this.lut[d0 >> 8 & 0xff] +
+            this.lut[d0 >> 16 & 0xff] +
+            this.lut[d0 >> 24 & 0xff] + "-" +
+            this.lut[d1 & 0xff] +
+            this.lut[d1 >> 8 & 0xff] + "-" +
+            this.lut[d1 >> 16 & 0x0f | 0x40] +
+            this.lut[d1 >> 24 & 0xff] + "-" +
+            this.lut[d2 & 0x3f | 0x80] +
+            this.lut[d2 >> 8 & 0xff] + "-" +
+            this.lut[d2 >> 16 & 0xff] +
+            this.lut[d2 >> 24 & 0xff] +
+            this.lut[d3 & 0xff] +
+            this.lut[d3 >> 8 & 0xff] +
+            this.lut[d3 >> 16 & 0xff] +
+            this.lut[d3 >> 24 & 0xff];
+    }
+    static generate() {
+        if (typeof self?.crypto?.randomUUID === "function") {
+            return self.crypto.randomUUID();
+        }
+        return (new UUID()).generate();
+    }
+}
+exports.default = UUID;

package/lib/index.d.ts

@@ -6,7 +6,9 @@ export { Dialog } from "./Actions/Dialog";
 export { SaleKey } from "./Actions/SaleKey";
 export { SellScreenOption } from "./EmitableEvents/SellScreenOption";
 export { TableUpdate } from "./EmitableEvents/TableUpdate";
+export { SaleData as SaleCreateData, SalePaymentData as SaleCreatePaymentData, SaleProductData as SaleCreateProductData } from "./Utilities/SaleCreate";
 export { SellScreenPromotionApplicable } from "./EmitableEvents/SellScreenPromotionApplicable";
 export { CompletedSale } from "./Events/SaleComplete";
 export { Application, ShopfrontEmbeddedVerificationToken, ShopfrontTokenDecodingError } from "./Application";
-export * as Sales from "./APIs/CurrentSale/index";
+export * as Sales from "./APIs/Sale/index";
+export * as Fulfilment from "./EmitableEvents/Fulfilment/index";

package/lib/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sales = exports.ShopfrontTokenDecodingError = exports.Application = exports.SellScreenPromotionApplicable = exports.TableUpdate = exports.SellScreenOption = exports.SaleKey = exports.Dialog = exports.Toast = exports.Redirect = exports.Button = exports.Bridge = void 0;
+exports.Fulfilment = exports.Sales = exports.ShopfrontTokenDecodingError = exports.Application = exports.SellScreenPromotionApplicable = exports.TableUpdate = exports.SellScreenOption = exports.SaleKey = exports.Dialog = exports.Toast = exports.Redirect = exports.Button = exports.Bridge = void 0;
 var Bridge_1 = require("./Bridge");
 Object.defineProperty(exports, "Bridge", { enumerable: true, get: function () { return Bridge_1.Bridge; } });
 var Button_1 = require("./Actions/Button");
@@ -45,4 +45,5 @@ Object.defineProperty(exports, "SellScreenPromotionApplicable", { enumerable: tr
 var Application_1 = require("./Application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return Application_1.Application; } });
 Object.defineProperty(exports, "ShopfrontTokenDecodingError", { enumerable: true, get: function () { return Application_1.ShopfrontTokenDecodingError; } });
-exports.Sales = __importStar(require("./APIs/CurrentSale/index"));
+exports.Sales = __importStar(require("./APIs/Sale/index"));
+exports.Fulfilment = __importStar(require("./EmitableEvents/Fulfilment/index"));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopfront/bridge",
-    "version": "1.16.0",
+    "version": "1.18.2",
     "main": "./lib/index.js",
     "license": "ISC",
     "description": "The bridge used to embed your application within Shopfront",