addio-admin-sdk 1.7.103 → 1.7.104

package/dist/utils/discount.js

@@ -32,6 +32,12 @@ const cart_2 = require("../rules/GR/interfaces/cart");
 const object_1 = require("./object");
 const data_2 = require("../rules/GR/constants/data");
 const g2_1 = require("../rules/GR/utils/g2");
+// -----------------------------------------------------------------------------------
+// #region GENERAL
+/**
+ * Get formatted array of cart promos applied to a specific cart
+ * @param cartData
+ */
 const getCartPromo = (cartData) => {
     if (!!!cartData.cart_promo_applied && !!!cartData.cart_promos_applied)
         return;
@@ -42,11 +48,21 @@ const getCartPromo = (cartData) => {
             : [];
 };
 exports.getCartPromo = getCartPromo;
+/**
+ * Check if current cart promos applied contain a promo_code type promotion
+ * @param cartData
+ */
 const shouldCheckPromoCode = (cartData) => {
     return ((!!cartData.cart_promos_applied && !!cartData.cart_promos_applied.some((p) => p.promo_code)) ||
         (!!cartData.cart_promo_applied && !!cartData.cart_promo_applied.promo_code));
 };
 exports.shouldCheckPromoCode = shouldCheckPromoCode;
+/**
+ * Check if promo is expressed as a percentage
+ * @param promo The promo to check. Works for cart applied promo as well as discount rule
+ * @param options.includePaymentIncentiveInCheck Optionnal. If payement incentive promotions should also be included in check
+ * @returns {boolean}
+ */
 const isPromoAPercentage = (promo, options = {}) => {
     const promoPercentOptions = [
         IDiscountRule_1.ResultActionEnum.PERCENT,
@@ -91,6 +107,7 @@ const getAppliedAmountsForSubtotalPromosOnCart = (cartData) => {
         let amountRemoved = promo.amount_removed;
         const serviceAndFeesTotal = (0, exports.getOnlyServicesAndFeesSubtotal)(cartData, activePromos.items);
         if ((0, exports.isPromoAPercentage)(promo, { defaultToPercent: true })) {
+            // if the promo excludes services and fees, subtract the serviceAndFeesTotal from the subtotal
             if (!!promo.exclude_services_and_fees) {
                 amountRemoved = (0, round_1.default)((promo.amount_removed / 100) * (currentSubtotal - serviceAndFeesTotal), 3);
             }
@@ -104,7 +121,17 @@ const getAppliedAmountsForSubtotalPromosOnCart = (cartData) => {
     return promoAmounts;
 };
 exports.getAppliedAmountsForSubtotalPromosOnCart = getAppliedAmountsForSubtotalPromosOnCart;
+// #endregion
+// -----------------------------------------------------------------------------------
+// #region CHECK DISCOUNT ELIGIBILITY
+/**
+ * Check if a discount rule applies to a specific declination
+ * @param discount_rule - The discount rule to check
+ * @param declination - The declination to compare
+ * @param parentSlug - Optionnal. Used to check parent product slug with 'product' rule specifications. If not provided and 'product' rule found, returns true by default for rule check
+ */
 const shouldApplyRuleToDeclination = (discount_rule, declination, parentSlug) => {
+    // If discount has no rules, it means it applies to declination automatically
     if (!!!discount_rule.rules || !!!discount_rule.rules.length)
         return true;
     const currentDiscountMap = discount_rule.rules.map((rule) => {
@@ -119,6 +146,7 @@ const shouldApplyRuleToDeclination = (discount_rule, declination, parentSlug) =>
                     return [rule.condition, (0, exports.getResultRuleDetail)(ruleDetail, declination.sku)];
                 }));
             case IDiscountRule_1.RuleFieldEnum.DECLINATION:
+                // case 'slug':
                 return (0, flatten_1.default)(rule.ruleDetails.map((ruleDetail) => {
                     return [rule.condition, declination.sku === ruleDetail.value[0]];
                 }));
@@ -142,6 +170,11 @@ const shouldApplyRuleToDeclination = (discount_rule, declination, parentSlug) =>
     return _checkRuleApplicationArray(currentDiscountMap);
 };
 exports.shouldApplyRuleToDeclination = shouldApplyRuleToDeclination;
+/**
+ * Check if a specific rule of a discount rule is respected
+ * @param ruleDetail - The rule details object to check
+ * @param cartValue - The value to compare with rule specifications
+ */
 const getResultRuleDetail = (ruleDetail, cartValue, log) => {
     let ruleRespected = false;
     let isDate = false;
@@ -256,11 +289,17 @@ const getResultRuleDetail = (ruleDetail, cartValue, log) => {
     return ruleRespected;
 };
 exports.getResultRuleDetail = getResultRuleDetail;
+/**
+ * Check if rule applied to product attributes is respected for specific declination attributes
+ * @param attributeAndValues - The rule details object to check
+ * @param arrDeclinationAttributes - The declinations attributes to compare
+ */
 const checkAttributes = (attributeAndValues, arrDeclinationAttributes) => {
     const parentAttributeID = attributeAndValues.value[0].parentAttribute;
     const attributeValues = attributeAndValues.value[0].attributeOptions;
     const operator = attributeAndValues.operator;
     let matchingAttributes = false;
+    // const attrArray = arrDeclinationAttributes.map(decliAttr=>Array.isArray(decliAttr)?decliAttr.values[0].)
     for (let declinationAttribute of arrDeclinationAttributes) {
         if (!!matchingAttributes)
             return true;
@@ -295,11 +334,17 @@ const getCartPromoType = (discount) => {
         : Cart_1.CartPromoAppliesToEnum.SUBTOTAL;
 };
 exports.getCartPromoType = getCartPromoType;
+/**
+ * Check if promo code can be applied to a specific cart
+ * @param cart - The cart to check
+ * @param promoCode - The discount rule with promo code to check
+ */
 const checkPromoCodeEligibility = (cart, promoCode) => {
     var _a;
     let currentDiscountMap = [];
     const promoType = (0, exports.getCartPromoType)(promoCode);
     const currentPromos = (_a = (0, exports.getCartPromo)(cart)) !== null && _a !== void 0 ? _a : [];
+    // Only one promo for total_after_taxes can be applied to cart
     if (promoType == Cart_1.CartPromoAppliesToEnum.TOTAL_AFTER_TAXES &&
         currentPromos.some((p) => p.applies_to == Cart_1.CartPromoAppliesToEnum.TOTAL_AFTER_TAXES)) {
         return false;
@@ -320,12 +365,27 @@ const checkPromoCodeEligibility = (cart, promoCode) => {
     return _checkRuleApplicationArray(currentDiscountMap);
 };
 exports.checkPromoCodeEligibility = checkPromoCodeEligibility;
+// #endregion
+// -----------------------------------------------------------------------------------
+// #region TIER PRICING
+/**
+ * Returns tier pricing step that should be applied for provided quantity, or undefined if none should apply
+ * @param tierPricingToCheck - the indexed tier-pricing array to check
+ * @param qte
+ */
 const getTierPricingToApply = (tierPricingToCheck, qte) => {
     if (!!!tierPricingToCheck)
         return;
     return tierPricingToCheck.find((tp) => (0, toNumber_1.default)(tp.from) <= qte && (!!!tp.to || (0, toNumber_1.default)(tp.to) >= qte));
 };
 exports.getTierPricingToApply = getTierPricingToApply;
+/**
+ * Converts tier-pricing found in discount_rule to IIndexedTierPricing.
+ * @param discountRule - the tier-pricing tier discountRule to check
+ * @param price - declinations regular price from which tier-pricing result is calculated
+ * @param space
+ * @param decimals - the amount of decimals to show on tier-pricing result
+ */
 const applyTierPricing = (discountRule, price, space, decimals) => {
     if (!!!discountRule.rules || !!!discountRule.rules.length)
         return [];
@@ -361,6 +421,12 @@ const applyTierPricing = (discountRule, price, space, decimals) => {
     ];
 };
 exports.applyTierPricing = applyTierPricing;
+/**
+ * Calculate new discount_price object for cart item base on qte and tier_pricing
+ * @param item - the item to check
+ * @param setOriginalPrice - if original_amount should be set instead of discount_price.amount
+ * @param originalDecli - Optionnal. The IIndexedDeclination used to construct the cart item originally.
+ */
 const getNewDiscountPriceFromTierPricing = (item, setOriginalPrice, originalDecli) => {
     const tierPricingToApply = (0, exports.getTierPricingToApply)(item.tier_pricing, item.qte);
     const currentDiscountPrice = item.discount_price;
@@ -371,17 +437,23 @@ const getNewDiscountPriceFromTierPricing = (item, setOriginalPrice, originalDecl
         const { price_type, original_amount } = currentDiscountPrice, rest = __rest(currentDiscountPrice, ["price_type", "original_amount"]);
         prevDiscountPrice = Object.assign(Object.assign({}, rest), { amount: original_amount });
     }
+    // if current quantity does not fit in any defined tier_pricing tiers
     if (!!!tierPricingToApply) {
+        // if current item has overidden price as discount_price, set original_amount props instead of amount
         if (!!setOriginalPrice && !!currentDiscountPrice) {
             let amountToSet = item.regular_price.amount;
+            // if originalDecli was provided, fetch true original price from decli, else use items's regular price
             if (!!originalDecli) {
                 const calculatedPrice = (0, products_1.getLowestPrice)(Object.assign(Object.assign({}, originalDecli), { qte: item.qte }));
                 amountToSet = calculatedPrice.price.amount;
             }
             return Object.assign(Object.assign({}, currentDiscountPrice), { original_amount: !!originalDecli ? amountToSet : item.regular_price.amount });
         }
+        // if current discount_price has 'tierpricing' price_type, return prevDiscountPrice
+        // else, return current item discount_price
         return !!currentIsTierPricing ? prevDiscountPrice : currentDiscountPrice !== null && currentDiscountPrice !== void 0 ? currentDiscountPrice : null;
     }
+    // if current item has overidden price as discount_price,
     if (!!setOriginalPrice && !!currentDiscountPrice) {
         return Object.assign(Object.assign({}, currentDiscountPrice), { original_amount: tierPricingToApply.price.amount });
     }
@@ -392,6 +464,15 @@ const getNewDiscountPriceFromTierPricing = (item, setOriginalPrice, originalDecl
         : {}));
 };
 exports.getNewDiscountPriceFromTierPricing = getNewDiscountPriceFromTierPricing;
+// #endregion
+// -----------------------------------------------------------------------------------
+// #region APPLY DISCOUNTS/PROMOS
+/**
+ * Get discounted price after applying discount rules to a provided price
+ * @param discount_rules - The discount rules to apply
+ * @param amount - The initial amount on which to apply discounts
+ * @param space
+ */
 const applyDiscountRulesOnProduct = (discount_rules, amount, space) => {
     if (!!!discount_rules || !!!discount_rules.length)
         return undefined;
@@ -416,18 +497,34 @@ const applyDiscountRulesOnProduct = (discount_rules, amount, space) => {
             : current_promo_price;
 };
 exports.applyDiscountRulesOnProduct = applyDiscountRulesOnProduct;
+/**
+ * Get result of discount rule discount on a provided amount
+ * @param initial - The price on which to apply the discount
+ * @param discountResultObj - The discount rule result object
+ */
 const applyDiscountToPrice = (initial, discountResultObj) => {
     return discountResultObj.action === 'amount'
         ? initial - Number(discountResultObj.action_value)
         : initial * (1 - Number(discountResultObj.action_value) / 100);
 };
 exports.applyDiscountToPrice = applyDiscountToPrice;
+/**
+ * Get sku(s) affected by a promo as an array of strings
+ * @param valueToConvert  - The sku or sku array associated with the promo
+ * @returns And array of strings
+ */
 const getSkuArrayForPromo = (valueToConvert) => {
     if (!!Array.isArray(valueToConvert))
         return valueToConvert;
     return [valueToConvert];
 };
 exports.getSkuArrayForPromo = getSkuArrayForPromo;
+/**
+ * Returns a list of all skus where promo applied to specific products should apply. Check for both amount/percent_sku and amount/percent_category options.
+ * @param cartItems - The current cart items
+ * @param promoToCheck - The promo to check
+ * @returns An array of strings
+ */
 const getResultAppliedDiscountSkus = (cartItems, promoToCheck) => {
     var _a, _b, _c;
     const action = (_a = promoToCheck.result.action) !== null && _a !== void 0 ? _a : '';
@@ -437,6 +534,8 @@ const getResultAppliedDiscountSkus = (cartItems, promoToCheck) => {
         .filter((item) => {
         if (!!['amount_category', 'percent_category'].includes(action)) {
             const categorySlugsToCheck = (0, exports.getItemCategorySlugArray)(item.categories);
+            // Check if one of the slugs in item is EXACTLY the same as a category slug found in discount
+            // -- Done to remove cases where slug in discount is found partially in one of the levels
             return categoryArray.some((cat) => categorySlugsToCheck.includes(cat));
         }
         return skuArray.includes(item.sku);
@@ -445,14 +544,29 @@ const getResultAppliedDiscountSkus = (cartItems, promoToCheck) => {
     return productsToApplyPromo;
 };
 exports.getResultAppliedDiscountSkus = getResultAppliedDiscountSkus;
+/**
+ * Creates array of all category level slugs for a cart item.
+ * @param itemCategories - Value found in props cart.categories
+ * @returns An array of strings
+ */
 const getItemCategorySlugArray = (itemCategories) => {
     if (!!!itemCategories)
         return [];
+    // 1. Reorder item categories by key (can be in diff order in database)
     const orderedByLevel = (0, orderBy_1.default)(Object.entries(itemCategories), ([key, _value]) => key);
+    // 2. Then, isolate last category level's value, since it should contain all category levels seperated by string ' > '
     const lastLevelCategory = !!orderedByLevel.length ? orderedByLevel[orderedByLevel.length - 1][1] : '';
+    // 3. Split on ' > ' to create array of possible category slug values.
+    //    Check if one of the slugs is EXACTLY the same as the category slug found in le discount
     return lastLevelCategory.split(' > ');
 };
 exports.getItemCategorySlugArray = getItemCategorySlugArray;
+/**
+ * Apply all valid discounts found in a specific cart's discount_rules props to cart
+ * @param cart - The cart to check
+ * @param isMultiPromo
+ * @param forceShipping - If cart should be considered as a shipping cart, even if is_pickup is true
+ */
 const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPromos) => {
     var _a;
     const discountRules = !!forcedPromos
@@ -463,6 +577,7 @@ const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPr
     if (!!!discountRules || !!!discountRules.length) {
         return Object.assign(Object.assign(Object.assign({}, cart), (!!cart.cart_promo_applied ? { cart_promo_applied: null } : {})), (!!cart.cart_promos_applied ? { cart_promos_applied: null } : {}));
     }
+    // Remove all promos not found in cart discount_rules array
     let newCart = Object.assign(Object.assign(Object.assign({}, cart), (!!cart.cart_promo_applied &&
         !!!discountRules.some((dr) => dr.id === cart.cart_promo_applied.discount_id)
         ? { cart_promo_applied: null }
@@ -483,10 +598,15 @@ const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPr
         }
         return true;
     };
+    // Chaque fois que les totaux sont recalculés :
+    // -- on vérifie les codes promos déjà dans le panier qui s'appliquent sur des skus OU catégories spécifiques
+    // -- s'ils n'ont plus d'affaire à s'appliquer, on les retire du cartPromosApplied
+    // -- si de nouveaux produits eligibles sont ajoutés, on modifie le array de item_given avec les nouvelles valeurs à jour.
     const currentPromos = (0, exports.getCartPromo)(newCart);
     if (!!currentPromos) {
         let shouldRemovePromo = [];
         let shouldUpdatePromo = [];
+        // const currentPromoCodesApplied = currentPromos.filter((p) => !!p.promo_code)
         for (const appliedPromo of currentPromos) {
             if (appliedPromo.applies_to === Cart_1.CartPromoAppliesToEnum.PRODUCT && !!appliedPromo.item_given) {
                 const sameInCartDiscounts = discountRules.find((d) => d.id == appliedPromo.discount_id);
@@ -501,6 +621,7 @@ const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPr
                 }
             }
         }
+        // Update cart_promos_applied to remove unapplicable promos and update promos to current cart items
         newCart = Object.assign(Object.assign({}, newCart), (!!newCart.cart_promos_applied
             ? {
                 cart_promos_applied: newCart.cart_promos_applied
@@ -516,6 +637,7 @@ const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPr
     }
     for (const discount of discountRules) {
         if (!!discount.promo_code && !!discount.promo_code.code) {
+            // CHECK FOR PROMO_CODE ELIGIBILITY
             const promoCodeInCart = (currentPromos || []).find((p) => p.discount_id == discount.id);
             if (!!promoCodeInCart) {
                 const shouldStillApplyCode = (0, exports.checkPromoCodeEligibility)(newCart, discount);
@@ -619,6 +741,7 @@ const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPr
             let promo = 0;
             for (let i = 0; i < shippingPromo.length; i++) {
                 if (shippingPromo[i].amount_unit === 'free_shipping') {
+                    // si free on stop la
                     promo = i;
                     break;
                 }
@@ -646,6 +769,11 @@ const applyDiscountToCart = (cart, isMultiPromo, forceShipping = false, forcedPr
             : !!newCart.cart_promo_applied && newCart.cart_promo_applied.free_shipping });
 };
 exports.applyDiscountToCart = applyDiscountToCart;
+/**
+ * Get the ICartPromoApplied object for a specified discount_rule. Only works for promos that do not apply to products of certain categories/skus.
+ * @param cart
+ * @param discount
+ */
 const getStandardCartPromoFromDiscount = (cart, discount) => {
     const promoType = (0, exports.getCartPromoType)(discount);
     return Object.assign({ promo_name: (0, locale_1.getLocaleOfDictionnary)(discount.name, cart.locale), applies_to: promoType, amount_removed: promoType !== Cart_1.CartPromoAppliesToEnum.SHIPPING ? Number(discount.result.action_value) : 0, amount_unit: discount.result.action, item_given: promoType === Cart_1.CartPromoAppliesToEnum.ITEMS ? discount.result.action_value.toString() : '', item_given_amount: promoType === Cart_1.CartPromoAppliesToEnum.ITEMS && !!discount.result.action_qte
@@ -659,7 +787,15 @@ const getStandardCartPromoFromDiscount = (cart, discount) => {
         : {}));
 };
 exports.getStandardCartPromoFromDiscount = getStandardCartPromoFromDiscount;
+/**
+ * Calculates the cumulative subtotal for all service/fee type items in cart, including any applied promos. Usefull when calculating a promo's amount when all fees and services should be excluded.
+ * @param cartData - The cartData to check
+ * @param allCurrentAppliedToItemPromos - All currently active cartPromos that apply to items in cart. Sent seperatly in case local state is different from current cartData.
+ * @returns A number
+ */
 const getOnlyServicesAndFeesSubtotal = (cartData, allCurrentAppliedToItemPromos) => {
+    // Calculate the subtotal for just the fees and services, including their promos
+    // ** NEW - Now does not count escompte supp products as services when in promo on subtotal check
     let servicesAndFeesTotal = 0;
     cartData.items.forEach((i) => {
         if (!!!i.is_service || !!(0, g2_1.isEscompteSuppItem)(i.sku))
@@ -682,6 +818,8 @@ const getOnlyServicesAndFeesSubtotal = (cartData, allCurrentAppliedToItemPromos)
     return servicesAndFeesTotal;
 };
 exports.getOnlyServicesAndFeesSubtotal = getOnlyServicesAndFeesSubtotal;
+// =========================================================
+// #region UTILS FOR APPLYING CART DISCOUNTS AND PROMO CODES
 const _checkIfRuleAppliesToCart = (rule, appliesTo, cart) => {
     var _a;
     const todayDate = (0, moment_1.default)().toDate();
@@ -808,7 +946,11 @@ const _checkIfRuleAppliesToCart = (rule, appliesTo, cart) => {
                 ];
             }));
         case IDiscountRule_1.RuleFieldEnum.PAYMENT_METHOD:
-            if (cart.custom_payment_type &&
+            // If incentive custom_payment_type is registered, let this check pass, since payment_method will only be chosen on last step
+            // NOTE - Used to only apply to POS and POS_TRASACTIONNAL carts, now applies to all carts.
+            if (
+            // cart.cart_type != CartTypeEnum.WEB &&
+            cart.custom_payment_type &&
                 cart.custom_payment_type.method == Cart_1.CustomPaymentTypeEnum.INCENTIVE) {
                 return [ruleCondition, true];
             }
@@ -822,6 +964,8 @@ const _checkIfRuleAppliesToCart = (rule, appliesTo, cart) => {
                             ? [cart.paid_by]
                             : [];
             return (0, flatten_1.default)(rule.ruleDetails.map((ruleDetail) => {
+                // Si contains, doit contenir AU MOINS UN des modes de paiement ciblés
+                // Si contains-not, ne doit pas contenir QUE les modes de paiement exclus
                 let result = ruleDetail.operator == 'contains'
                     ? paymentTypesToCompare.some((type) => ruleDetail.value.includes(type))
                     : !paymentTypesToCompare.every((type) => ruleDetail.value.includes(type));
@@ -853,12 +997,27 @@ const _checkIfRuleAppliesToCart = (rule, appliesTo, cart) => {
             return [IDiscountRule_1.RuleConditionEnum.AND, true];
     }
 };
+/**
+ * Checks if discount rule should be applied to cart based on each rule verification results.
+ * @param checkedRulesApplicationArray - Array where each position is a verified rule result (condition with passed of failed (boolean))
+ * @returns A boolean
+ */
 const _checkRuleApplicationArray = (checkedRulesApplicationArray) => {
     return ((checkedRulesApplicationArray.some((option) => !!option && option.indexOf(IDiscountRule_1.RuleConditionEnum.OR) !== -1) &&
         checkedRulesApplicationArray.some((option) => !!option && option.indexOf(true) !== -1)) ||
         (checkedRulesApplicationArray.some((option) => !!option && option.indexOf(IDiscountRule_1.RuleConditionEnum.AND) !== -1) &&
             !checkedRulesApplicationArray.some((option) => !!option && option.indexOf(false) !== -1)));
 };
+// #endregion
+// #endregion
+// -----------------------------------------------------------------------------------
+// #region PAYMENT INCENTIVE DISCOUNTS/PROMOS
+/**
+ * Checks if an incentive discount could (in theory) by added to provided cart, by checking found incentive discount's rule array.
+ * @param cartData - The cart to check (checks discount_rules for incentive)
+ * @param skipCheckFor - If certain rules should be ignore for check
+ * @returns a boolean
+ */
 const checkIfCouldApplyIncentivePromo = (cartData, skipCheckFor = []) => {
     let afterTaxesPromo = cartData.discount_rules.find((d) => !d.draft &&
         (d.result.action == IDiscountRule_1.ResultActionEnum.PERCENT_AFTER_TAXES ||
@@ -876,6 +1035,11 @@ const checkIfCouldApplyIncentivePromo = (cartData, skipCheckFor = []) => {
     return _checkRuleApplicationArray(canApply);
 };
 exports.checkIfCouldApplyIncentivePromo = checkIfCouldApplyIncentivePromo;
+/**
+ * Calculates amount to be removed for payment incentive type promos.
+ * @param cartData
+ * @param checkDiscountRules - Optionnal. If cart discount_rules should be checked if cart_promos_applied does not have promo yet.
+ */
 const getAfterTaxesPromosTotalAmount = (cartData, checkDiscountRules) => {
     let currentSubtotal = cartData.subtotal;
     let afterTaxesPromo = (0, exports.getAfterTaxesPromoInCart)(cartData, checkDiscountRules);
@@ -891,10 +1055,16 @@ const getAfterTaxesPromosTotalAmount = (cartData, checkDiscountRules) => {
     return totalAmountForAfterTaxesPromos;
 };
 exports.getAfterTaxesPromosTotalAmount = getAfterTaxesPromosTotalAmount;
+/**
+ * Returns cart_promos_applied corresponding to payment incentive, if found. Can also check in discount_rules if props provided
+ * @param cartData
+ * @param checkDiscountRules - Optionnal. If the function should check in cart discount_rules if nothing found in cart_promos_applied or if value differs between discount and promo applied
+ */
 const getAfterTaxesPromoInCart = (cartData, checkDiscountRules) => {
     var _a;
     let cartPromos = (_a = (0, exports.getCartPromo)(cartData)) !== null && _a !== void 0 ? _a : [];
     let incentivePromo = cartPromos.find((p) => p.applies_to === Cart_1.CartPromoAppliesToEnum.TOTAL_AFTER_TAXES);
+    // Check discount_rule in case value changed or cart promo
     let discountIncentive = (0, exports.getPaymentIncentiveDiscount)(cartData.discount_rules);
     if (!!checkDiscountRules &&
         !!discountIncentive &&
@@ -904,10 +1074,16 @@ const getAfterTaxesPromoInCart = (cartData, checkDiscountRules) => {
     return incentivePromo;
 };
 exports.getAfterTaxesPromoInCart = getAfterTaxesPromoInCart;
+/**
+ * Returns the information regarding the payment incentive promo if found in cart's discount_rules
+ * @param cartData
+ * @param checkForAllPaidByDiscounts Optionnal. If defined, will check all discounts if no specific incentive found
+ */
 const getPaymentIncentiveDiscountInfo = (cartData, checkForAllPaidByDiscounts) => {
     let appliesToPaymentTypes = undefined;
     let paymentIncentiveDiscount = (0, exports.getPaymentIncentiveDiscount)(cartData.discount_rules);
     if (!!!paymentIncentiveDiscount) {
+        // If not found and props set, check all discounts and use first found with rule on payment methode
         if (!!checkForAllPaidByDiscounts)
             paymentIncentiveDiscount = cartData.discount_rules.find((d) => (d.rules || []).some((r) => r.field == IDiscountRule_1.RuleFieldEnum.PAYMENT_METHOD));
         if (!!!paymentIncentiveDiscount)
@@ -932,4 +1108,5 @@ const getPaymentIncentiveDiscount = (discountRules) => {
     return paymentIncentiveDiscount;
 };
 exports.getPaymentIncentiveDiscount = getPaymentIncentiveDiscount;
+// #endregion
 //# sourceMappingURL=discount.js.map