@shopfront/bridge 1.8.0 → 1.11.0

package/.idea/embedded-bridge.iml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/lib" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/embedded-bridge.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -1,5 +1,6 @@
-#Shopfront Embedded Bridge
+# Shopfront Embedded Bridge
+
 This is the bridge library to use with the Shopfront Embedded API.
 
 For more information, check out the documentation on the 
-[Shopfront developer website](https://developer.onshopfront.com/documentation/Embedded/Introduction).
+[Shopfront developer website](https://developer.onshopfront.com/documentation/Embedded/Introduction).

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

@@ -80,6 +80,12 @@ export declare class Sale {
      * @returns {string}
      */
     getOrderReference(): string;
+    /**
+     * Get the current meta data for the sale
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData(): Record<string, unknown>;
     /**
      * Cancel the current sale in progress.
      *
@@ -162,6 +168,12 @@ export declare class Sale {
      * @returns {Promise<void>}
      */
     setOrderReference(reference: string): Promise<void>;
+    /**
+     * Set the meta data of the sale, this will override the previous meta data.
+     *
+     * @param metaData
+     */
+    setMetaData(metaData: Record<string, unknown>): Promise<void>;
     /**
      * Update a product's details, currently this only updates the top-level meta data
      * @param product

package/lib/APIs/CurrentSale/Sale.js

@@ -125,6 +125,14 @@ class Sale {
     getOrderReference() {
         return this.sale.orderReference;
     }
+    /**
+     * Get the current meta data for the sale
+     *
+     * @returns {Record<string, unknown>}
+     */
+    getMetaData() {
+        return this.sale.metaData;
+    }
     /**
      * Cancel the current sale in progress.
      *
@@ -257,6 +265,16 @@ class Sale {
             reference,
         }));
     }
+    /**
+     * Set the meta data of the sale, this will override the previous meta data.
+     *
+     * @param metaData
+     */
+    setMetaData(metaData) {
+        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("SALE_META_DATA", {
+            metaData,
+        }));
+    }
     /**
      * Update a product's details, currently this only updates the top-level meta data
      * @param product

package/lib/APIs/CurrentSale/SaleProduct.d.ts

@@ -73,7 +73,7 @@ export declare class SaleProduct {
      *
      * @returns {ShopfrontSaleProductType | undefined}
      */
-    getType(): "Normal" | "Voucher" | "Basket" | "Package" | "Component" | undefined;
+    getType(): ShopfrontSaleProductType | undefined;
     /**
      * Get the tax rate amount.
      * This is the rate of the tax rate (e.g. 10 is a tax rate of 10%).

package/lib/APIs/CurrentSale/SaleProduct.js

@@ -44,10 +44,9 @@ class SaleProduct {
      * @param {Array<number>} indexAddress
      */
     setInternal(data, indexAddress) {
-        var _a;
         this.name = data.name;
         this.type = data.type;
-        this.taxRateAmount = ((_a = data.tax) === null || _a === void 0 ? void 0 : _a.amount) || 0;
+        this.taxRateAmount = data.tax?.amount || 0;
         this.note = data.note;
         this.edited = data.edited;
         this.caseQuantity = data.caseQuantity;

package/lib/APIs/CurrentSale/ShopfrontSaleState.d.ts

@@ -48,5 +48,6 @@ export interface ShopfrontSaleState {
     orderReference: string;
     refundReason: string;
     priceSet: string | null;
+    metaData: Record<string, unknown>;
 }
 export {};

package/lib/APIs/CurrentSale/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -6,5 +6,5 @@ export declare class InternalMessageSource {
     protected method: InternalPageMessageMethod;
     protected url: string;
     constructor(application: Application, method: InternalPageMessageMethod, url: string);
-    send(message: any): void;
+    send(message: unknown): void;
 }

package/lib/Actions/BaseAction.d.ts

@@ -1,21 +1,26 @@
 import { EventEmitter } from "../Common/EventEmitter";
 import { Serializable, Serialized } from "../Common/Serializable";
+interface BaseActionConstructor<T> {
+    new (...args: Array<never>): BaseAction<T>;
+    new (serialized: Serialized<T>): BaseAction<T>;
+}
 export declare class BaseAction<T> extends EventEmitter {
     protected target: string;
     protected events: Array<{
-        callback: Function;
+        callback: (...args: Array<unknown>) => void;
         type: string;
         id: string;
     }>;
-    protected properties: Array<any>;
+    protected properties: Array<unknown>;
     static serializedRegistry: {
-        [id: string]: any;
+        [id: string]: BaseActionConstructor<unknown>;
     };
-    constructor(serialized: Serialized<T>, type: any);
+    constructor(serialized: Serialized<T>, type: BaseActionConstructor<T>);
     serialize(): Serialized<T>;
-    protected serializeProperties(properties: Array<any>): Array<any>;
+    protected serializeProperties(properties: Array<unknown>): Array<unknown>;
     static deserialize<T extends Serializable<T>>(serialized: Serialized<T>): T;
-    addEventListener(event: string, callback: Function): void;
-    removeEventListener(event: string, callback: Function): void;
-    handleRegistrarEvent(id: string, data: any): void;
+    addEventListener(event: string, callback: (...args: Array<unknown>) => void): void;
+    removeEventListener(event: string, callback: (...args: Array<unknown>) => void): void;
+    handleRegistrarEvent(id: string, data: unknown): void;
 }
+export {};

package/lib/Actions/BaseAction.js

@@ -44,17 +44,18 @@ let BaseAction = BaseAction_1 = class BaseAction extends EventEmitter_1.EventEmi
         const results = [];
         // Loop through current layer of properties
         for (let i = 0, l = properties.length; i < l; i++) {
-            if (Array.isArray(properties[i])) {
+            const property = properties[i];
+            if (Array.isArray(property)) {
                 // Prepare to recurse through next layer of properties
-                results.push(this.serializeProperties(properties[i]));
+                results.push(this.serializeProperties(property));
             }
-            else if (properties[i] instanceof BaseAction_1) {
+            else if (property instanceof BaseAction_1) {
                 // Serialize property
-                results.push(properties[i].serialize());
+                results.push(property.serialize());
             }
             else {
                 // Assume that the property is already serializable
-                results.push(properties[i]);
+                results.push(property);
             }
         }
         return results;
@@ -102,6 +103,6 @@ let BaseAction = BaseAction_1 = class BaseAction extends EventEmitter_1.EventEmi
 };
 BaseAction.serializedRegistry = {};
 BaseAction = BaseAction_1 = __decorate([
-    Static_1.staticImplements()
+    (0, Static_1.staticImplements)()
 ], BaseAction);
 exports.BaseAction = BaseAction;

package/lib/Actions/Button.js

@@ -19,7 +19,6 @@ class Button extends BaseAction_1.BaseAction {
         })(), Button);
         this.supportedEvents = ["click"];
         if (typeof icon === "undefined" && typeof label !== "string") {
-            label = label;
             this.label = label.properties[0];
             this.icon = label.properties[1];
         }

package/lib/Actions/Redirect.js

@@ -19,7 +19,6 @@ class InternalRedirect extends BaseAction_1.BaseAction {
         })(), InternalRedirect);
         this.supportedEvents = ["click"];
         if (typeof to !== "string") {
-            to = to;
             this.to = to.properties[0];
         }
         else {
@@ -47,7 +46,6 @@ class ExternalRedirect extends BaseAction_1.BaseAction {
             this.to = to;
         }
         else {
-            to = to;
             this.to = new URL(to.properties[0]);
         }
     }

package/lib/Actions/SaleKey.js

@@ -19,7 +19,6 @@ class SaleKey extends BaseAction_1.BaseAction {
         })(), SaleKey);
         this.supportedEvents = ["click"];
         if (typeof name === "undefined" && typeof id !== "string") {
-            id = id;
             this.id = id.properties[0];
             this.name = id.properties[1];
         }

package/lib/Actions/SaleUpdate.d.ts

@@ -26,11 +26,11 @@ export interface SaleUpdateChanges {
         cashout?: number;
         status?: ShopfrontSalePaymentStatus;
     };
-    SALE_CANCEL: {};
+    SALE_CANCEL: Record<string, never>;
     CUSTOMER_ADD: {
         id: string;
     };
-    CUSTOMER_REMOVE: {};
+    CUSTOMER_REMOVE: Record<string, never>;
     SALE_EXTERNAL_NOTE: {
         note: string;
         append?: boolean;
@@ -42,6 +42,9 @@ export interface SaleUpdateChanges {
     SALE_ORDER_REFERENCE: {
         reference: string;
     };
+    SALE_META_DATA: {
+        metaData: Record<string, unknown>;
+    };
     PRODUCT_UPDATE: {
         id: string;
         indexAddress: Array<number>;

package/lib/Actions/SaleUpdate.js

@@ -19,7 +19,6 @@ class SaleUpdate extends BaseAction_1.BaseAction {
         })(), SaleUpdate);
         this.supportedEvents = [];
         if (typeof data === "undefined" && typeof type !== "string") {
-            type = type;
             this.type = type.properties[0];
             this.data = type.properties[1];
         }

package/lib/Actions/Toast.d.ts

@@ -1,10 +1,9 @@
 import { BaseAction } from "./BaseAction";
 import { Serialized } from "../Common/Serializable";
-declare type ToastType = "success" | "error" | "information" | "warning";
+export declare type ToastType = "success" | "error" | "information" | "warning";
 export declare class Toast extends BaseAction<Toast> {
     protected supportedEvents: string[];
     protected type: ToastType;
     protected message: string;
     constructor(type: Serialized<Toast> | ToastType, message?: string);
 }
-export {};

package/lib/Application.d.ts

@@ -3,8 +3,10 @@ import { DirectShopfrontEvent, FromShopfront, FromShopfrontCallbacks, FromShopfr
 import { Serializable } from "./Common/Serializable";
 import { BaseEmitableEvent } from "./EmitableEvents/BaseEmitableEvent";
 import { Sale } from "./APIs/CurrentSale";
+import { ShopfrontSaleState } from "./APIs/CurrentSale/ShopfrontSaleState";
 import { Database } from "./APIs/Database/Database";
 import { MaybePromise } from "./Utilities/MiscTypes";
+import { BaseEvent } from "./Events/BaseEvent";
 export declare class Application {
     protected bridge: Bridge;
     protected isReady: boolean;
@@ -13,7 +15,7 @@ export declare class Application {
     protected outlet: string | null;
     protected user: string | null;
     protected listeners: {
-        [key in keyof Omit<FromShopfront, "CALLBACK">]: Map<Function, FromShopfront[key]>;
+        [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>>;
@@ -21,21 +23,26 @@ export declare class Application {
     database: Database;
     constructor(bridge: Bridge);
     destroy(): void;
-    protected handleEvent: (event: keyof FromShopfront | keyof FromShopfrontInternal, data: any, id: string) => void;
-    protected emit(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, data: any, id: string): MaybePromise<void>;
+    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;
-    removeEventListener(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, callback: (...args: Array<any>) => MaybePromise<any>): void;
-    send(item: BaseEmitableEvent<any>): void;
-    send(item: Serializable<any>): void;
+    removeEventListener(event: keyof Omit<FromShopfront, "CALLBACK"> | DirectShopfrontEvent, callback: (...args: Array<unknown>) => MaybePromise<void>): void;
+    send(item: BaseEmitableEvent<unknown>): void;
+    send(item: Serializable<unknown>): void;
     download(file: string): void;
+    redirect(toLocation: string, externalRedirect?: boolean): void;
     load(): () => void;
     protected handleEventCallback(data: {
         id?: string;
-        data: any;
+        data: unknown;
     }): void;
     protected handleLocationChanged(data: RegisterChangedEvent): void;
     getAuthenticationKey(): string;
+    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.
@@ -43,6 +50,12 @@ export declare class Application {
      * @returns {Promise<Sale | boolean>}
      */
     getCurrentSale(): Promise<Sale | false>;
+    protected dataIsLocation(data: Record<string, unknown>): data is {
+        requestId: string;
+        register: string | null;
+        outlet: string | null;
+        user: string | null;
+    };
     /**
      * Get the location from Shopfront
      */
@@ -52,4 +65,10 @@ export declare class Application {
         user: string | null;
     }>;
     printReceipt(content: string): void;
+    protected dataIsOption<TValueType>(data: Record<string, unknown>): data is {
+        requestId: string;
+        option: string;
+        value: TValueType | undefined;
+    };
+    getOption<TValueType>(option: string, defaultValue: TValueType): Promise<TValueType>;
 }

package/lib/Application.js

@@ -21,6 +21,8 @@ const FormatIntegratedProduct_1 = require("./Events/FormatIntegratedProduct");
 const RequestCustomerListOptions_1 = require("./Events/RequestCustomerListOptions");
 const RequestSaleKeys_1 = require("./Events/RequestSaleKeys");
 const SaleComplete_1 = require("./Events/SaleComplete");
+const UIPipeline_1 = require("./Events/UIPipeline");
+const PaymentMethodsEnabled_1 = require("./Events/PaymentMethodsEnabled");
 // noinspection JSUnusedGlobalSymbols
 class Application {
     constructor(bridge) {
@@ -36,6 +38,8 @@ class Application {
             REQUEST_CUSTOMER_LIST_OPTIONS: new Map(),
             REQUEST_SALE_KEYS: new Map(),
             SALE_COMPLETE: new Map(),
+            UI_PIPELINE: new Map(),
+            PAYMENT_METHODS_ENABLED: new Map(),
         };
         this.directListeners = {};
         this.handleEvent = (event, data, id) => {
@@ -65,7 +69,8 @@ class Application {
             }
             else if (event === "RESPONSE_CURRENT_SALE" ||
                 event === "RESPONSE_DATABASE_REQUEST" ||
-                event === "RESPONSE_LOCATION") {
+                event === "RESPONSE_LOCATION" ||
+                event === "RESPONSE_OPTION") {
                 // Handled elsewhere
                 return;
             }
@@ -108,8 +113,8 @@ class Application {
         if (this.listeners[event].size === 0) {
             return this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.NOT_LISTENING_TO_EVENT, event, id);
         }
-        for (let e of this.listeners[event].values()) {
-            results.push(e.emit(data));
+        for (const e of this.listeners[event].values()) {
+            results.push(e.emit(data, this.bridge));
         }
         // Respond if necessary
         switch (event) {
@@ -151,6 +156,18 @@ class Application {
                 results = results;
                 return Promise.all(results)
                     .then(res => RequestSaleKeys_1.RequestSaleKeys.respond(this.bridge, res.flat(), id));
+            case "UI_PIPELINE":
+                results = results;
+                return Promise.all(results)
+                    .then(res => {
+                    return UIPipeline_1.UIPipeline.respond(this.bridge, res.flat(), id);
+                });
+            case "PAYMENT_METHODS_ENABLED":
+                results = results;
+                return Promise.all(results)
+                    .then(res => {
+                    return PaymentMethodsEnabled_1.PaymentMethodsEnabled.respond(this.bridge, res.flat(), id);
+                });
         }
     }
     addEventListener(event, callback) {
@@ -159,10 +176,13 @@ class Application {
             if (typeof this.directListeners[event] === "undefined") {
                 this.directListeners[event] = new Set();
             }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this.directListeners[event].add(callback);
             return;
         }
-        let c = null;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let c;
+        event = event;
         switch (event) {
             case "READY":
                 c = new Ready_1.Ready(callback);
@@ -208,8 +228,16 @@ class Application {
                 c = new SaleComplete_1.SaleComplete(callback);
                 this.listeners[event].set(callback, c);
                 break;
+            case "UI_PIPELINE":
+                c = new UIPipeline_1.UIPipeline(callback);
+                this.listeners[event].set(callback, c);
+                break;
+            case "PAYMENT_METHODS_ENABLED":
+                c = new PaymentMethodsEnabled_1.PaymentMethodsEnabled(callback);
+                this.listeners[event].set(callback, c);
+                break;
         }
-        if (c === null) {
+        if (typeof c === "undefined") {
             throw new TypeError(`${event} has not been defined`);
         }
         if (event === "READY" && this.isReady) {
@@ -222,9 +250,8 @@ class Application {
         }
     }
     removeEventListener(event, callback) {
-        var _a;
         if (ApplicationEvents_1.directShopfrontEvents.includes(event)) {
-            (_a = this.directListeners[event]) === null || _a === void 0 ? void 0 : _a.delete(callback);
+            this.directListeners[event]?.delete(callback);
             return;
         }
         this.listeners[event].delete(callback);
@@ -244,6 +271,12 @@ class Application {
     download(file) {
         this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.DOWNLOAD, file);
     }
+    redirect(toLocation, externalRedirect = true) {
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.REDIRECT, {
+            to: toLocation,
+            external: externalRedirect,
+        });
+    }
     load() {
         this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.LOAD, true);
         return () => this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.LOAD, false);
@@ -252,7 +285,7 @@ class Application {
         if (typeof data.id === "undefined") {
             return;
         }
-        let id = data.id;
+        const id = data.id;
         ActionEventRegistrar_1.default.fire(id, data.data);
     }
     handleLocationChanged(data) {
@@ -263,6 +296,9 @@ class Application {
     getAuthenticationKey() {
         return this.key;
     }
+    dataIsSaleEvent(data) {
+        return typeof data.requestId === "string" && (data.saleState === false || typeof data.saleState === "object");
+    }
     /**
      * Get the current sale on the sell screen, if the current device is not a register
      * then this will return false.
@@ -276,7 +312,9 @@ class Application {
                 if (event !== "RESPONSE_CURRENT_SALE") {
                     return;
                 }
-                data = data;
+                if (!this.dataIsSaleEvent(data)) {
+                    return;
+                }
                 if (data.requestId !== saleRequest) {
                     return;
                 }
@@ -294,6 +332,12 @@ class Application {
         }
         return new CurrentSale_1.Sale(this, saleState);
     }
+    dataIsLocation(data) {
+        return typeof data.requestId === "string" &&
+            (typeof data.register === "string" || data.register === null) &&
+            (typeof data.outlet === "string" || data.outlet === null) &&
+            (typeof data.user === "string" || data.user === null);
+    }
     /**
      * Get the location from Shopfront
      */
@@ -304,7 +348,9 @@ class Application {
                 if (event !== "RESPONSE_LOCATION") {
                     return;
                 }
-                data = data;
+                if (!this.dataIsLocation(data)) {
+                    return;
+                }
                 if (data.requestId !== locationRequest) {
                     return;
                 }
@@ -329,5 +375,36 @@ class Application {
             type: "text",
         });
     }
+    dataIsOption(data) {
+        return typeof data.requestId === "string" && typeof data.option === "string";
+    }
+    async getOption(option, defaultValue) {
+        const request = `OptionRequest-${Date.now().toString()}`;
+        const promise = new Promise(res => {
+            const listener = (event, data) => {
+                if (event !== "RESPONSE_OPTION") {
+                    return;
+                }
+                if (!this.dataIsOption(data)) {
+                    return;
+                }
+                if (data.requestId !== request) {
+                    return;
+                }
+                this.bridge.removeEventListener(listener);
+                res(data.value);
+            };
+            this.bridge.addEventListener(listener);
+        });
+        this.bridge.sendMessage(ApplicationEvents_1.ToShopfront.GET_OPTION, {
+            requestId: request,
+            option,
+        });
+        const optionValue = await promise;
+        if (typeof optionValue === "undefined") {
+            return defaultValue;
+        }
+        return optionValue;
+    }
 }
 exports.Application = Application;