@shopfront/bridge 1.20.0 → 1.20.2

package/.idea/{shopfront-embedded-bridge.iml → embedded-bridge.iml}

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

package/.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/shopfront-embedded-bridge.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/embedded-bridge.iml" filepath="$PROJECT_DIR$/.idea/embedded-bridge.iml" />
     </modules>
   </component>
 </project>

package/lib/APIs/Fulfilment/FulfilmentTypes.d.ts

@@ -26,7 +26,13 @@ export interface OrderItem {
     image?: string;
     name: string;
     quantity: number;
-    packSize: number;
+    packSize: number | {
+        id?: number;
+        barcode?: "auto" | number;
+        mdbId?: number;
+        supplierCodes?: number;
+        defaultTo: number;
+    };
     price: number;
     comment?: string;
     match?: OrderItemMatch;

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

@@ -15,6 +15,9 @@ export declare class SaleProduct {
     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.
@@ -58,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.
@@ -116,9 +127,9 @@ export declare class SaleProduct {
      */
     getCaseQuantity(): number | undefined;
     /**
-     * Get the promotions for the product.
+     * Get the current active promotions for the product.
      *
-     * @returns {Record<string, unknown>}
+     * @returns {ShopfrontSaleProductPromotions}
      */
     getPromotions(): ShopfrontSaleProductPromotions;
     /**
@@ -133,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

@@ -17,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.
@@ -88,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}
@@ -95,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.
@@ -164,9 +181,9 @@ class SaleProduct {
         return this.caseQuantity;
     }
     /**
-     * Get the promotions for the product.
+     * Get the current active promotions for the product.
      *
-     * @returns {Record<string, unknown>}
+     * @returns {ShopfrontSaleProductPromotions}
      */
     getPromotions() {
         return this.promotions;
@@ -186,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/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.20.0",
+    "version": "1.20.2",
     "main": "./lib/index.js",
     "license": "ISC",
     "description": "The bridge used to embed your application within Shopfront",

package/.idea/codeStyles/Project.xml

@@ -1,10 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <JSCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-    </TypeScriptCodeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?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>