@shopfront/bridge 2.0.0 → 2.0.1

package/lib/Mocks/MockBridge.js

@@ -0,0 +1,77 @@
+import * as ApplicationEvents from "../ApplicationEvents.js";
+import { BaseBridge } from "../BaseBridge.js";
+export class MockBridge extends BaseBridge {
+    constructor(key, url) {
+        super(key, url);
+        this.isReady = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        this.listeners = [];
+    }
+    /**
+     * @inheritDoc
+     */
+    registerListeners() {
+        /* Do nothing */
+    }
+    /**
+     * @inheritDoc
+     */
+    unregisterListeners() {
+        /* Do nothing */
+    }
+    /**
+     * @inheritDoc
+     */
+    sendMessage(type, data, id) {
+        if (type === ApplicationEvents.ToShopfront.READY) {
+            if (typeof data !== "undefined") {
+                throw new TypeError("The `data` parameter must be undefined when requesting ready state");
+            }
+            if (this.isReady) {
+                throw new Error("Shopfront is already ready");
+            }
+            const listeners = this.listeners;
+            // We can fire off a READY event straight away
+            for (let i = 0, l = listeners.length; i < l; i++) {
+                listeners[i](type, {
+                    key: "signing-key-uuid",
+                    outlet: "outlet-uuid",
+                    register: "register-uuid",
+                }, id);
+            }
+            return;
+        }
+        // No need to do anything
+    }
+    /**
+     * @inheritDoc
+     */
+    addEventListener(listener) {
+        if (this.listeners.includes(listener)) {
+            throw new Error("The listener provided is already registered");
+        }
+        this.listeners.push(listener);
+        // If this is a READY event listener, we can fire off a Ready event immediately
+        if (!this.hasListener) {
+            this.sendMessage(ApplicationEvents.ToShopfront.READY);
+            this.hasListener = true;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    removeEventListener(listener) {
+        const index = this.listeners.indexOf(listener);
+        if (index === -1) {
+            return;
+        }
+        this.listeners = [
+            ...this.listeners.slice(0, index),
+            ...this.listeners.slice(index + 1),
+        ];
+    }
+}

package/lib/Mocks/index.d.ts

@@ -0,0 +1,7 @@
+import { MockApplication } from "./MockApplication.js";
+import { MockBridge } from "./MockBridge.js";
+/**
+ * Creates a mocked instance of the Embedded Application
+ */
+declare function mockApplication(id: string, vendor: string): MockApplication;
+export { MockApplication, mockApplication, MockBridge, };

package/lib/Mocks/index.js

@@ -0,0 +1,15 @@
+import { MockApplication } from "./MockApplication.js";
+import { MockBridge } from "./MockBridge.js";
+/**
+ * Creates a mocked instance of the Embedded Application
+ */
+function mockApplication(id, vendor) {
+    if (typeof id === "undefined") {
+        throw new TypeError("You must specify the ID for the application");
+    }
+    if (typeof vendor === "undefined") {
+        throw new TypeError("You must specify the Vendor for the application");
+    }
+    return new MockApplication(new MockBridge(id, vendor));
+}
+export { MockApplication, mockApplication, MockBridge, };

package/lib/Utilities/ActionEventRegistrar.d.ts

@@ -1,12 +1,27 @@
-import { BaseAction } from "../Actions/BaseAction";
+import { BaseAction } from "../Actions/BaseAction.js";
 declare class ActionEventRegistrar {
-    events: {
-        [id: string]: BaseAction<undefined>;
-    };
+    private events;
     constructor();
+    /**
+     * Registers an event action listener
+     * @param id
+     * @param action
+     */
     add(id: string, action: BaseAction<undefined>): void;
+    /**
+     * Removes an event action listener
+     * @param id
+     */
     remove(id: string): void;
+    /**
+     * Invokes the registered action event listener
+     * @param id
+     * @param data
+     */
     fire(id: string, data: unknown): void;
+    /**
+     * Clears all registered listeners
+     */
     clear(): void;
 }
 declare const _default: ActionEventRegistrar;

package/lib/Utilities/ActionEventRegistrar.js

@@ -1,15 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 class ActionEventRegistrar {
     constructor() {
         this.events = {};
     }
+    /**
+     * Registers an event action listener
+     * @param id
+     * @param action
+     */
     add(id, action) {
         this.events[id] = action;
     }
+    /**
+     * Removes an event action listener
+     * @param id
+     */
     remove(id) {
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
         delete this.events[id];
     }
+    /**
+     * Invokes the registered action event listener
+     * @param id
+     * @param data
+     */
     fire(id, data) {
         if (typeof this.events[id] === "undefined") {
             // The event must have stopped listening
@@ -17,8 +30,11 @@ class ActionEventRegistrar {
         }
         this.events[id].handleRegistrarEvent(id, data);
     }
+    /**
+     * Clears all registered listeners
+     */
     clear() {
         this.events = {};
     }
 }
-exports.default = new ActionEventRegistrar();
+export default new ActionEventRegistrar();

package/lib/Utilities/MiscTypes.d.ts

@@ -1,7 +1,9 @@
 /**
  * A property which might be a promise or the promise's wrapped type
  */
-export declare type MaybePromise<P> = P | Promise<P>;
-export interface ConstructorClass<T> {
-    new (...args: Array<unknown>): T;
-}
+export type MaybePromise<P> = P | Promise<P>;
+export type ConstructorClass<T> = new (...args: Array<unknown>) => T;
+/**
+ * A function that may or may not be asynchronous
+ */
+export type AnyFunction = (...args: Array<any>) => any;

package/lib/Utilities/MiscTypes.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/Utilities/SaleCreate.d.ts

@@ -1,5 +1,5 @@
-import { Sale, ShopfrontSalePaymentStatus } from "../APIs/Sale";
-import { BaseSaleData } from "../APIs/Sale/BaseSale";
+import { BaseSaleData } from "../APIs/Sale/BaseSale.js";
+import { Sale, ShopfrontSalePaymentStatus } from "../APIs/Sale/index.js";
 export interface SaleProductData {
     uuid: string;
     caseQuantity: number;
@@ -23,4 +23,8 @@ export interface SaleData extends BaseSaleData {
     payments: Array<SalePaymentData>;
     products: Array<SaleProductData>;
 }
+/**
+ * Builds a Shopfront sale from the embedded sale data
+ * @param sale
+ */
 export declare function buildSaleData(sale: Sale): SaleData;

package/lib/Utilities/SaleCreate.js

@@ -1,6 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildSaleData = void 0;
+/**
+ * Builds a Shopfront sale product from the embedded product data
+ * @param product
+ */
 function buildSaleProductData(product) {
     const price = product.getPrice();
     if (typeof price !== "number") {
@@ -20,7 +21,11 @@ function buildSaleProductData(product) {
         price,
     };
 }
-function buildSaleData(sale) {
+/**
+ * Builds a Shopfront sale from the embedded sale data
+ * @param sale
+ */
+export function buildSaleData(sale) {
     const customer = sale.getCustomer();
     return {
         register: sale.getRegister(),
@@ -49,8 +54,7 @@ function buildSaleData(sale) {
             status: payment.getStatus(),
             rounding: payment.getRounding() || 0,
             cashout: payment.getCashout() || 0,
-            metaData: payment.getMetaData()
+            metaData: payment.getMetaData(),
         })),
     };
 }
-exports.buildSaleData = buildSaleData;

package/lib/Utilities/Static.d.ts

@@ -1 +1,4 @@
+/**
+ * A decorator function that enforces static interface implementation for a class at compile time.
+ */
 export declare function staticImplements<T>(): (constructor: T) => void;

package/lib/Utilities/Static.js

@@ -1,9 +1,7 @@
-"use strict";
-// noinspection JSUnusedLocalSymbols
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.staticImplements = void 0;
-function staticImplements() {
-    // eslint-disable-next-line @typescript-eslint/no-empty-function,@typescript-eslint/no-unused-vars
+/**
+ * A decorator function that enforces static interface implementation for a class at compile time.
+ */
+export function staticImplements() {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
     return (constructor) => { };
 }
-exports.staticImplements = staticImplements;

package/lib/Utilities/UUID.d.ts

@@ -1,12 +1,18 @@
 /**
  * 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
- **/
+ * @license MIT
+ * {@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();
+    /**
+     * Generates a UUID
+     */
     generate(): string;
+    /**
+     * Static method for generating a UUID
+     */
     static generate(): string;
 }

package/lib/Utilities/UUID.js

@@ -1,12 +1,10 @@
-"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 {
+ * @license MIT
+ * {@link http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136}
+ */
+export default class UUID {
     constructor() {
         this.lut = [];
         for (let i = 0; i < 256; i++) {
@@ -14,6 +12,9 @@ class UUID {
         }
         this.generate = this.generate.bind(this);
     }
+    /**
+     * Generates a UUID
+     */
     generate() {
         const d0 = Math.random() * 0xffffffff | 0;
         const d1 = Math.random() * 0xffffffff | 0;
@@ -36,6 +37,9 @@ class UUID {
             this.lut[d3 >> 16 & 0xff] +
             this.lut[d3 >> 24 & 0xff];
     }
+    /**
+     * Static method for generating a UUID
+     */
     static generate() {
         if (typeof self?.crypto?.randomUUID === "function") {
             return self.crypto.randomUUID();
@@ -43,4 +47,3 @@ class UUID {
         return (new UUID()).generate();
     }
 }
-exports.default = UUID;

package/lib/index.d.ts

@@ -1,14 +1,16 @@
-export { Bridge } from "./Bridge";
-export { Button } from "./Actions/Button";
-export { Redirect } from "./Actions/Redirect";
-export { Toast, ToastType } from "./Actions/Toast";
-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/Sale/index";
-export * as Fulfilment from "./EmitableEvents/Fulfilment/index";
+export { Button } from "./Actions/Button.js";
+export { Dialog } from "./Actions/Dialog.js";
+export { Redirect } from "./Actions/Redirect.js";
+export { SaleKey } from "./Actions/SaleKey.js";
+export { Toast, type ToastType } from "./Actions/Toast.js";
+export * as Sales from "./APIs/Sale/index.js";
+export { Application } from "./Application.js";
+export { type ShopfrontEmbeddedVerificationToken, ShopfrontTokenDecodingError } from "./BaseApplication.js";
+export { Bridge } from "./Bridge.js";
+export * as Fulfilment from "./EmitableEvents/Fulfilment/index.js";
+export { SellScreenOption } from "./EmitableEvents/SellScreenOption.js";
+export { SellScreenPromotionApplicable } from "./EmitableEvents/SellScreenPromotionApplicable.js";
+export { TableUpdate } from "./EmitableEvents/TableUpdate.js";
+export type { CompletedSale } from "./Events/SaleComplete.js";
+export * from "./Mocks/index.js";
+export type { SaleData as SaleCreateData, SalePaymentData as SaleCreatePaymentData, SaleProductData as SaleCreateProductData, } from "./Utilities/SaleCreate.js";

package/lib/index.js

@@ -1,49 +1,14 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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");
-Object.defineProperty(exports, "Button", { enumerable: true, get: function () { return Button_1.Button; } });
-var Redirect_1 = require("./Actions/Redirect");
-Object.defineProperty(exports, "Redirect", { enumerable: true, get: function () { return Redirect_1.Redirect; } });
-var Toast_1 = require("./Actions/Toast");
-Object.defineProperty(exports, "Toast", { enumerable: true, get: function () { return Toast_1.Toast; } });
-var Dialog_1 = require("./Actions/Dialog");
-Object.defineProperty(exports, "Dialog", { enumerable: true, get: function () { return Dialog_1.Dialog; } });
-var SaleKey_1 = require("./Actions/SaleKey");
-Object.defineProperty(exports, "SaleKey", { enumerable: true, get: function () { return SaleKey_1.SaleKey; } });
-var SellScreenOption_1 = require("./EmitableEvents/SellScreenOption");
-Object.defineProperty(exports, "SellScreenOption", { enumerable: true, get: function () { return SellScreenOption_1.SellScreenOption; } });
-var TableUpdate_1 = require("./EmitableEvents/TableUpdate");
-Object.defineProperty(exports, "TableUpdate", { enumerable: true, get: function () { return TableUpdate_1.TableUpdate; } });
-var SellScreenPromotionApplicable_1 = require("./EmitableEvents/SellScreenPromotionApplicable");
-Object.defineProperty(exports, "SellScreenPromotionApplicable", { enumerable: true, get: function () { return SellScreenPromotionApplicable_1.SellScreenPromotionApplicable; } });
-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/Sale/index"));
-exports.Fulfilment = __importStar(require("./EmitableEvents/Fulfilment/index"));
+export { Button } from "./Actions/Button.js";
+export { Dialog } from "./Actions/Dialog.js";
+export { Redirect } from "./Actions/Redirect.js";
+export { SaleKey } from "./Actions/SaleKey.js";
+export { Toast } from "./Actions/Toast.js";
+export * as Sales from "./APIs/Sale/index.js";
+export { Application } from "./Application.js";
+export { ShopfrontTokenDecodingError } from "./BaseApplication.js";
+export { Bridge } from "./Bridge.js";
+export * as Fulfilment from "./EmitableEvents/Fulfilment/index.js";
+export { SellScreenOption } from "./EmitableEvents/SellScreenOption.js";
+export { SellScreenPromotionApplicable } from "./EmitableEvents/SellScreenPromotionApplicable.js";
+export { TableUpdate } from "./EmitableEvents/TableUpdate.js";
+export * from "./Mocks/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopfront/bridge",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "main": "./lib/index.js",
     "license": "ISC",
     "description": "The bridge used to embed your application within Shopfront",
@@ -30,6 +30,7 @@
         "build": "tsc",
         "watch": "tsc -w",
         "lint": "eslint . --fix",
-        "test": "npx @onshopfront/core test"
+        "test": "npx @onshopfront/core test",
+        "prepublishOnly": "npm run build"
     }
 }

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

@@ -1,6 +0,0 @@
-export declare class SaleCancelledError extends Error {
-    constructor();
-}
-export declare class InvalidSaleDeviceError extends Error {
-    constructor();
-}

package/lib/APIs/CurrentSale/Exceptions.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidSaleDeviceError = exports.SaleCancelledError = void 0;
-class SaleCancelledError extends Error {
-    constructor() {
-        super("The sale is no longer active.");
-    }
-}
-exports.SaleCancelledError = SaleCancelledError;
-class InvalidSaleDeviceError extends Error {
-    constructor() {
-        super("This device is no longer a register able to perform a sale.");
-    }
-}
-exports.InvalidSaleDeviceError = InvalidSaleDeviceError;

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

@@ -1,182 +0,0 @@
-import { Application } from "../../Application";
-import { ShopfrontSaleState } from "./ShopfrontSaleState";
-import { SaleUpdate, SaleUpdateChanges } from "../../Actions/SaleUpdate";
-import { SaleProduct } from "./SaleProduct";
-import { SalePayment } from "./SalePayment";
-import { SaleCustomer } from "./SaleCustomer";
-export declare class Sale {
-    protected application: Application;
-    protected sale: ShopfrontSaleState;
-    protected cancelled: boolean;
-    /**
-     * Create a sale from a sale state.
-     * It's highly recommend to not construct a sale manually, instead use application.getCurrentSale().
-     *
-     * @param {Application} application
-     * @param {ShopfrontSaleState} sale
-     */
-    constructor(application: Application, sale: ShopfrontSaleState);
-    /**
-     * Get the raw state of the sale, it is highly recommend that you DO NOT use this method as the
-     * returned data may be quite volatile.
-     *
-     * @internal
-     * @returns {ShopfrontSaleState}
-     */
-    getRawState(): ShopfrontSaleState;
-    /**
-     * Update the sale to be the latest sale that exists on the sell screen.
-     *
-     * @returns {Promise<void>}
-     */
-    refreshSale(): Promise<void>;
-    /**
-     * Check if the sale has already been cancelled, if it has, throw a SaleCancelledError.
-     *
-     * @protected
-     */
-    protected checkIfCancelled(): void;
-    /**
-     * Send a sale update to Shopfront.
-     *
-     * @protected
-     * @param {SaleUpdate} update
-     * @returns {Promise<void>}
-     */
-    protected sendSaleUpdate(update: SaleUpdate<keyof SaleUpdateChanges>): Promise<void>;
-    /**
-     * Get the products that are currently on the sale.
-     *
-     * @returns {Array<SaleProduct>}
-     */
-    getProducts(): Array<SaleProduct>;
-    /**
-     * Get the payments that are currently on the sale.
-     *
-     * @returns {Array<SalePayment>}
-     */
-    getPayments(): Array<SalePayment>;
-    /**
-     * Get the current customer on the sale.
-     *
-     * @returns {SaleCustomer | null}
-     */
-    getCustomer(): null | SaleCustomer;
-    /**
-     * Get the external sale note (visible to the customer).
-     *
-     * @returns {string}
-     */
-    getExternalNote(): string;
-    /**
-     * Get the internal sale note.
-     *
-     * @returns {string}
-     */
-    getInternalNote(): string;
-    /**
-     * Get the order reference (visible to the customer).
-     *
-     * @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.
-     *
-     * @returns {Promise<void>}
-     */
-    cancelSale(): Promise<void>;
-    /**
-     * Add a product to the sale.
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
-     */
-    addProduct(product: SaleProduct): Promise<void>;
-    /**
-     * Remove a product from the sale.
-     * It's highly recommended that you pass in a product that has been retrieved using sale.getProducts().
-     *
-     * @param {SaleProduct} product
-     * @returns {Promise<void>}
-     */
-    removeProduct(product: SaleProduct): Promise<void>;
-    /**
-     * Add a payment to the sell screen.
-     *
-     * If you specify a payment with a status, it will bypass the payment gateway (i.e. it won't request that the
-     * user takes money from the customer).
-     *
-     * If you don't specify a cashout amount, it will automatically determine if the payment method normally requests
-     * cashout (from the payment method settings).
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
-     */
-    addPayment(payment: SalePayment): Promise<void>;
-    /**
-     * Reverse a payment on the sell screen.
-     *
-     * This is used to issue a refund to the customer. The sale payment amount should be positive.
-     *
-     * @param {SalePayment} payment
-     * @returns {Promise<void>}
-     */
-    reversePayment(payment: SalePayment): Promise<void>;
-    /**
-     * Add a customer to the sale.
-     * If there is already a customer on the sale this will override that customer.
-     *
-     * @param {SaleCustomer} customer
-     * @returns {Promise<void>}
-     */
-    addCustomer(customer: SaleCustomer): Promise<void>;
-    /**
-     * Remove the customer from the current sale.
-     * If there is no customer currently on the sale this will be ignored.
-     * If there are "on account" or loyalty payments still on the sale, this will be ignored.
-     *
-     * @returns {Promise<void>}
-     */
-    removeCustomer(): Promise<void>;
-    /**
-     * Set the external note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
-     */
-    setExternalNote(note: string, append?: boolean): Promise<void>;
-    /**
-     * Set the internal note for the sale.
-     *
-     * @param {string} note The note to set.
-     * @param {boolean} append Whether to append the note to the current sale note.
-     * @returns {Promise<void>}
-     */
-    setInternalNote(note: string, append?: boolean): Promise<void>;
-    /**
-     * Set the order reference to the provided string.
-     *
-     * @param {string} reference
-     * @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
-     */
-    updateProduct(product: SaleProduct): Promise<void>;
-}