@shopfront/bridge 1.18.4 → 1.20.1

package/.idea/git_toolbox_prj.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GitToolBoxProjectSettings">
+    <option name="commitMessageIssueKeyValidationOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+    <option name="commitMessageValidationEnabledOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+  </component>
+</project>

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

@@ -125,7 +125,7 @@ export declare class CurrentSale extends BaseSale {
      */
     setMetaData(metaData: Record<string, unknown>): Promise<void>;
     /**
-     * Update a product's details, currently this only updates the top-level meta data
+     * Update a product's details, currently this can update quantity, price and metadata
      * @param product
      */
     updateProduct(product: SaleProduct): Promise<void>;

package/lib/APIs/Sale/CurrentSale.js

@@ -196,15 +196,25 @@ class CurrentSale extends BaseSale_1.BaseSale {
         }));
     }
     /**
-     * Update a product's details, currently this only updates the top-level meta data
+     * Update a product's details, currently this can update quantity, price and metadata
      * @param product
      */
     updateProduct(product) {
-        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_UPDATE", {
+        const updateData = {
             id: product.getId(),
-            indexAddress: product.getIndexAddress(),
-            metaData: product.getMetaData(),
-        }));
+            indexAddress: product.getIndexAddress()
+        };
+        if (product.wasQuantityModified()) {
+            updateData.quantity = product.getQuantity();
+        }
+        if (product.wasPriceModified()) {
+            updateData.price = product.getPrice();
+        }
+        if (product.wasMetaDataModified()) {
+            updateData.metaData = product.getMetaData();
+        }
+        product.clearModificationFlags();
+        return this.sendSaleUpdate(new SaleUpdate_1.SaleUpdate("PRODUCT_UPDATE", updateData));
     }
 }
 exports.CurrentSale = CurrentSale;

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

@@ -1,4 +1,4 @@
-import { ShopfrontSaleProduct, ShopfrontSaleProductType } from "./ShopfrontSaleState";
+import { ShopfrontSaleProduct, ShopfrontSaleProductPromotions, ShopfrontSaleProductType } from "./ShopfrontSaleState";
 export declare class SaleProduct {
     readonly internalId: string;
     protected id: string;
@@ -12,8 +12,12 @@ export declare class SaleProduct {
     protected contains: Array<SaleProduct>;
     protected edited: boolean;
     protected caseQuantity?: number;
+    protected promotions: ShopfrontSaleProductPromotions;
     protected metaData: Record<string, unknown>;
     protected mapped?: string;
+    protected quantityModified: boolean;
+    protected priceModified: boolean;
+    protected metaDataModified: boolean;
     constructor(id: string, quantity: number, price?: number, indexAddress?: Array<number>);
     /**
      * Hydrate a sale product from the SaleState.
@@ -57,11 +61,19 @@ export declare class SaleProduct {
      * @returns {number}
      */
     getQuantity(): number;
+    /**
+     * Sets the current sale quantity of the product
+     */
+    setQuantity(quantity: number): void;
     /**
      * Get the current price of the product.
      * @returns {number | undefined}
      */
     getPrice(): number | undefined;
+    /**
+     * Sets the current price of the product
+     */
+    setPrice(price: number): void;
     /**
      * Get the index address of the product.
      * This is the internal address of where the product is in the sale.
@@ -114,6 +126,12 @@ export declare class SaleProduct {
      * @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.
      *
@@ -126,4 +144,28 @@ export declare class SaleProduct {
      * @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

@@ -7,6 +7,7 @@ exports.SaleProduct = void 0;
 const UUID_1 = __importDefault(require("../../Utilities/UUID"));
 class SaleProduct {
     constructor(id, quantity, price, indexAddress) {
+        this.promotions = {};
         this.metaData = {};
         this.internalId = UUID_1.default.generate();
         this.id = id;
@@ -16,6 +17,9 @@ class SaleProduct {
         this.contains = [];
         this.edited = typeof price !== "undefined";
         this.note = "";
+        this.quantityModified = false;
+        this.priceModified = false;
+        this.metaDataModified = false;
     }
     /**
      * Hydrate a sale product from the SaleState.
@@ -55,6 +59,7 @@ class SaleProduct {
         this.note = data.note;
         this.edited = data.edited;
         this.caseQuantity = data.caseQuantity;
+        this.promotions = data.promotions;
         this.metaData = data.metaData;
         this.mapped = data.mapped;
         for (let i = 0, l = data.products.length; i < l; i++) {
@@ -86,6 +91,13 @@ class SaleProduct {
     getQuantity() {
         return this.quantity;
     }
+    /**
+     * Sets the current sale quantity of the product
+     */
+    setQuantity(quantity) {
+        this.quantity = quantity;
+        this.quantityModified = true;
+    }
     /**
      * Get the current price of the product.
      * @returns {number | undefined}
@@ -93,6 +105,13 @@ class SaleProduct {
     getPrice() {
         return this.price;
     }
+    /**
+     * Sets the current price of the product
+     */
+    setPrice(price) {
+        this.price = price;
+        this.priceModified = true;
+    }
     /**
      * Get the index address of the product.
      * This is the internal address of where the product is in the sale.
@@ -161,6 +180,14 @@ class SaleProduct {
     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.
      *
@@ -176,6 +203,41 @@ class SaleProduct {
      */
     setMetaData(key, value) {
         this.metaData[key] = value;
+        this.metaDataModified = true;
+    }
+    /**
+     * Returns whether the product's quantity was modified externally
+     *
+     * @internal
+     */
+    wasQuantityModified() {
+        return this.quantityModified;
+    }
+    /**
+     * Returns whether the product's price was modified externally
+     *
+     * @internal
+     */
+    wasPriceModified() {
+        return this.priceModified;
+    }
+    /**
+     * Returns whether the product's metaData was modified externally
+     *
+     * @internal
+     */
+    wasMetaDataModified() {
+        return this.metaDataModified;
+    }
+    /**
+     * Sets a product's modification flags to false
+     *
+     * @internal
+     */
+    clearModificationFlags() {
+        this.quantityModified = false;
+        this.priceModified = false;
+        this.metaDataModified = false;
     }
 }
 exports.SaleProduct = SaleProduct;

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

@@ -1,5 +1,12 @@
 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 interface ShopfrontSaleProduct {
     uuid: string;
     type: ShopfrontSaleProductType;
@@ -15,6 +22,7 @@ export interface ShopfrontSaleProduct {
     };
     note: string;
     products: Array<ShopfrontSaleProduct>;
+    promotions: ShopfrontSaleProductPromotions;
     edited: boolean;
     caseQuantity: number;
     metaData: Record<string, unknown>;

package/lib/Actions/SaleUpdate.d.ts

@@ -48,7 +48,9 @@ export interface SaleUpdateChanges {
     PRODUCT_UPDATE: {
         id: string;
         indexAddress: Array<number>;
-        metaData: Record<string, unknown>;
+        quantity?: number;
+        price?: number;
+        metaData?: Record<string, unknown>;
     };
 }
 export declare class SaleUpdate<K extends keyof SaleUpdateChanges> extends BaseAction<SaleUpdate<K>> {

package/package.json

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