@transferwise/comparison-components 20.1.1 → 20.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transferwise/comparison-components",
-  "version": "20.1.1",
+  "version": "20.1.5",
   "description": "Display a comparison table of providers given a route and amount.",
   "homepage": "https://wise.com/gb/compare/",
   "main": "dist/umd/comparison-components.js",

package/src/resources/clients/quotes/__test__/transformQuotesResponseV2.spec.ts

@@ -483,4 +483,181 @@ describe('quotes v3 response transformations to the canonical model V2', () => {
 
     expect(transformQuotesResponseV2(providers, wiseProvider)).toStrictEqual(expected);
   });
+
+  it('given a route with a small send amount with a decimal currency, and provider does have a hidden fee, do show the hidden fee', () => {
+    const wiseProvider = {
+      ...wiseQuoteApiAdjusted,
+      rate: 0.88665,
+    };
+    const providers = {
+      providers: [
+        {
+          name: 'Western Union',
+          alias: 'western-union',
+          logo: 'https://dq8dwmysp7hk1.cloudfront.net/logos/western-union.svg',
+          partner: true,
+          quotes: [
+            {
+              rate: 0.00759645,
+              fee: 0,
+              dateCollected: new Date('2018-10-23T12:03:27'),
+              receivedAmount: 21.67,
+            },
+          ],
+        },
+      ],
+      sendAmount: 25,
+      sourceCurrency: 'USD',
+      targetCurrency: 'EUR',
+    };
+
+    const expected = {
+      quotes: [
+        {
+          provider: {
+            name: 'Western Union',
+            alias: 'western-union',
+            logoUrl: 'https://dq8dwmysp7hk1.cloudfront.net/logos/western-union.svg',
+            partner: true,
+          },
+          route: {
+            sourceCurrency: 'USD',
+            targetCurrency: 'EUR',
+          },
+          rate: 0.00759645,
+          fees: {
+            breakdown: [
+              {
+                type: FeeType.HIDDEN,
+                amount: { value: 0.55, currency: 'USD' },
+              },
+            ],
+            total: { value: 0.55, currency: 'USD' },
+          },
+          receiveAmount: { value: 21.67, currency: 'EUR' },
+          sendAmount: { value: 25, currency: 'USD' },
+        },
+      ],
+    };
+
+    expect(transformQuotesResponseV2(providers, wiseProvider)).toStrictEqual(expected);
+  });
+
+  it('given a route with a small send amount with a non-decimal currency as source, and provider doesnt have a hidden fee, dont show the hidden fee', () => {
+    const wiseProvider = {
+      ...wiseQuoteApiAdjusted,
+      rate: 0.0000612414,
+    };
+    const providers = {
+      providers: [
+        {
+          name: 'Western Union',
+          alias: 'western-union',
+          logo: 'https://dq8dwmysp7hk1.cloudfront.net/logos/western-union.svg',
+          partner: true,
+          quotes: [
+            {
+              rate: 0.00759645,
+              fee: 12175,
+              dateCollected: new Date('2018-10-23T12:03:27'),
+              receivedAmount: 0.17,
+            },
+          ],
+        },
+      ],
+      sendAmount: 15000,
+      sourceCurrency: 'IDR',
+      targetCurrency: 'EUR',
+    };
+
+    const expected = {
+      quotes: [
+        {
+          provider: {
+            name: 'Western Union',
+            alias: 'western-union',
+            logoUrl: 'https://dq8dwmysp7hk1.cloudfront.net/logos/western-union.svg',
+            partner: true,
+          },
+          route: {
+            sourceCurrency: 'IDR',
+            targetCurrency: 'EUR',
+          },
+          rate: 0.00759645,
+          fees: {
+            breakdown: [
+              {
+                type: FeeType.MARKETED,
+                amount: { value: 12175, currency: 'IDR' },
+              },
+            ],
+            total: { value: 12175, currency: 'IDR' },
+          },
+          receiveAmount: { value: 0.17, currency: 'EUR' },
+          sendAmount: { value: 15000, currency: 'IDR' },
+        },
+      ],
+    };
+
+    expect(transformQuotesResponseV2(providers, wiseProvider)).toStrictEqual(expected);
+  });
+
+  it('given a route with a small send amount with a non-decimal currency as target, and provider doesnt have a hidden fee, dont show the hidden fee', () => {
+    const wiseProvider = {
+      ...wiseQuoteApiAdjusted,
+      rate: 0.0000612414,
+    };
+    const providers = {
+      providers: [
+        {
+          name: 'Western Union',
+          alias: 'western-union',
+          logo: 'https://dq8dwmysp7hk1.cloudfront.net/logos/western-union.svg',
+          partner: true,
+          quotes: [
+            {
+              rate: 0.00759645,
+              fee: 1.31,
+              dateCollected: new Date('2018-10-23T12:03:27'),
+              receivedAmount: 253,
+            },
+          ],
+        },
+      ],
+      sendAmount: 3,
+      sourceCurrency: 'GBP',
+      targetCurrency: 'JPY',
+    };
+
+    const expected = {
+      quotes: [
+        {
+          provider: {
+            name: 'Western Union',
+            alias: 'western-union',
+            logoUrl: 'https://dq8dwmysp7hk1.cloudfront.net/logos/western-union.svg',
+            partner: true,
+          },
+          route: {
+            sourceCurrency: 'GBP',
+            targetCurrency: 'JPY',
+          },
+          rate: 0.00759645,
+          fees: {
+            breakdown: [
+              {
+                type: FeeType.MARKETED,
+                amount: { value: 1.31, currency: 'GBP' },
+              },
+            ],
+            total: { value: 1.31, currency: 'GBP' },
+          },
+          receiveAmount: { value: 253, currency: 'JPY' },
+          sendAmount: { value: 3, currency: 'GBP' },
+        },
+      ],
+    };
+
+    expect(transformQuotesResponseV2(providers, wiseProvider)).toStrictEqual(expected);
+  });
 });

package/src/resources/clients/quotes/currenciesWithoutDecimals.ts

@@ -0,0 +1,28 @@
+// From ISO 4217 (06/12/2021)
+const CURRENCIES_WITHOUT_DECIMALS = new Set([
+  'CVE',
+  'IDR',
+  'ISK',
+  'BIF',
+  'CLP',
+  'DJF',
+  'GNF',
+  'ISK',
+  'JPY',
+  'KMF',
+  'KRW',
+  'PYG',
+  'RWF',
+  'UGX',
+  'UYI',
+  'VND',
+  'VUV',
+  'XAF',
+  'XOF',
+  'XPF',
+]);
+
+const isCurrencyWithoutDecimals = (currencyCode: string): boolean =>
+  CURRENCIES_WITHOUT_DECIMALS.has(currencyCode);
+
+export default isCurrencyWithoutDecimals;

package/src/resources/clients/quotes/transformQuotesResponseV2.ts

@@ -10,6 +10,7 @@ import TransferFeeComparisonQuote, {
 } from '../../../transfer-fee-comparison/domain/Quote';
 import TW_ALIAS from '../../provider-constants';
 
+import isCurrencyWithoutDecimals from './currenciesWithoutDecimals';
 import extractQuote from './extractQuote';
 import extractWiseQuote from './extractWiseQuote';
 
@@ -18,29 +19,29 @@ export type TransformQuotesResponseType = {
 };
 
 function extractHiddenFeeInSourceCurrency(
+  targetCurrencyCode: string,
   sendAmount: number,
   receivedAmount: number,
   marketedFee: number,
   midmarketRate: number,
 ) {
-  const toleranceAmountInPercentage = 0.01;
-  const expectedReceivedAmount = midmarketRate * (sendAmount - marketedFee);
+  const noDecimalsCurrencyTolerance = isCurrencyWithoutDecimals(targetCurrencyCode) ? 0.5 : 0;
+  const toleranceAmountInPercentage = 0.00001;
+  const expectedReceivedAmount = floorToTwoDecimalNumbers(
+    midmarketRate * (sendAmount - marketedFee) - noDecimalsCurrencyTolerance,
+  );
 
   const receivedTheExpectedAmount = numberEqualsWithRelativeTolerance(
     receivedAmount,
     expectedReceivedAmount,
     toleranceAmountInPercentage,
   );
-  const receivedHigherThanExpected =
-    !receivedTheExpectedAmount && receivedAmount > expectedReceivedAmount;
-
-  const expectedHasMoreThanACentMissing = expectedReceivedAmount - receivedAmount >= 0.01;
+  const receivedHigherThanExpected = receivedAmount > expectedReceivedAmount;
 
-  const hasHiddenFee =
-    !receivedTheExpectedAmount && !receivedHigherThanExpected && expectedHasMoreThanACentMissing;
+  const hasHiddenFee = !receivedTheExpectedAmount && !receivedHigherThanExpected;
   const hiddenFeePaidOnTargetCurrency = hasHiddenFee ? expectedReceivedAmount - receivedAmount : 0;
 
-  return parseFloat((hiddenFeePaidOnTargetCurrency * (1 / midmarketRate)).toFixed(2));
+  return parseFloat((hiddenFeePaidOnTargetCurrency / midmarketRate).toFixed(2));
 }
 
 function extractFees(
@@ -99,6 +100,7 @@ function buildQuoteObject(
   midMarketRate: number,
 ) {
   const hiddenFee: number = extractHiddenFeeInSourceCurrency(
+    quotesResults.targetCurrency,
     quotesResults.sendAmount,
     quote.receivedAmount,
     quote.fee,
@@ -132,4 +134,8 @@ function buildQuoteObject(
   };
 }
 
+function floorToTwoDecimalNumbers(value: number): number {
+  return Math.floor(value * 100) / 100;
+}
+
 export default transformQuotesResponseV2;