addio-admin-sdk 1.7.103 → 1.7.104

package/dist/utils/cart.js

@@ -50,10 +50,13 @@ const updateCartItems = async (currentCart, items, fetchInventory, shouldCheckIn
                 }
                 if (!!inventoryItem) {
                     const webStore = inventoryItem.web_inventory;
+                    // If the item is NOT infinite_stock ans is NOT a service
                     if (!!!inventoryItem.is_infinite_stock && !!!cartItem.is_service) {
+                        // If webstore is not defined or the avaibility = 0
                         if (!!!webStore || !!!webStore.available) {
                             continue;
                         }
+                        // If the quantity we are setting is more than the available qte of the item
                         if (item.qte > webStore.available) {
                             if (!!handleInventoryError) {
                                 await handleInventoryError(true);
@@ -74,6 +77,16 @@ const updateCartItems = async (currentCart, items, fetchInventory, shouldCheckIn
     return { updatedCart, updatedItems };
 };
 exports.updateCartItems = updateCartItems;
+/**
+ * For now, copy of `updateCartItems` function in most aspects, with slight optim. Meant to replace updateCartItems eventually!
+ * Verify a list of items that could be added to a cart. Returns the list of items to update as well as the updated cart data.
+ * @param currentCart
+ * @param items
+ * @param fetchInventory
+ * @param options.shouldCheckInventory
+ * @param options.handleInventoryError
+ * @param options.shouldCheckStoreInventory
+ */
 const verifyAndReturnToBeUpdatedCartItems = async (currentCartItems, items, fetchInventory, options = {}) => {
     let updatedCartItems = [...currentCartItems];
     const updatedDetails = [];
@@ -90,6 +103,7 @@ const verifyAndReturnToBeUpdatedCartItems = async (currentCartItems, items, fetc
                     console.log('error on fetching inventoryItem: ', e);
                 }
                 if (!!inventoryItem) {
+                    // Check store inventory if specified, or default to web inventory
                     let inventoryToCheck;
                     if (options.shouldCheckStoreInventory) {
                         const sameStoreInventory = inventoryItem.inventories.find((i) => i.store_id == options.shouldCheckStoreInventory);
@@ -100,6 +114,7 @@ const verifyAndReturnToBeUpdatedCartItems = async (currentCartItems, items, fetc
                     else {
                         inventoryToCheck = (0, object_1.recursiveCheckObject)(inventoryItem, 'web_inventory.available');
                     }
+                    // If no inventory found, continue
                     if (typeof inventoryToCheck == 'undefined') {
                         updatedDetails.push({
                             sku: item.sku,
@@ -107,7 +122,9 @@ const verifyAndReturnToBeUpdatedCartItems = async (currentCartItems, items, fetc
                         });
                         continue;
                     }
+                    // If the item is NOT infinite_stock ans is NOT a service
                     if (!!!inventoryItem.is_infinite_stock && !!!cartItem.is_service) {
+                        // If the avaibility = 0
                         if (!inventoryToCheck) {
                             updatedDetails.push({
                                 sku: item.sku,
@@ -115,6 +132,7 @@ const verifyAndReturnToBeUpdatedCartItems = async (currentCartItems, items, fetc
                             });
                             continue;
                         }
+                        // If the quantity we are setting is more than the available qte of the item
                         if (item.qte > inventoryToCheck) {
                             if (!!options.handleInventoryError) {
                                 await options.handleInventoryError(true);
@@ -152,9 +170,9 @@ const priceWasOverridden = (itemToCheck) => {
 exports.priceWasOverridden = priceWasOverridden;
 const getActualPromoPrice = (item, output) => {
     const orgPrice = (0, exports.getActualDiscountPrice)(item, '$');
-    let price = orgPrice;
+    let price = orgPrice; // default value
     if (!!item.promo_price) {
-        price = item.promo_price.amount;
+        price = item.promo_price.amount; // this is the first promo
     }
     if (output === '%')
         return !!!orgPrice ? 0 : (1 - price / orgPrice) * 100;
@@ -162,20 +180,28 @@ const getActualPromoPrice = (item, output) => {
 };
 exports.getActualPromoPrice = getActualPromoPrice;
 const getActualDiscountPrice = (item, output) => {
-    let price = item.regular_price.amount;
+    let price = item.regular_price.amount; // default value
     if (!!item.discount_price) {
-        price = item.discount_price.amount;
+        price = item.discount_price.amount; // this is the first promo
     }
     if (output === '%')
         return (1 - price / item.regular_price.amount) * 100;
     return price;
 };
 exports.getActualDiscountPrice = getActualDiscountPrice;
+/**
+ * Generate a cart item from corresonding indexedProduct
+ * @param indexedProduct
+ * @param sku
+ * @param qte
+ */
 const generateCartItemForSku = async (indexedProduct, sku, qte) => {
     try {
+        // Isolate decli with corresponding sku
         const sameDecli = indexedProduct.declinations.find((d) => d.sku == sku);
         if (!sameDecli)
             throw new Error('Could not find decli in product!');
+        // Construct CartItem from decli and prod values
         let decliImgs = sameDecli.images_path;
         if (!decliImgs || decliImgs.length == 0) {
             const parentImgs = indexedProduct.image_files;
@@ -212,8 +238,10 @@ const addCartItems = async (currentCart, newItems, fetchInventory, shouldCheckIn
         }
         const itemAlreadyInCart = (0, findIndex_1.default)(newCart.items, (item) => item.sku === cartItem.sku);
         if (!!checkInventory) {
+            // If inventory not found, return error
             if (!!!inventoryItem)
                 return 'already_max_qte';
+            // If the webstore is not defined or the avaibility = 0
             if (!!inventoryItem.is_infinite_stock || !!cartItem.is_service || !!cartItem.is_sample)
                 return cartItem;
             if (!!!inventoryItem.web_inventory || !!!inventoryItem.web_inventory.available) {
@@ -223,6 +251,7 @@ const addCartItems = async (currentCart, newItems, fetchInventory, shouldCheckIn
                 return 'already_max_qte';
             }
             if (itemAlreadyInCart !== -1 && !!!isServiceUpsellOfSku) {
+                // If the quantity we are adding is more than the available qte of the item
                 if (!!shouldCheckInventory && !!inventoryItem.web_inventory && !!inventoryItem.web_inventory.available) {
                     if ((0, toNumber_1.default)(newCart.items[itemAlreadyInCart].qte) + (0, toNumber_1.default)(cartItem.qte) >
                         (0, toNumber_1.default)(inventoryItem.web_inventory.available)) {
@@ -272,6 +301,14 @@ const addCartItems = async (currentCart, newItems, fetchInventory, shouldCheckIn
     };
 };
 exports.addCartItems = addCartItems;
+/**
+ * Optimized copy of addCartItems function for now. Will eventually replace addCartItems.
+ * Verify a list of items to be potentially added to cart.
+ * @param currentCart
+ * @param newItems
+ * @param fetchInventory
+ * @param options
+ */
 const verifyAndReturnToBeAddedCartItems = async (currentCart, newItems, fetchInventory, options = {}) => {
     let newCart = Object.assign({}, currentCart);
     let items = [...newItems];
@@ -292,10 +329,13 @@ const verifyAndReturnToBeAddedCartItems = async (currentCart, newItems, fetchInv
         }
         const itemAlreadyInCart = (0, findIndex_1.default)(newCart.items, (item) => item.sku === cartItem.sku);
         if (!!checkInventory) {
+            // If inventory not found, return error
             if (!!!inventoryItem)
                 return 'inventory_not_found';
+            // Check if item's inventory is not followed (if item is a service, a sample, etc...). Skip check if true
             if (inventoryItem.is_infinite_stock || cartItem.is_service || cartItem.is_sample)
                 return cartItem;
+            // Check store inventory if specified, or default to web inventory
             let inventoryToCheck;
             if (options.shouldCheckStoreInventory) {
                 const sameStoreInventory = inventoryItem.inventories.find((i) => i.store_id == options.shouldCheckStoreInventory);
@@ -306,13 +346,16 @@ const verifyAndReturnToBeAddedCartItems = async (currentCart, newItems, fetchInv
             else {
                 inventoryToCheck = (0, object_1.recursiveCheckObject)(inventoryItem, 'web_inventory.available');
             }
+            // If no inventory found, return false
             if (typeof inventoryToCheck == 'undefined') {
                 return 'inventory_not_found';
             }
             if (cartItem.qte > inventoryToCheck) {
                 return 'already_max_qte';
             }
+            // If item already in cart
             if (itemAlreadyInCart !== -1 && !!!options.isServiceUpsellOfSku) {
+                // If the quantity we are adding is more than the available qte of the item
                 if (!!options.shouldCheckInventory && !!inventoryToCheck) {
                     if ((0, toNumber_1.default)(newCart.items[itemAlreadyInCart].qte) + (0, toNumber_1.default)(cartItem.qte) > (0, toNumber_1.default)(inventoryToCheck)) {
                         return 'already_max_qte';
@@ -360,6 +403,7 @@ const verifyAndReturnToBeAddedCartItems = async (currentCart, newItems, fetchInv
     };
 };
 exports.verifyAndReturnToBeAddedCartItems = verifyAndReturnToBeAddedCartItems;
+// Get province from province array with english, french or abbreviation
 const getCurrentProvince = (provinceToCheck) => {
     let formattedProvince = (0, string_1.stripAccents)(provinceToCheck.toLowerCase());
     return (0, find_1.default)(data_1.provinces, (province) => (0, string_1.stripAccents)(province.value.toLowerCase()) === formattedProvince ||
@@ -378,6 +422,17 @@ const getTaxProvinceFromShippingAddress = (address) => {
     return taxProvince;
 };
 exports.getTaxProvinceFromShippingAddress = getTaxProvinceFromShippingAddress;
+/**
+ * Constructs and returns data for indexed cart (algolia or addio)
+ * @param cartData - Current cart data
+ * @param space - Space object
+ * @param options.setPaidAtIfUndefined - Optionnal - If true, will set paid_at with current date
+ * @param options.customer - Optionnal - If defined, adds info based on customer to indexedCart
+ * @param option.createdAt - Optionnal - If defined, added to indexedCart, else null value added
+ * @param option.updatedAt - Optionnal - If defined, added to indexedCart, else null value added
+ * @param associatedTransfers - Optionnal, used to pass transfers and statuses to indexed cart. Will only be added if cart's has_transfers prop is true
+ * @returns <IIndexedCart>
+ */
 const getIndexedCartData = (cartData, space, options = {}) => {
     var _a, _b, _c, _d, _e;
     const getPaidAt = () => {
@@ -402,6 +457,7 @@ const getIndexedCartData = (cartData, space, options = {}) => {
             : {}));
     }
     const cartPromos = (0, discount_1.getCartPromo)(cartData);
+    // If the cart has a promo applied with a promo code, or a discount on a product added via the POS, save info to index
     let hasPromos = !!cartPromos && !!cartPromos.length;
     let hasCustomDiscount = !!cartData.items.some((i) => !!(0, object_1.recursiveCheckObject)(i, 'promo_price.authorization.note') ||
         !!(0, object_1.recursiveCheckObject)(i, 'discount_price.authorization.note'));
@@ -413,7 +469,26 @@ const getIndexedCartData = (cartData, space, options = {}) => {
             ? (0, moment_1.default)((0, data_1.formatDate)(cartData.processed_by.date)).unix()
             : null }, (typeof cartData.to_be_verified_by_clerk !== 'undefined'
         ? { to_be_verified_by_clerk: cartData.to_be_verified_by_clerk }
-        : {})), { cart_promos_applied: cartPromos !== null && cartPromos !== void 0 ? cartPromos : null, has_promos: !!hasPromos ? hasPromos : null, has_custom_discount: !!hasCustomDiscount ? hasCustomDiscount : null, items: itemDict, is_booking: !!cartData.is_booking, is_promise_to_purchase: !!cartData.promise_to_purchase, has_transfers: !!cartData.has_transfers && !!options.associatedTransfers ? options.associatedTransfers : undefined }), getPaidAt()), (0, exports.getPaidByForIndexedCart)(cartData)), { subtotal: cartData.subtotal, total: cartData.total, is_pickup: !!cartData.is_pickup, out_of_zone: !!cartData.shipping_payload && !!cartData.shipping_payload.isOutOfArea, billing_phone: cartData.billing_address ? cartData.billing_address.expedition_recipient_phone : null, shipping_phone: cartData.shipping_address ? cartData.shipping_address.expedition_recipient_phone : null, customer_id: !!cartData.customer_id ? cartData.customer_id : null, customer_name: cartData.billing_address ? cartData.billing_address.expedition_recipient_name : null, customer_email: cartData.customer_info && cartData.customer_info.customer_default_email
+        : {})), { 
+        // --------------------------------
+        // #region PROMOS
+        cart_promos_applied: cartPromos !== null && cartPromos !== void 0 ? cartPromos : null, has_promos: !!hasPromos ? hasPromos : null, has_custom_discount: !!hasCustomDiscount ? hasCustomDiscount : null, 
+        // #endregion
+        // --------------------------------
+        // #region ITEMS AND SPECIFIC TYPES
+        items: itemDict, is_booking: !!cartData.is_booking, is_promise_to_purchase: !!cartData.promise_to_purchase, 
+        // #endregion
+        // --------------------------------
+        // #region TRANSFERS
+        has_transfers: !!cartData.has_transfers && !!options.associatedTransfers ? options.associatedTransfers : undefined }), getPaidAt()), (0, exports.getPaidByForIndexedCart)(cartData)), { subtotal: cartData.subtotal, total: cartData.total, 
+        // #endregions
+        // --------------------------------
+        // #region EXPEDITION
+        is_pickup: !!cartData.is_pickup, out_of_zone: !!cartData.shipping_payload && !!cartData.shipping_payload.isOutOfArea, billing_phone: cartData.billing_address ? cartData.billing_address.expedition_recipient_phone : null, shipping_phone: cartData.shipping_address ? cartData.shipping_address.expedition_recipient_phone : null, 
+        // #endregion
+        // --------------------------------
+        // #region CUSTOMER
+        customer_id: !!cartData.customer_id ? cartData.customer_id : null, customer_name: cartData.billing_address ? cartData.billing_address.expedition_recipient_name : null, customer_email: cartData.customer_info && cartData.customer_info.customer_default_email
             ? cartData.customer_info.customer_default_email
             : cartData.user_email
                 ? cartData.user_email
@@ -427,7 +502,11 @@ const getIndexedCartData = (cartData, space, options = {}) => {
                 ? Cart_1.CartCustomerEnum.CONNECTED
                 : Cart_1.CartCustomerEnum.GUEST, customer_rep: !!options.customer ? options.customer.represented_by : null, customer_external_class: (0, object_1.recursiveCheckObject)(cartData, 'customer_info.customer_external_class') ||
             (0, object_1.recursiveCheckObject)(options.customer, 'basic_info.customer_professionnal_info.external_customer_class') ||
-            null, keywords: (0, uniq_1.default)((0, flatten_1.default)(cartData.items.map((item) => {
+            null, 
+        // #endregion
+        // --------------------------------
+        // #region SEO / MARKETING
+        keywords: (0, uniq_1.default)((0, flatten_1.default)(cartData.items.map((item) => {
             return [...(item.name || []).map((n) => n.value), item.sku];
         }))), cart_slug_list: (0, uniq_1.default)(cartData.items.map((item) => {
             return item.parent_slug || '';
@@ -437,7 +516,9 @@ const getIndexedCartData = (cartData, space, options = {}) => {
                     frOnly: true,
                     slugSafe: (0, cart_1.checkIfCartContainsType)(cart_2.CartGeneralTypeEnum.BOOKING_BETON, cartData),
                     installAsType: true
-                }) }, (0, exports.getAssignedToInfo)(cartData)), { project_number: (_e = (0, object_1.recursiveCheckObject)(cartData, 'shipping_payload.orderOrProjectNumber')) !== null && _e !== void 0 ? _e : null }) : {})) : {}));
+                }) }, (0, exports.getAssignedToInfo)(cartData)), { project_number: (_e = (0, object_1.recursiveCheckObject)(cartData, 'shipping_payload.orderOrProjectNumber')) !== null && _e !== void 0 ? _e : null }) : {})) : {})
+    // #endregion
+    );
     return indexedCartData;
 };
 exports.getIndexedCartData = getIndexedCartData;
@@ -447,6 +528,7 @@ const getPaidByForIndexedCart = (order) => {
     const currentPaidBy = !!order.custom_payment_type && !!order.custom_payment_type.method
         ? order.custom_payment_type.method
         : order.paid_by;
+    // If order has multiple payment types...
     if (currentPaidBy === Cart_1.PaymentTypeEnum.MULTIPLE && !!order.payment_details && !!order.payment_details.length) {
         const firstPayment = order.payment_details.length === 1 || order.payment_details[0].method !== Cart_1.PaymentTypeEnum.TOBERECEIVED
             ? order.payment_details[0]
@@ -499,6 +581,7 @@ const checkIfShippingSameAsBilling = (cart) => {
 };
 exports.checkIfShippingSameAsBilling = checkIfShippingSameAsBilling;
 const getOrderStoreInfo = (spaceData, storeAddress) => {
+    // Pour algo, si informations du store correspondant non-trouvés, renvoit un 'all' pour qu'il affiche tout le temps
     const defaultStoreInfo = {
         id: 'all',
         name: 'all'
@@ -525,12 +608,15 @@ const getModifiedItems = (newItems, oldItems) => {
     let itemsForInventory = [];
     for (const i of newItems) {
         const itemInOldArray = oldItems.find((o) => o.sku === i.sku);
+        // If the item was not in the old cart, keep all its info
         if (!!!itemInOldArray) {
             itemsForInventory = [...itemsForInventory, i];
             continue;
         }
+        // If the item is the same in the old cart and in the new one, do nothing
         if (i.qte === itemInOldArray.qte)
             continue;
+        // If we are here, it means the item is still in the cart, but it's quantities changed. If the new qte is smaller, the new qte will be negative to add items back to inventory
         const newQte = i.qte - itemInOldArray.qte;
         itemsForInventory = [
             ...itemsForInventory,
@@ -539,6 +625,7 @@ const getModifiedItems = (newItems, oldItems) => {
     }
     for (const i of oldItems) {
         const itemInNewArray = newItems.find((o) => o.sku === i.sku);
+        // If the item used to be in the cart, but is no longer there, save all it's quantity as negative to put it back in the inventory
         if (!!!itemInNewArray) {
             itemsForInventory = [
                 ...itemsForInventory,
@@ -549,6 +636,11 @@ const getModifiedItems = (newItems, oldItems) => {
     return itemsForInventory;
 };
 exports.getModifiedItems = getModifiedItems;
+/**
+ * Get all active transfers for a cart where given items are found
+ * @param allTransfersForCart All transfers associated to a given cart
+ * @param cartItems All cart items for whitch to check transfers if found
+ */
 const getActiveTransfersByItemInCart = (allTransfersForCart, cartItems) => {
     if (!!!allTransfersForCart || !!!allTransfersForCart.length)
         return [];
@@ -569,11 +661,23 @@ const getActiveTransfersByItemInCart = (allTransfersForCart, cartItems) => {
     return foundInTransfer;
 };
 exports.getActiveTransfersByItemInCart = getActiveTransfersByItemInCart;
+/**
+ * Get the sale unit slug for a cart item
+ *
+ * @param item the cart item
+ * @returns unit slug or empty if not found
+ */
 const getItemSaleUnitSlug = (item) => {
     const unit = (item.other_units || []).find((x) => x.is_sale_unit);
     return unit ? unit.unit_slug : '';
 };
 exports.getItemSaleUnitSlug = getItemSaleUnitSlug;
+/**
+ * Constructs an object for each transfer, with corresponding products to update and by which quantity
+ * @param allCartTransfers All transfer objects associated to a given cart
+ * @param updatedItems Array of pertinent data per item updated to determine which transfers to update quantities for
+ * @returns {TransfersWithItemsToUpdate | undefined}
+ */
 const getItemsToUpdateByTransfer = (allCartTransfers, updatedItems) => {
     if (!!!allCartTransfers.length || !!!updatedItems.length)
         return;
@@ -591,8 +695,10 @@ const getItemsToUpdateByTransfer = (allCartTransfers, updatedItems) => {
         const filteredInventoriesByTransferStores = !!upItem.inventoryItem
             ? upItem.inventoryItem.inventories.filter((i) => transfersWithSameItem.some((t) => !!t.data().from && t.data().from == i.store_id))
             : undefined;
+        // A. If quantities are to be added...
         if (qteToUpdate > 0) {
             const inventoryUnitQteToUpdate = (0, inventories_1.getConvertedUnitQuantity)(upItem.item.other_units, qteToUpdate, 'inventory_unit', true);
+            // A1. ... If some transfers are currently at status INITIALIZED (with no "from" store set), add to first initialized found (since quantities can be redistributed by store when opening transfer)
             const initializedStatusTransfers = transfersWithSameItem.filter((t) => t.data().status == TransferRequest_1.TransferRequestStatusEnum.INITIATED);
             if (!!initializedStatusTransfers.length) {
                 const firstTransfer = initializedStatusTransfers[0];
@@ -607,6 +713,9 @@ const getItemsToUpdateByTransfer = (allCartTransfers, updatedItems) => {
                 transfersToUpdate[transferID] = dataForTransfer;
                 continue;
             }
+            // A2. ... Else, add to transfer where store has most quantities
+            // TODO - Should we check if quantities are available in store before adding to transfer ?
+            // TODO - Maybe based on if property space.options.transfer_requests.dont_limit_qty ?
             const storeWithMostQuantities = !!filteredInventoriesByTransferStores
                 ? filteredInventoriesByTransferStores.reduce((storeA, storeB) => (0, toNumber_1.default)(storeA.qty.available) > (0, toNumber_1.default)(storeB.qty.available) ? storeA : storeB)
                 : undefined;
@@ -620,8 +729,10 @@ const getItemsToUpdateByTransfer = (allCartTransfers, updatedItems) => {
             transfersToUpdate[transferToUse.data().id] = dataForTransfer;
             continue;
         }
+        // B. If quantities are to be removed...
         if (qteToUpdate < 0) {
-            let qteToRemove = qteToUpdate * -1;
+            // ... remove from all transfers until done, starting with transfers at status INITIALIZED, then by the store with the least quantities currently available
+            let qteToRemove = qteToUpdate * -1; // change to positive value to facilitate checks later. Will be changed to negative when saved in qteToUpdate props for each transfer
             let inventoryUnitQteToRemove = (0, inventories_1.getConvertedUnitQuantity)(upItem.item.other_units, qteToRemove, 'inventory_unit', true);
             const inventoriesByAvailabilityAsc = (0, orderBy_1.default)(filteredInventoriesByTransferStores, (i) => (0, toNumber_1.default)(i.qty.available));
             const transfersByInventory = (0, orderBy_1.default)(transfersWithSameItem, (t) => [
@@ -637,7 +748,7 @@ const getItemsToUpdateByTransfer = (allCartTransfers, updatedItems) => {
                 const currentQte = sameProd.qte;
                 const qteToBeUpdated = currentQte < inventoryUnitQteToRemove ? currentQte : inventoryUnitQteToRemove;
                 const dataForTransfer = transfersToUpdate[transfer.data().id] || [];
-                dataForTransfer.push({ sku, ajustmentQte: qteToBeUpdated == 0 ? qteToBeUpdated : qteToBeUpdated * -1 });
+                dataForTransfer.push({ sku, ajustmentQte: qteToBeUpdated == 0 ? qteToBeUpdated : qteToBeUpdated * -1 }); // value changed back to a negative here
                 transfersToUpdate[transfer.data().id] = dataForTransfer;
                 inventoryUnitQteToRemove -= qteToBeUpdated;
                 if (qteToRemove <= 0)
@@ -660,6 +771,7 @@ const getILangForUpdateType = (updateType) => {
 };
 exports.getILangForUpdateType = getILangForUpdateType;
 const getSubtotalToCheckForPromo = (allCartItems, currentCartSubtotal, space, feePromosTotalRemoved, removeServiceFees) => {
+    // ** NEW - Now excludes escompte supp. products from services when checking subtotal for promotions
     const serviceFeeProducts = !!!removeServiceFees
         ? []
         : allCartItems.filter((i) => !!i.is_service && !(0, g2_1.isEscompteSuppItem)(i.sku));
@@ -670,9 +782,11 @@ const getSubtotalToCheckForPromo = (allCartItems, currentCartSubtotal, space, fe
             return (0, round_1.default)(((0, isNumber_1.default)(itemPrice) ? Number(itemPrice) : 0) * i.qte, space.data().product_preferences.decimals || 2);
         });
     let totalRemoved = serviceFeeSubtotal;
+    // If there is a service and fees total, calculates the service and fees total after taking into account their promos
     if (!!totalRemoved) {
         totalRemoved -= feePromosTotalRemoved;
     }
+    // Removes that calculated total from the current subtotal to get the subtotal without services and fees, in order to calculate the right promo amount
     return currentCartSubtotal - totalRemoved;
 };
 exports.getSubtotalToCheckForPromo = getSubtotalToCheckForPromo;
@@ -680,7 +794,15 @@ const getAllPromoAppliedPrices = (allPromos, subtotalToUse, items, space, isRefu
     var _a;
     let promoAmounts = [];
     let updatedSubtotal = subtotalToUse;
+    // REMOVE PAYMENT INCENTIVE PROMOS FROM ARRAY
+    // Since this type of promos ('total_after_taxes') must be calculated and
+    // removed from total amount AFTER shipping and taxes are calculated,
+    // they will be dealt with later in process and must not count in "subtotalWithoutPromotions" prop
     let cartPromos = allPromos.filter((c) => c.applies_to != Cart_1.CartPromoAppliesToEnum.TOTAL_AFTER_TAXES);
+    // REORDER PROMOS
+    // a. if promos apply to products, bring to front of array
+    // b. if promos contain a promo_code that applies to subtotal,
+    //    push it to the end of the array to check that one last
     cartPromos = (0, orderBy_1.default)(cartPromos, (p) => {
         if ([Cart_1.CartPromoAppliesToEnum.PRODUCT, Cart_1.CartPromoAppliesToEnum.ITEMS].includes(p.applies_to))
             return 1;
@@ -724,6 +846,7 @@ const getAllPromoAppliedPrices = (allPromos, subtotalToUse, items, space, isRefu
             else {
                 amountToRemove = (_a = aPromo.amount_removed) !== null && _a !== void 0 ? _a : 0;
             }
+            // round amountToRemove before removing from subtotal
             amountToRemove = (0, round_1.default)(amountToRemove, 2);
             const newSubtotal = amountUnit === IDiscountRule_1.ResultActionEnum.AMOUNT || aPromo.applies_to === Cart_1.CartPromoAppliesToEnum.PRODUCT
                 ? updatedSubtotal - amountToRemove
@@ -751,6 +874,10 @@ const getAddressStrArray = (address) => {
     ].filter((addr) => !!addr.trim());
 };
 exports.getAddressStrArray = getAddressStrArray;
+/**
+ * Returns all payement methods for a given cart
+ * @param cartData
+ */
 const getCartPaymentMethods = (cartData) => {
     return !!cartData.payment_details
         ? (cartData.payment_details || []).map((p) => p.method)
@@ -759,9 +886,15 @@ const getCartPaymentMethods = (cartData) => {
             : [];
 };
 exports.getCartPaymentMethods = getCartPaymentMethods;
+/**
+ * Return last user to take payment for cart. Checks in order : 'completed_by' -> 'updated_by' -> 'processed_by' -> 'created_by'
+ * @param cartData The cart to check
+ * @param startCheckAt The step to start check at. Defaults to 'processed_by'
+ */
 const getLastUserWhoTookPayment = (cartData, startCheckAt = 'processed_by') => {
     let foundUser = undefined;
     let allSteps = ['completed_by', 'updated_by', 'processed_by', 'created_by'];
+    // Splice original array to only keep entries from specified startCheckAt property
     allSteps.splice(allSteps.indexOf(startCheckAt));
     const checkCartProp = (property) => {
         const foundData = cartData[property];
@@ -780,6 +913,14 @@ const getLastUserWhoTookPayment = (cartData, startCheckAt = 'processed_by') => {
     return foundUser;
 };
 exports.getLastUserWhoTookPayment = getLastUserWhoTookPayment;
+// #region CUSTOM PRICES AND ESCOMPTES (added by POS)
+/**
+ * Calculates applied amout for a custom added promo.
+ * @param item Cart item on which custom promo was applied
+ * @param type The custom promo type (unit price of added escompte)
+ * @param amount The fixed amount or percentage of custom price allocated
+ * @returns {number}
+ */
 const calculateAmountForCustomPromo = (item, type, amount) => {
     if (type === Cart_1.CustomPromoType.UNIT_PRICE)
         return amount;
@@ -788,6 +929,15 @@ const calculateAmountForCustomPromo = (item, type, amount) => {
     return initialPrice - promoAmount;
 };
 exports.calculateAmountForCustomPromo = calculateAmountForCustomPromo;
+// #endregion
+// #region STORE CREDIT MANAGEMENT
+/**
+ * Check if credit quantity for cart is valid and available.
+ * @param creditToBeUsedInCart Amount to be used in credits.
+ * @param customerID The customer's ID to check for available store credits.
+ * @param space The current space obj
+ * @param creditSlug La référence au type de store credit à vérifier
+ */
 const validateStoreCreditUsage = async (creditToBeUsedInCart, customerID, space, creditSlug) => {
     const hasStoreCreditsSet = space.options.checkIfOptionIsSet('payment.space_has_store_credits');
     if (!hasStoreCreditsSet) {
@@ -809,7 +959,10 @@ const validateStoreCreditUsage = async (creditToBeUsedInCart, customerID, space,
         };
     }
     const creditAmount = creditToBeUsedInCart !== null && creditToBeUsedInCart !== void 0 ? creditToBeUsedInCart : 0;
+    // VALIDATIONS
+    // a. Valide que le crédit demandé est positif
     let valid = creditAmount >= 0;
+    // b. Valide que le client a le reste nécessaire pour utiliser ses crédits comme mode de paiement
     if (valid) {
         let clientCheck = await space.customers.credits.validate(customerID, creditSlug, creditAmount);
         valid = !clientCheck;
@@ -824,14 +977,24 @@ const validateStoreCreditUsage = async (creditToBeUsedInCart, customerID, space,
         : {}));
 };
 exports.validateStoreCreditUsage = validateStoreCreditUsage;
+// #endregion
+/**
+ * Get total quantity of pallets purchased by a customer
+ * @param space - Space object
+ * @param customerId - Customer ID
+ * @returns Total quantity of pallets purchased
+ */
 const getPurchasedPalletsQuantityForCustomer = async (space, customerId) => {
     const palletSku = '210000000';
     const completedStatus = Cart_1.CartStatusEnum.COMPLETED;
     try {
+        // 1. Get search index info for the space
         const searchInfo = (0, searchIndexes_1.getFetchInfoAlgoliaAddioSearch)(space);
+        // 2. Fetch indexed completed orders for this customer that contain the pallet SKU (from 2026-01-01)
         const startDate = (0, moment_1.default)('2026-01-01');
         const endDate = (0, moment_1.default)();
         const filterStr = `customer_id:${customerId} AND status:${completedStatus} AND (created_at:${startDate.unix()} TO ${endDate.unix()}) AND (items.${palletSku}.refunded:false OR items.${palletSku}.refunded:true)`;
+        // 3. Fetch all pages and sum pallet quantities
         let totalPallets = 0;
         let currentPage = 0;
         let nbPages = 1;