homeflowjs 1.0.67 → 1.0.68

package/package.json

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

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

@@ -9,40 +9,47 @@ const englishRates = (
 ) => {
   const englandRatesList = Homeflow.get('stamp_duty_england');
 
-  const buyerStatusAsKeyOfObject = () => {
-    if(firstTimeBuyer) return 'first_time_buyer_rate';
-    if(additionalProperty) return 'additional_property_rate';
-    return 'base_sdlt_rate';
-  };
-
-  /**
-   * 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;
-    return 0;
+  const ratesToCalculateBasedOnTaxType = () => {
+    const baseRates = englandRatesList['base'];
+    const firstTimeBuyerRates = englandRatesList['first_time_buyer'];
+
+    if (firstTimeBuyer) {
+      const priceLimit = firstTimeBuyerRates[firstTimeBuyerRates?.length - 1]
+        ?.['maximum_property_price'];
+
+      if (priceLimit && price > priceLimit) {
+        return baseRates;
+      } else {
+        return firstTimeBuyerRates;
+      }
+    }
+
+    return baseRates;
   }
 
-  const stampDutyRatesCalculation = englandRatesList.reduce((accumulator, _, index) => {
+  const ratesList = ratesToCalculateBasedOnTaxType();
+
+  const stampDutyRatesCalculation = ratesList.reduce((accumulator, _, index) => {
     // Minumun price from the 1st braket should be always 0
     const minimunFallback = index === 0 ? 0 : Number.POSITIVE_INFINITY;
-    const minimumPropertyPrice = englandRatesList[index]['minimum_property_price'] || minimunFallback;
-    const maxisumPropertyPrice = englandRatesList[index]['maximum_property_price'] || Number.POSITIVE_INFINITY;
+    const minimumPropertyPrice = ratesList[index]['minimum_property_price'] || minimunFallback;
+    const maximumPropertyPrice = ratesList[index]['maximum_property_price'] || Number.POSITIVE_INFINITY;
     const rateIndex = `rate${index + 1}`;
-    let percentageFromList = +(englandRatesList[index][buyerStatusAsKeyOfObject()]) / 100;
+    let percentageFromList = +(ratesList[index]['base_sdlt_rate']) / 100;
+
+    if (!ukResident && ratesList[index]?.['non_uk_resident_surcharge']) {
+      percentageFromList += (+(ratesList[index]?.['non_uk_resident_surcharge']) / 100);
+    }
 
-    if (!ukResident && englandRatesList[index]?.['non_uk_resident_rate']) {
-      percentageFromList += (+(englandRatesList[index]?.['non_uk_resident_rate']) / 100);
+    if ((additionalProperty || isCompany) && ratesList[index]?.['additional_property_surcharge']) {
+      percentageFromList += (+(ratesList[index]?.['additional_property_surcharge']) / 100);
     }
 
     percentageFromList = parseFloat(percentageFromList.toFixed(3));
 
-    const rateForTheBracket = isCompany
-      ? 0
-      : calculateRange(price, minimumPropertyPrice, maxisumPropertyPrice, percentageFromList);
+    const rateForTheBracket = calculateRange(
+      price, minimumPropertyPrice, maximumPropertyPrice, percentageFromList,
+    );
 
     accumulator[rateIndex] = rateForTheBracket;
     accumulator.totalRate += rateForTheBracket;
@@ -51,7 +58,7 @@ const englishRates = (
 
     return accumulator;
   }, {
-    totalRate: initalTotalRate(),
+    totalRate: 0,
     effectiveRate: 0,
   });
 

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

@@ -0,0 +1,48 @@
+import { calculateRange, getPriceBracketIndex } from "./stamp-duty-utils";
+
+const scotlandRates = (price, firstTimeBuyer, additionalProperty, isCompany) => {
+  const scotlandRatesList = Homeflow.get('stamp_duty_scotland');
+
+  const ratesToCalculateBasedOnTaxType = () => {
+    if(firstTimeBuyer) return scotlandRatesList['first_time_buyer'];
+    return scotlandRatesList['base'];
+  };
+
+  const ratesList = ratesToCalculateBasedOnTaxType();
+
+  const stampDutyRatesCalculation = ratesList.reduce((accumulator, _, index) => {
+    // Minumun price from the 1st braket should be always 0
+    const minimunFallback = index === 0 ? 0 : Number.POSITIVE_INFINITY;
+    const percentageFromList = +(ratesList[index]['base_lbtt_rate']) / 100;
+    const minimumPropertyPrice = ratesList[index]['minimum_property_price'] || minimunFallback;
+    const maximumPropertyPrice = ratesList[index]['maximum_property_price'] || Number.POSITIVE_INFINITY;
+    const rateIndex = `rate${index + 1}`;
+    const rateForTheBracket = calculateRange(price, minimumPropertyPrice, maximumPropertyPrice, percentageFromList);
+
+    accumulator[rateIndex] = rateForTheBracket;
+    accumulator.totalRate += rateForTheBracket;
+
+    accumulator.effectiveRate = (accumulator.totalRate / price) * 100;
+
+    return accumulator;
+  }, {
+    totalRate: 0,
+    effectiveRate: 0,
+  });
+
+  if (additionalProperty || isCompany) {
+    const additionalDwellingSurcharge = ratesList[getPriceBracketIndex(price, ratesList)]
+      ?.['additional_property_surcharge'];
+    if (additionalDwellingSurcharge) {
+      stampDutyRatesCalculation.totalRate += ((price * additionalDwellingSurcharge) / 100);
+    };
+  }
+
+  // Roundings
+  stampDutyRatesCalculation.effectiveRate = Math.round(stampDutyRatesCalculation.effectiveRate * 10) / 10;
+  stampDutyRatesCalculation.totalRate = Math.round(stampDutyRatesCalculation.totalRate);
+  
+  return stampDutyRatesCalculation;
+};
+
+export default scotlandRates;

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

@@ -1,5 +1,6 @@
 import englishRates from './english-rates';
-import countryRates from './country-rates';
+import walesRates from './wales-rates';
+import scotlandRates from './scotand-rates';
 
 /**
  * We already have a DefaultStampDutyCalculator component,
@@ -17,16 +18,13 @@ const stampDutyCalculator = ({
     };
   }
 
-  /**
-   * 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?.toLowerCase() === 'scotland'
-    || country?.toLowerCase() === 'wales')
-  {
-    return countryRates(price, firstTimeBuyer, additionalProperty, ukResident, country);
+  if (country?.toLowerCase() === 'scotland') {
+    return scotlandRates(price, firstTimeBuyer, additionalProperty, isCompany);
+  };
+
+
+  if (country?.toLowerCase() === 'wales') {
+    return walesRates(price, additionalProperty, isCompany);
   }
 
   // If country not is not specified use English rates by default

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

@@ -12,10 +12,10 @@ export const getPriceBracketIndex = (price, arr) => {
 
   arr.forEach((rates, index) => {
     if (
-      (+(rates.maximum_property_price) || Number.POSITIVE_INFINITY) > price
-      && +(rates.minimum_property_price) < price
+      (+(rates.maximum_property_price) || Number.POSITIVE_INFINITY) >= price
+      && +(rates.minimum_property_price) <= price
     ) bracketIndex = index;
   });
 
-  return bracketIndex || 0;
+  return bracketIndex;
 }

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

@@ -0,0 +1,41 @@
+import { calculateRange } from "./stamp-duty-utils";
+
+const walesRates = (price, additionalProperty, isCompany) => {
+  const walesRatesList = Homeflow.get('stamp_duty_wales');
+
+  const ratesToCalculateBasedOnTaxType = () => {
+    if(additionalProperty || isCompany) return walesRatesList['corporate_buyer'];
+    return walesRatesList['base'];
+  };
+
+  const ratesList = ratesToCalculateBasedOnTaxType();
+
+  const stampDutyRatesCalculation = ratesList.reduce((accumulator, _, index) => {
+    // Minumun price from the 1st braket should be always 0
+    const minimunFallback = index === 0 ? 0 : Number.POSITIVE_INFINITY;
+    const percentageFromList = +(ratesList[index]['base_ltt_rate']) / 100;
+    const minimumPropertyPrice = ratesList[index]['minimum_property_price'] || minimunFallback;
+    const maximumPropertyPrice = ratesList[index]['maximum_property_price'] || Number.POSITIVE_INFINITY;
+    const rateIndex = `rate${index + 1}`;
+    const rateForTheBracket = calculateRange(price, minimumPropertyPrice, maximumPropertyPrice, percentageFromList);
+
+    accumulator[rateIndex] = rateForTheBracket;
+    accumulator.totalRate += rateForTheBracket;
+
+    accumulator.effectiveRate = (accumulator.totalRate / price) * 100;
+
+    return accumulator;
+  }, {
+    totalRate: 0,
+    effectiveRate: 0,
+  });
+
+  // Roundings
+  stampDutyRatesCalculation.effectiveRate = Math.round(stampDutyRatesCalculation.effectiveRate * 10) / 10;
+  stampDutyRatesCalculation.totalRate = Math.round(stampDutyRatesCalculation.totalRate);
+
+
+  return stampDutyRatesCalculation;
+};
+
+export default walesRates;

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

@@ -1,49 +0,0 @@
-import { calculateRange } 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 stampDutyRatesCalculation = cmsRates.reduce((accumulator, _, index) => {
-    // Minumun price from the 1st braket should be always 0
-    const minimunFallback = index === 0 ? 0 : Number.POSITIVE_INFINITY;
-    const percentageFromList = +(cmsRates[index][buyerStatusAsKeyOfObject()]) / 100;
-    const minimumPropertyPrice = cmsRates[index]['minimum_property_price'] || minimunFallback;
-    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: 0,
-    effectiveRate: 0,
-  });
-
-  // Roundings
-  stampDutyRatesCalculation.effectiveRate = Math.round(stampDutyRatesCalculation.effectiveRate * 10) / 10;
-  stampDutyRatesCalculation.totalRate = Math.round(stampDutyRatesCalculation.totalRate);
-
-  return stampDutyRatesCalculation;
-};
-
-export default countryRates;