@shopfront/bridge 2.0.0 → 2.0.2

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

@@ -1,4 +1,4 @@
-import { ShopfrontSalePayment } from "./ShopfrontSaleState";
+import { ShopfrontSalePayment } from "./ShopfrontSaleState.js";
 export declare enum SalePaymentStatus {
     APPROVED = "completed",
     DECLINED = "failed",
@@ -16,61 +16,42 @@ export declare class SalePayment {
     constructor(id: string, amount: number, cashout?: number, status?: SalePaymentStatus);
     /**
      * Hydrate a sale payment from the SaleState.
-     *
      * @internal
-     * @param {ShopfrontSalePayment} payment
-     * @returns {SalePayment}
-     * @constructor
      */
     static HydrateFromState(payment: ShopfrontSalePayment): SalePayment;
     /**
      * Set the internal data for the payment.
-     * This method is for hydration of the payment from Shopfront, it's highly recommend that you DO NOT use this method.
-     *
+     * This method is for hydration of the payment from Shopfront,
+     * it's highly recommend that you DO NOT use this method.
      * @internal
-     * @param {ShopfrontSalePayment} data
      */
     setInternal(data: ShopfrontSalePayment): void;
     /**
      * Get the ID of the sale payment method.
-     *
-     * @returns {string}
      */
     getId(): string;
     /**
      * Get the type of payment method this is.
-     *
-     * @returns {string | undefined}
      */
     getType(): string | undefined;
     /**
      * Get the status of this payment method.
-     *
-     * @returns {SalePaymentStatus | undefined}
      */
     getStatus(): SalePaymentStatus | undefined;
     /**
      * Get the value of this payment method.
-     *
-     * @returns {number}
      */
     getAmount(): number;
     /**
      * Get the cashout amount paid for on this payment method.
-     *
-     * @returns {number | undefined}
      */
     getCashout(): number | undefined;
     /**
      * Get the amount of rounding applied to this payment method.
-     *
-     * @returns {number | undefined}
      */
     getRounding(): number | undefined;
     /**
      * Get the metadata attached to this payment method
-     *
-     * @returns {Record<string, unknown>}
      */
     getMetaData(): Record<string, unknown>;
 }

package/lib/APIs/Sale/SalePayment.js

@@ -1,20 +1,14 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SalePayment = exports.SalePaymentStatus = void 0;
-const UUID_1 = __importDefault(require("../../Utilities/UUID"));
-var SalePaymentStatus;
+import UUID from "../../Utilities/UUID.js";
+export var SalePaymentStatus;
 (function (SalePaymentStatus) {
     SalePaymentStatus["APPROVED"] = "completed";
     SalePaymentStatus["DECLINED"] = "failed";
     SalePaymentStatus["CANCELLED"] = "cancelled";
-})(SalePaymentStatus = exports.SalePaymentStatus || (exports.SalePaymentStatus = {}));
-class SalePayment {
+})(SalePaymentStatus || (SalePaymentStatus = {}));
+export class SalePayment {
     constructor(id, amount, cashout, status) {
         this.metaData = {};
-        this.internalId = UUID_1.default.generate();
+        this.internalId = UUID.generate();
         this.id = id;
         this.amount = amount;
         this.cashout = cashout;
@@ -22,11 +16,7 @@ class SalePayment {
     }
     /**
      * Hydrate a sale payment from the SaleState.
-     *
      * @internal
-     * @param {ShopfrontSalePayment} payment
-     * @returns {SalePayment}
-     * @constructor
      */
     static HydrateFromState(payment) {
         let status = SalePaymentStatus.APPROVED;
@@ -44,10 +34,9 @@ class SalePayment {
     }
     /**
      * Set the internal data for the payment.
-     * This method is for hydration of the payment from Shopfront, it's highly recommend that you DO NOT use this method.
-     *
+     * This method is for hydration of the payment from Shopfront,
+     * it's highly recommend that you DO NOT use this method.
      * @internal
-     * @param {ShopfrontSalePayment} data
      */
     setInternal(data) {
         this.type = data.type;
@@ -56,59 +45,44 @@ class SalePayment {
     }
     /**
      * Get the ID of the sale payment method.
-     *
-     * @returns {string}
      */
     getId() {
         return this.id;
     }
     /**
      * Get the type of payment method this is.
-     *
-     * @returns {string | undefined}
      */
     getType() {
         return this.type;
     }
     /**
      * Get the status of this payment method.
-     *
-     * @returns {SalePaymentStatus | undefined}
      */
     getStatus() {
         return this.status;
     }
     /**
      * Get the value of this payment method.
-     *
-     * @returns {number}
      */
     getAmount() {
         return this.amount;
     }
     /**
      * Get the cashout amount paid for on this payment method.
-     *
-     * @returns {number | undefined}
      */
     getCashout() {
         return this.cashout;
     }
     /**
      * Get the amount of rounding applied to this payment method.
-     *
-     * @returns {number | undefined}
      */
     getRounding() {
         return this.rounding;
     }
     /**
      * Get the metadata attached to this payment method
-     *
-     * @returns {Record<string, unknown>}
      */
     getMetaData() {
         return this.metaData;
     }
 }
-exports.SalePayment = SalePayment;

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

@@ -1,4 +1,4 @@
-import { ShopfrontSaleProduct, ShopfrontSaleProductPromotions, ShopfrontSaleProductType } from "./ShopfrontSaleState";
+import { ShopfrontSaleProduct, ShopfrontSaleProductPromotions, ShopfrontSaleProductType } from "./ShopfrontSaleState.js";
 export declare class SaleProduct {
     readonly internalId: string;
     protected id: string;
@@ -21,44 +21,31 @@ export declare class SaleProduct {
     constructor(id: string, quantity: number, price?: number, indexAddress?: Array<number>);
     /**
      * Hydrate a sale product from the SaleState.
-     *
      * @internal
-     * @param {ShopfrontSaleProduct} product
-     * @param {Array<number>} indexAddress
-     * @returns {SaleProduct}
-     * @constructor
      */
     static HydrateFromState(product: ShopfrontSaleProduct, indexAddress: Array<number>): SaleProduct;
     /**
      * Append a product to this product's list of contained products.
-     *
-     * @protected
-     * @param {SaleProduct} product
      */
     protected appendProduct(product: SaleProduct): void;
     /**
      * Set the internal data for the product.
-     * This method is for hydration of the product from Shopfront, it's highly recommend that you DO NOT use this method.
-     *
+     * This method is for hydration of the product from Shopfront,
+     * it's highly recommend that you DO NOT use this method.
      * @internal
-     * @param {ShopfrontSaleProduct} data
-     * @param {Array<number>} indexAddress
      */
     setInternal(data: ShopfrontSaleProduct, indexAddress: Array<number>): void;
     /**
      * Get the ID of the product.
-     * @returns {string}
      */
     getId(): string;
     /**
      * Gets the mapped id for the product.
      * Used when the product goes through the fulfilment process mapping
-     * @returns {string | undefined}
      */
     getMapped(): string | undefined;
     /**
      * Get the current sale quantity of the product.
-     * @returns {number}
      */
     getQuantity(): number;
     /**
@@ -67,7 +54,6 @@ export declare class SaleProduct {
     setQuantity(quantity: number): void;
     /**
      * Get the current price of the product.
-     * @returns {number | undefined}
      */
     getPrice(): number | undefined;
     /**
@@ -78,93 +64,67 @@ export declare class SaleProduct {
      * Get the index address of the product.
      * This is the internal address of where the product is in the sale.
      * (e.g. if the address is [1, 3] it's the fourth contained product in the second sale line).
-     *
-     * @returns {Array<number>}
      */
-    getIndexAddress(): number[];
+    getIndexAddress(): Array<number>;
     /**
      * Get the name of the product.
-     *
-     * @returns {string | undefined}
      */
     getName(): string | undefined;
     /**
      * Get the type of product this product is.
-     *
-     * @returns {ShopfrontSaleProductType | 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%).
-     *
-     * @returns {number | undefined}
      */
     getTaxRateAmount(): number | undefined;
     /**
      * Get the sale note attached to this product.
-     *
-     * @returns {string}
      */
     getNote(): string;
     /**
      * Get the products this product contains.
-     *
-     * @returns {Array<SaleProduct>}
      */
-    getContains(): SaleProduct[];
+    getContains(): Array<SaleProduct>;
     /**
      * Get whether this product has been "edited".
      * Typically, being edited just means that this product has been discounted.
-     *
-     * @returns {boolean}
      */
     getEdited(): boolean;
     /**
      * Get the case quantity for this product.
-     *
-     * @returns {number | undefined}
      */
     getCaseQuantity(): number | undefined;
     /**
      * Get the current active promotions for the product.
-     *
-     * @returns {ShopfrontSaleProductPromotions}
      */
     getPromotions(): ShopfrontSaleProductPromotions;
     /**
-     * Get the meta data for the product.
-     *
-     * @returns {Record<string, unknown>}
+     * Get the meta-data for the product.
      */
     getMetaData(): Record<string, unknown>;
     /**
      * Set the metaData for a product
-     * @param key
-     * @param value
      */
     setMetaData(key: string, value: unknown): void;
     /**
      * Returns whether the product's quantity was modified externally
-     *
      * @internal
      */
     wasQuantityModified(): boolean;
     /**
      * Returns whether the product's price was modified externally
-     *
      * @internal
      */
     wasPriceModified(): boolean;
     /**
      * Returns whether the product's metaData was modified externally
-     *
      * @internal
      */
     wasMetaDataModified(): boolean;
     /**
      * Sets a product's modification flags to false
-     *
      * @internal
      */
     clearModificationFlags(): void;

package/lib/APIs/Sale/SaleProduct.js

@@ -1,15 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaleProduct = void 0;
-const UUID_1 = __importDefault(require("../../Utilities/UUID"));
-class SaleProduct {
+import UUID from "../../Utilities/UUID.js";
+export class SaleProduct {
     constructor(id, quantity, price, indexAddress) {
         this.promotions = {};
         this.metaData = {};
-        this.internalId = UUID_1.default.generate();
+        this.internalId = UUID.generate();
         this.id = id;
         this.quantity = quantity;
         this.price = price;
@@ -23,12 +17,7 @@ class SaleProduct {
     }
     /**
      * Hydrate a sale product from the SaleState.
-     *
      * @internal
-     * @param {ShopfrontSaleProduct} product
-     * @param {Array<number>} indexAddress
-     * @returns {SaleProduct}
-     * @constructor
      */
     static HydrateFromState(product, indexAddress) {
         const hydrated = new SaleProduct(product.uuid, product.quantity, product.prices.price, indexAddress);
@@ -37,20 +26,15 @@ class SaleProduct {
     }
     /**
      * Append a product to this product's list of contained products.
-     *
-     * @protected
-     * @param {SaleProduct} product
      */
     appendProduct(product) {
         this.contains.push(product);
     }
     /**
      * Set the internal data for the product.
-     * This method is for hydration of the product from Shopfront, it's highly recommend that you DO NOT use this method.
-     *
+     * This method is for hydration of the product from Shopfront,
+     * it's highly recommend that you DO NOT use this method.
      * @internal
-     * @param {ShopfrontSaleProduct} data
-     * @param {Array<number>} indexAddress
      */
     setInternal(data, indexAddress) {
         this.name = data.name;
@@ -71,7 +55,6 @@ class SaleProduct {
     }
     /**
      * Get the ID of the product.
-     * @returns {string}
      */
     getId() {
         return this.id;
@@ -79,14 +62,12 @@ class SaleProduct {
     /**
      * Gets the mapped id for the product.
      * Used when the product goes through the fulfilment process mapping
-     * @returns {string | undefined}
      */
     getMapped() {
         return this.mapped;
     }
     /**
      * Get the current sale quantity of the product.
-     * @returns {number}
      */
     getQuantity() {
         return this.quantity;
@@ -100,7 +81,6 @@ class SaleProduct {
     }
     /**
      * Get the current price of the product.
-     * @returns {number | undefined}
      */
     getPrice() {
         return this.price;
@@ -116,24 +96,18 @@ class SaleProduct {
      * Get the index address of the product.
      * This is the internal address of where the product is in the sale.
      * (e.g. if the address is [1, 3] it's the fourth contained product in the second sale line).
-     *
-     * @returns {Array<number>}
      */
     getIndexAddress() {
         return this.indexAddress;
     }
     /**
      * Get the name of the product.
-     *
-     * @returns {string | undefined}
      */
     getName() {
         return this.name;
     }
     /**
      * Get the type of product this product is.
-     *
-     * @returns {ShopfrontSaleProductType | undefined}
      */
     getType() {
         return this.type;
@@ -141,24 +115,18 @@ class SaleProduct {
     /**
      * Get the tax rate amount.
      * This is the rate of the tax rate (e.g. 10 is a tax rate of 10%).
-     *
-     * @returns {number | undefined}
      */
     getTaxRateAmount() {
         return this.taxRateAmount;
     }
     /**
      * Get the sale note attached to this product.
-     *
-     * @returns {string}
      */
     getNote() {
         return this.note;
     }
     /**
      * Get the products this product contains.
-     *
-     * @returns {Array<SaleProduct>}
      */
     getContains() {
         return this.contains;
@@ -166,40 +134,30 @@ class SaleProduct {
     /**
      * Get whether this product has been "edited".
      * Typically, being edited just means that this product has been discounted.
-     *
-     * @returns {boolean}
      */
     getEdited() {
         return this.edited;
     }
     /**
      * Get the case quantity for this product.
-     *
-     * @returns {number | undefined}
      */
     getCaseQuantity() {
         return this.caseQuantity;
     }
     /**
      * Get the current active promotions for the product.
-     *
-     * @returns {ShopfrontSaleProductPromotions}
      */
     getPromotions() {
         return this.promotions;
     }
     /**
-     * Get the meta data for the product.
-     *
-     * @returns {Record<string, unknown>}
+     * Get the meta-data for the product.
      */
     getMetaData() {
         return this.metaData;
     }
     /**
      * Set the metaData for a product
-     * @param key
-     * @param value
      */
     setMetaData(key, value) {
         this.metaData[key] = value;
@@ -207,7 +165,6 @@ class SaleProduct {
     }
     /**
      * Returns whether the product's quantity was modified externally
-     *
      * @internal
      */
     wasQuantityModified() {
@@ -215,7 +172,6 @@ class SaleProduct {
     }
     /**
      * Returns whether the product's price was modified externally
-     *
      * @internal
      */
     wasPriceModified() {
@@ -223,7 +179,6 @@ class SaleProduct {
     }
     /**
      * Returns whether the product's metaData was modified externally
-     *
      * @internal
      */
     wasMetaDataModified() {
@@ -231,7 +186,6 @@ class SaleProduct {
     }
     /**
      * Sets a product's modification flags to false
-     *
      * @internal
      */
     clearModificationFlags() {
@@ -240,4 +194,3 @@ class SaleProduct {
         this.metaDataModified = false;
     }
 }
-exports.SaleProduct = SaleProduct;

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

@@ -1,12 +1,10 @@
-export declare type ShopfrontSalePaymentStatus = "completed" | "cancelled" | "failed";
-export declare type ShopfrontSaleProductType = "Normal" | "Basket" | "Package" | "Component" | "Voucher";
-export interface ShopfrontSaleProductPromotions {
-    [id: string]: {
-        name: string;
-        active: boolean;
-        quantity: number;
-    };
-}
+export type ShopfrontSalePaymentStatus = "completed" | "cancelled" | "failed";
+export type ShopfrontSaleProductType = "Normal" | "Basket" | "Package" | "Component" | "Voucher";
+export type ShopfrontSaleProductPromotions = Record<string, {
+    name: string;
+    active: boolean;
+    quantity: number;
+}>;
 export interface ShopfrontSaleProduct {
     uuid: string;
     type: ShopfrontSaleProductType;

package/lib/APIs/Sale/ShopfrontSaleState.js

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

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

@@ -1,9 +1,9 @@
-export { SaleData, SalePaymentData, SaleProductData } from "../../Utilities/SaleCreate";
-export { ShopfrontSalePayment, ShopfrontSalePaymentStatus, ShopfrontSaleProduct, ShopfrontSaleProductType, ShopfrontSaleState } from "./ShopfrontSaleState";
-export { BaseSale } from "./BaseSale";
-export { SaleProduct } from "./SaleProduct";
-export { SalePayment } from "./SalePayment";
-export { SalePaymentStatus } from "./SalePayment";
-export { SaleCustomer } from "./SaleCustomer";
-export { Sale } from "./Sale";
-export * as Exceptions from "./Exceptions";
+export type { SaleData, SalePaymentData, SaleProductData, } from "../../Utilities/SaleCreate.js";
+export { BaseSale } from "./BaseSale.js";
+export * as Exceptions from "./Exceptions.js";
+export { Sale } from "./Sale.js";
+export { SaleCustomer } from "./SaleCustomer.js";
+export { SalePayment } from "./SalePayment.js";
+export { SalePaymentStatus } from "./SalePayment.js";
+export { SaleProduct } from "./SaleProduct.js";
+export type { ShopfrontSalePayment, ShopfrontSalePaymentStatus, ShopfrontSaleProduct, ShopfrontSaleProductType, ShopfrontSaleState, } from "./ShopfrontSaleState.js";

package/lib/APIs/Sale/index.js

@@ -1,39 +1,7 @@
-"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.Exceptions = exports.Sale = exports.SaleCustomer = exports.SalePaymentStatus = exports.SalePayment = exports.SaleProduct = exports.BaseSale = void 0;
-var BaseSale_1 = require("./BaseSale");
-Object.defineProperty(exports, "BaseSale", { enumerable: true, get: function () { return BaseSale_1.BaseSale; } });
-var SaleProduct_1 = require("./SaleProduct");
-Object.defineProperty(exports, "SaleProduct", { enumerable: true, get: function () { return SaleProduct_1.SaleProduct; } });
-var SalePayment_1 = require("./SalePayment");
-Object.defineProperty(exports, "SalePayment", { enumerable: true, get: function () { return SalePayment_1.SalePayment; } });
-var SalePayment_2 = require("./SalePayment");
-Object.defineProperty(exports, "SalePaymentStatus", { enumerable: true, get: function () { return SalePayment_2.SalePaymentStatus; } });
-var SaleCustomer_1 = require("./SaleCustomer");
-Object.defineProperty(exports, "SaleCustomer", { enumerable: true, get: function () { return SaleCustomer_1.SaleCustomer; } });
-var Sale_1 = require("./Sale");
-Object.defineProperty(exports, "Sale", { enumerable: true, get: function () { return Sale_1.Sale; } });
-exports.Exceptions = __importStar(require("./Exceptions"));
+export { BaseSale } from "./BaseSale.js";
+export * as Exceptions from "./Exceptions.js";
+export { Sale } from "./Sale.js";
+export { SaleCustomer } from "./SaleCustomer.js";
+export { SalePayment } from "./SalePayment.js";
+export { SalePaymentStatus } from "./SalePayment.js";
+export { SaleProduct } from "./SaleProduct.js";

package/lib/Actions/BaseAction.d.ts

@@ -1,5 +1,5 @@
-import { EventEmitter } from "../Common/EventEmitter";
-import { Serializable, Serialized } from "../Common/Serializable";
+import { EventEmitter } from "../Common/EventEmitter.js";
+import { Serializable, Serialized } from "../Common/Serializable.js";
 interface BaseActionConstructor<T> {
     new (...args: Array<never>): BaseAction<T>;
     new (serialized: Serialized<T>): BaseAction<T>;
@@ -12,15 +12,31 @@ export declare class BaseAction<T> extends EventEmitter {
         id: string;
     }>;
     protected properties: Array<unknown>;
-    static serializedRegistry: {
-        [id: string]: BaseActionConstructor<unknown>;
-    };
+    static serializedRegistry: Record<string, BaseActionConstructor<unknown>>;
     constructor(serialized: Serialized<T>, type: BaseActionConstructor<T>);
+    /**
+     * Serializes the registered action event data (excluding callbacks) and properties
+     */
     serialize(): Serialized<T>;
+    /**
+     * Recursively serializes the action properties
+     */
     protected serializeProperties(properties: Array<unknown>): Array<unknown>;
+    /**
+     * Deserializes the action data
+     */
     static deserialize<T extends Serializable<T>>(serialized: Serialized<T>): T;
+    /**
+     * Registers an action event listener
+     */
     addEventListener(event: string, callback: (...args: Array<unknown>) => void): void;
+    /**
+     * Unregisters an action event listener
+     */
     removeEventListener(event: string, callback: (...args: Array<unknown>) => void): void;
+    /**
+     * Fires the callback for the registered action event
+     */
     handleRegistrarEvent(id: string, data: unknown): void;
 }
 export {};