homeflowjs 1.0.61 → 1.0.63

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homeflowjs",
-  "version": "1.0.61",
+  "version": "1.0.63",
   "sideEffects": [
     "modal/**/*",
     "user/default-profile/**/*",

package/properties/properties-display/properties-display.component.jsx

@@ -90,7 +90,7 @@ const PropertiesDisplay = ({
     const propertiesLength = properties.length;
     const propertiesInsertsMap = new Map();
 
-    inserts.forEach((insert) => {
+    inserts?.forEach((insert) => {
       const property = properties[insert.index - 1] || properties[propertiesLength - 1];
       propertiesInsertsMap.set(property.property_id, insert);
     });

package/utils/stamp-duty-calculator/country-rates.js

@@ -0,0 +1,53 @@
+import { calculateRange, getPriceBracketIndex } from "./stamp-duty-utils";
+
+const countryRates = (price, firstTimeBuyer, additionalProperty, ukResident, country) => {
+  const countryConfig = {
+    'scotland': {
+      cmsData:  Homeflow.get('stamp_duty_scotland'),
+      base: 'base_lbtt_rate',
+    },
+    'wales': {
+      cmsData:  Homeflow.get('stamp_duty_wales'),
+      base: 'base_ltt_rate',
+    }
+  }
+  const cmsRates = countryConfig[country].cmsData;
+
+  const buyerStatusAsKeyOfObject = () => {
+    if(firstTimeBuyer) return 'first_time_buyer_rate';
+    if(additionalProperty) return 'additional_property_rate';
+    return countryConfig[country].base;
+  };
+  const bracketForPrice = +(cmsRates[getPriceBracketIndex(price, cmsRates)]['non_uk_resident_rate']);
+
+  const initalTotalRate = () => {
+    if (!ukResident && bracketForPrice) return +((price * (bracketForPrice / 100)).toFixed(2));
+    return 0;
+  }
+
+  const stampDutyRatesCalculation = cmsRates.reduce((accumulator, _, index) => {
+    const percentageFromList = +(cmsRates[index][buyerStatusAsKeyOfObject()]) / 100;
+    const minimumPropertyPrice = cmsRates[index]['minimum_property_price'] || Number.POSITIVE_INFINITY;
+    const maxisumPropertyPrice = cmsRates[index]['maximum_property_price'] || Number.POSITIVE_INFINITY;
+    const rateIndex = `rate${index + 1}`;
+    const rateForTheBracket = calculateRange(price, minimumPropertyPrice, maxisumPropertyPrice, percentageFromList);
+
+    accumulator[rateIndex] = rateForTheBracket;
+    accumulator.totalRate += rateForTheBracket;
+
+    accumulator.effectiveRate = (accumulator.totalRate / price) * 100;
+
+    return accumulator;
+  }, {
+    totalRate: initalTotalRate(),
+    effectiveRate: 0,
+  });
+
+  // Roundings
+  stampDutyRatesCalculation.effectiveRate = Math.round(stampDutyRatesCalculation.effectiveRate * 10) / 10;
+  stampDutyRatesCalculation.totalRate = Math.round(stampDutyRatesCalculation.totalRate);
+
+  return stampDutyRatesCalculation;
+};
+
+export default countryRates;

package/utils/stamp-duty-calculator/english-rates.js

@@ -1,79 +1,55 @@
-const calculateRange = (price, lower, upper, rate) => {
-  if (price <= lower) return 0;
-  return (Math.min(upper, price) - lower) * rate;
-};
+import { calculateRange, getPriceBracketIndex } from "./stamp-duty-utils";
 
 const englishRates = (
-  price,
+  price = 0,
   firstTimeBuyer,
   additionalProperty,
   ukResident = true, // Default to true if not explicitly specified
   isCompany
 ) => {
-  // Handle cases where price is missing or invalid
-  if (!price || price <= 0) {
-    return {
-      rate1: 0,
-      rate2: 0,
-      rate3: 0,
-      rate4: 0,
-      rate5: 0,
-      totalRate: 0,
-      effectiveRate: 0,
-    };
-  }
+  const englandRatesList = Homeflow.get('stamp_duty_england');
+  const bracketForPrice = +(englandRatesList[getPriceBracketIndex(price, englandRatesList)]['non_uk_resident_rate']);
 
-  let effectiveRate = 0;
-  let totalRate = 0;
-  let rate1 = 0;
-  let rate2 = 0;
-  let rate3 = 0;
-  let rate4 = 0;
-  let rate5 = 0;
+  const buyerStatusAsKeyOfObject = () => {
+    if(firstTimeBuyer) return 'first_time_buyer_rate';
+    if(additionalProperty) return 'additional_property_rate';
+    return 'base_sdlt_rate';
+  };
 
-  if (isCompany) {
-    // Company buy: Flat rate of 17% for properties above £500,000
-    if (price > 500000) {
-      totalRate = price * 0.17;
-    }
-  } else {
-    // Individual buyers
-    if (firstTimeBuyer && price <= 625000) {
-      rate2 = calculateRange(price, 425000, Number.POSITIVE_INFINITY, 0.05);
-    }
+  /**
+   * ATM the BE work doesn't have % for company purchases.
+   * Once that's done we can initiate the base object totalRate for:
+   * totalRate: (!ukResident && bracketForPrice) ? +((price * (bracketForPrice / 100)).toFixed(2)) : 0,
+   * But for now we need to have the 3 options + the hardcoded 17%
+   */
+  const initalTotalRate = () => {
+    if(isCompany && price > 500_000) return price * 0.17;
+    if (!ukResident && bracketForPrice && !isCompany) return +((price * (bracketForPrice / 100)).toFixed(2));
+    return 0;
+  }
 
-    if (additionalProperty) {
-      // Additional property rates
-      rate1 = calculateRange(price, 0, 250000, 0.05);
-      rate2 = calculateRange(price, 250000, 925000, 0.10);
-      rate3 = calculateRange(price, 925000, 1500000, 0.15);
-      rate4 = calculateRange(price, 1500000, Number.POSITIVE_INFINITY, 0.17);
-    } else if (!(firstTimeBuyer && price <= 625000)) {
-      // Moving or first-time buyer > £625,000
-      rate2 = calculateRange(price, 250000, 925000, 0.05);
-      rate3 = calculateRange(price, 925000, 1500000, 0.10);
-      rate4 = calculateRange(price, 1500000, Number.POSITIVE_INFINITY, 0.12);
-    }
+  const stampDutyRatesCalculation = englandRatesList.reduce((accumulator, _, index) => {
+    const percentageFromList = +(englandRatesList[index][buyerStatusAsKeyOfObject()]) / 100;
+    const minimumPropertyPrice = englandRatesList[index]['minimum_property_price'] || Number.POSITIVE_INFINITY;
+    const maxisumPropertyPrice = englandRatesList[index]['maximum_property_price'] || Number.POSITIVE_INFINITY;
+    const rateIndex = `rate${index + 1}`;
+    const rateForTheBracket = isCompany
+      ? 0
+      : calculateRange(price, minimumPropertyPrice, maxisumPropertyPrice, percentageFromList);
 
-    totalRate = rate1 + rate2 + rate3 + rate4 + rate5;
+    accumulator[rateIndex] = rateForTheBracket;
+    accumulator.totalRate += rateForTheBracket;
 
-    // Apply additional rate for non-UK residents only if applicable
-    if (!ukResident) {
-      totalRate += price * 0.02; // Non-UK resident surcharge
-    }
-  }
+    accumulator.effectiveRate = (accumulator.totalRate / price) * 100;
 
-  effectiveRate = (totalRate / price) * 100;
+    return accumulator;
+  }, {
+    // totalRate: (!ukResident && bracketForPrice) ? +((price * (bracketForPrice / 100)).toFixed(2)) : 0,
+    totalRate: initalTotalRate(),
+    effectiveRate: 0,
+  });
 
-  return {
-    rate1,
-    rate2,
-    rate3,
-    rate4,
-    rate5,
-    totalRate,
-    effectiveRate,
-  };
+  return stampDutyRatesCalculation;
 };
 
 export default englishRates;

package/utils/stamp-duty-calculator/stamp-duty-calculator.js

@@ -1,6 +1,5 @@
 import englishRates from './english-rates';
-import scottishRates from './scottish-rates';
-import welshRates from './welsh-rates';
+import countryRates from './country-rates';
 
 /**
  * We already have a DefaultStampDutyCalculator component,
@@ -18,14 +17,13 @@ const stampDutyCalculator = ({
     };
   }
 
-  // Scotland
-  if (country === 'scotland') {
-    return scottishRates(price, firstTimeBuyer, additionalProperty, ukResident);
-  }
-
-  // Wales
-  if (country === 'wales') {
-    return welshRates(price, additionalProperty, ukResident);
+  /**
+   * For Scotland and Wales
+   * Once the BE brings data for companies (isCompany)
+   * countryRates will need an update and then we can have just one method.
+   */
+  if (country === 'scotland' || country === 'wales') {
+    return countryRates(price, firstTimeBuyer, additionalProperty, ukResident, country);
   }
 
   // If country not is not specified use English rates by default

package/utils/stamp-duty-calculator/stamp-duty-utils.js

@@ -0,0 +1,21 @@
+export const calculateRange = (price, lower, upper, rate) => {
+  if (price <= lower) return 0;
+  return Math.round(((Math.min(upper, price) - lower) * rate) * 10) / 10;
+};
+
+export const getPriceBracketIndex = (price, arr) => {
+  const lastIndex = arr.length - 1;
+  let bracketIndex = null;
+
+  if (price <= arr[0].maximum_property_price) return 0;
+  if (price >= arr[lastIndex].minimum_property_price) return lastIndex;
+
+  arr.forEach((rates, index) => {
+    if (
+      (rates.minimum_property_price || 0) <= price
+      && (rates.minimum_property_price || Number.POSITIVE_INFINITY) > price
+    ) bracketIndex = index;
+  });
+
+  return bracketIndex || 0;
+}

package/utils/stamp-duty-calculator/scottish-rates.js

@@ -1,104 +0,0 @@
-const scottishRates = (price, firstTimeBuyer, additionalProperty, ukResident) => {
-  let effectiveRate = 0;
-  let totalRate = 0;
-  const rate1 = 0;
-  let rate2 = 0;
-  let rate3 = 0;
-  let rate4 = 0;
-  let rate5 = 0;
-
-  if (firstTimeBuyer) {
-    // Rate 2
-    if (price - 175000 > 0) {
-      if ((price - 175000) > (250000 - 175000)) {
-        rate2 = (250000 - 175000) * 0.02;
-      } else {
-        rate2 = (price - 175000) * 0.02;
-      }
-    }
-
-    // Rate 3
-    if (price - 250000 > 0) {
-      if ((price - 250000) > (325000 - 250000)) {
-        rate3 = (325000 - 250000) * 0.05;
-      } else {
-        rate3 = (price - 250000) * 0.05;
-      }
-    }
-
-    // Rate 4
-    if (price - 325000 > 0) {
-      if ((price - 325000) > (750000 - 325000)) {
-        rate4 = (750000 - 325000) * 0.10;
-      } else {
-        rate4 = (price - 325000) * 0.10;
-      }
-    }
-
-    // Rate 5
-    if (price - 750000 > 0) {
-      rate5 = (price - 750000);
-      rate5 *= 0.12;
-    }
-  }
-
-  if (!firstTimeBuyer) {
-    // Rate 2
-    if (price - 145000 > 0) {
-      if ((price - 145000) > (250000 - 145000)) {
-        rate2 = (250000 - 145000) * 0.02;
-      } else {
-        rate2 = (price - 145000) * 0.02;
-      }
-    }
-
-    // Rate 3
-    if (price - 250000 > 0) {
-      if ((price - 250000) > (325000 - 250000)) {
-        rate3 = (325000 - 250000) * 0.05;
-      } else {
-        rate3 = (price - 250000) * 0.05;
-      }
-    }
-
-    // Rate 4
-    if (price - 325000 > 0) {
-      if ((price - 325000) > (750000 - 325000)) {
-        rate4 = (750000 - 325000) * 0.10;
-      } else {
-        rate4 = (price - 325000) * 0.10;
-      }
-    }
-
-    // Rate 5
-    if (price - 750000 > 0) {
-      rate5 = (price - 750000);
-      rate5 *= 0.12;
-    }
-  }
-
-  totalRate = rate1 + rate2 + rate3 + rate4 + rate5;
-  effectiveRate = totalRate / price;
-  if (!ukResident) {
-    totalRate = totalRate * (effectiveRate + 0.02) / effectiveRate;
-    effectiveRate += 0.02;
-  }
-  effectiveRate *= 100;
-
-  if (additionalProperty) {
-    const ADS = price * 0.06;
-    totalRate += ADS;
-  }
-
-  return {
-    rate1,
-    rate2,
-    rate3,
-    rate4,
-    rate5,
-    totalRate,
-    effectiveRate: Math.round(effectiveRate * 10) / 10,
-  };
-};
-
-export default scottishRates;

package/utils/stamp-duty-calculator/welsh-rates.js

@@ -1,114 +0,0 @@
-const welshRates = (price, additionalProperty, ukResident) => {
-  let effectiveRate = 0;
-  let totalRate = 0;
-  let rate1 = 0;
-  let rate2 = 0;
-  let rate3 = 0;
-  let rate4 = 0;
-  let rate5 = 0;
-  let rate6 = 0;
-
-  if (additionalProperty) {
-    // Rate 1
-    if (price > 180000) rate1 = 180000 * 0.05;
-    if (price <= 180000) {
-      rate1 = price * 0.05;
-    }
-
-    // Rate 2
-    if (price - 180000 > 0) {
-      if ((price - 180000) > (250000 - 180000)) {
-        rate2 = (250000 - 180000) * 0.085;
-      } else {
-        rate2 = (price - 180000) * 0.085;
-      }
-    }
-
-    // Rate 3
-    if (price - 250000 > 0) {
-      if ((price - 250000) > (400000 - 250000)) {
-        rate3 = (400000 - 250000) * 0.10;
-      } else {
-        rate3 = (price - 250000) * 0.10;
-      }
-    }
-
-    // Rate 4
-    if (price - 400000 > 0) {
-      if ((price - 400000) > (750000 - 400000)) {
-        rate4 = (750000 - 400000) * 0.125;
-      } else {
-        rate4 = (price - 400000) * 0.125;
-      }
-    }
-
-    // Rate 5
-    if (price - 750000 > 0) {
-      if ((price - 750000) > (1500000 - 750000)) {
-        rate5 = (1500000 - 750000) * 0.15;
-      } else {
-        rate5 = (price - 750000) * 0.15;
-      }
-    }
-
-    // Rate 6
-    if (price - 1500000 > 0) {
-      rate6 = (price - 1500000) * 0.17;
-    }
-  }
-
-  if (!additionalProperty) {
-    // Rate 2
-    if (price - 225000 > 0) {
-      if ((price - 225000) > (400000 - 225000)) {
-        rate2 = (400000 - 225000) * 0.06;
-      } else {
-        rate2 = (price - 225000) * 0.06;
-      }
-    }
-
-    // Rate 3
-    if (price - 400000 > 0) {
-      if ((price - 400000) > (750000 - 400000)) {
-        rate3 = (750000 - 400000) * 0.075;
-      } else {
-        rate3 = (price - 400000) * 0.075;
-      }
-    }
-
-    // Rate 4
-    if (price - 750000 > 0) {
-      if ((price - 750000) > (1500000 - 750000)) {
-        rate4 = (1500000 - 750000) * 0.10;
-      } else {
-        rate4 = (price - 750000) * 0.10;
-      }
-    }
-
-    // Rate 5
-    if (price - 1500000 > 0) {
-      rate5 = (price - 1500000) * 0.12;
-    }
-  }
-
-  totalRate = rate1 + rate2 + rate3 + rate4 + rate5 + rate6;
-  effectiveRate = totalRate / price;
-  if (!ukResident) {
-    totalRate = totalRate * (effectiveRate + 0.02) / effectiveRate;
-    effectiveRate += 0.02;
-  }
-  effectiveRate *= 100;
-
-  return {
-    rate1,
-    rate2,
-    rate3,
-    rate4,
-    rate5,
-    rate6,
-    totalRate,
-    effectiveRate: Math.round(effectiveRate * 10) / 10,
-  };
-};
-
-export default welshRates;