feat: refactoring currency module to use central geo data [ATLAS-167]

.changeset/chilly-timers-impress.md

@@ -0,0 +1,5 @@
+---
+'@razorpay/i18nify-js': patch
+---
+
+feat: refactoring currency module to use central geo data

packages/i18nify-js/rollup.config.mjs

@@ -74,7 +74,7 @@ const declarationTypes = modules.map((_module) => ({
     file: `lib/esm/${_module.name}/index.d.ts`,
     format: 'es',
   },
-  plugins: [dts()],
+  plugins: [dts(), json()],
 }));
 
 export default [
@@ -148,6 +148,6 @@ export default [
       file: 'lib/types/index.d.ts',
       format: 'es',
     },
-    plugins: [dts()],
+    plugins: [dts(), json()],
   },
 ];

packages/i18nify-js/scripts/jsonSubsets/currency/transformCurrencyConfig.ts

@@ -0,0 +1,54 @@
+/**
+ * Creates a smaller json currency configuration from parent i18nify-data. 
+ * 
+ * @example
+ * {"AFN": {
+      "name": "Afghani",
+      "numeric_code": "971",
+      "minor_unit": "2",
+      "symbol": "؋",
+      "physical_currency_denominations": [
+        "1",
+        "2",
+        "5",
+        "10",
+        "20",
+        "50",
+        "100",
+        "500",
+        "1000"
+      ]
+    }
+    transforms to 
+    {"AFN": {
+      "name": "Afghani",
+      "minor_unit": "2",
+      "symbol": "؋"
+      }
+    }
+
+ * 
+ */
+
+export default () => {
+  const DATA = require('#/i18nify-data/currency/data.json');
+
+  const currencyInfo = DATA.currency_information;
+
+  const currencyConfigSubset = Object.keys(currencyInfo).reduce(
+    (acc: any, curr: any) => {
+      acc[curr] = {
+        name: currencyInfo[curr].name,
+        minor_unit: currencyInfo[curr].minor_unit,
+        symbol: currencyInfo[curr].symbol,
+      };
+      return acc;
+    },
+    {},
+  );
+
+  return {
+    data: currencyConfigSubset,
+    subsetFilePath: './src/modules/currency/data/currencyConfig.json',
+  };
+};

packages/i18nify-js/scripts/jsonSubsets/index.ts

@@ -1,6 +1,8 @@
 import transformFormatterConfig from './phoneNumber/transformFormatterConfig';
 import transformRegexConfig from './phoneNumber/transformRegexConfig';
+import transformCurrencyConfig from './currency/transformCurrencyConfig';
 import createModuleSubsetFile from './createFile';
 
 createModuleSubsetFile(transformFormatterConfig());
 createModuleSubsetFile(transformRegexConfig());
+createModuleSubsetFile(transformCurrencyConfig());

packages/i18nify-js/src/modules/currency/__tests__/convertToMajorUnit.test.ts

@@ -12,7 +12,7 @@ describe('currency - convertToMajorUnit', () => {
   ];
 
   testCases.forEach(({ amount, currency, expectedResult }) => {
-    it(`should correctly convert ${amount} of minor unit ${currency} to ${expectedResult}`, () => {
+    it(`should correctly convert ${amount} of minor unit ${String(currency)} to ${expectedResult}`, () => {
       const result = convertToMajorUnit(amount, { currency: currency });
       expect(result).toBe(expectedResult);
     });
@@ -21,8 +21,9 @@ describe('currency - convertToMajorUnit', () => {
   it('should throw an error for unsupported currency codes', () => {
     const unsupportedCurrencyCode = 'XXX';
     expect(() => {
-      // @ts-expect-error intented invalid currencyCode for testing
-      convertToMajorUnit(100, { currency: unsupportedCurrencyCode });
+      convertToMajorUnit(100, {
+        currency: unsupportedCurrencyCode as CurrencyCodeType,
+      });
     }).toThrow('Unsupported currency XXX');
   });
 });

packages/i18nify-js/src/modules/currency/__tests__/convertToMinorUnit.test.ts

@@ -12,7 +12,7 @@ describe('currency - convertToMinorUnit', () => {
   ];
 
   testCases.forEach(({ amount, currency, expectedResult }) => {
-    it(`should correctly convert ${amount} of minor unit ${currency} to ${expectedResult}`, () => {
+    it(`should correctly convert ${amount} of minor unit ${String(currency)} to ${expectedResult}`, () => {
       const result = convertToMinorUnit(amount, { currency: currency });
       expect(result).toBe(expectedResult);
     });
@@ -21,8 +21,9 @@ describe('currency - convertToMinorUnit', () => {
   it('should throw an error for unsupported currency codes', () => {
     const unsupportedCurrencyCode = 'XXX';
     expect(() => {
-      // @ts-expect-error intented invalid currencyCode for testing
-      convertToMinorUnit(100, { currency: unsupportedCurrencyCode });
+      convertToMinorUnit(100, {
+        currency: unsupportedCurrencyCode as CurrencyCodeType,
+      });
     }).toThrow('Unsupported currency XXX');
   });
 });

packages/i18nify-js/src/modules/currency/__tests__/formatNumber.test.ts

@@ -1,13 +1,15 @@
 import { getLocale } from '../../.internal/utils';
 import { setState } from '../../core';
-import { formatNumber } from '../index';
+import { CurrencyCodeType, formatNumber } from '../index';
 
 const nbsp = String.fromCharCode(160);
 const nnsp = String.fromCharCode(8239);
 
 describe('formatNumber', () => {
   it('should format the amount with default options', () => {
-    const result = formatNumber('1000.5', { currency: 'USD' });
+    const result = formatNumber('1000.5', {
+      currency: 'USD',
+    });
     expect(result).toBe('$1,000.50');
   });
 
@@ -55,11 +57,15 @@ describe('formatNumber', () => {
       formatNumber('invalid-amount', {
         currency: 'USD',
       }),
-    ).toThrow('Parameter `amount` is not a number!');
+    ).toThrow(
+      `Error: Parameter 'amount' is not a number. typeof amount: string`,
+    );
   });
 
   it('should format a negative amount', () => {
-    const result = formatNumber('-500', { currency: 'USD' });
+    const result = formatNumber('-500', {
+      currency: 'USD',
+    });
     expect(result).toBe('-$500.00');
   });
 
@@ -86,7 +92,7 @@ describe('formatNumber', () => {
 
   it('should throw error with thousands separators', () => {
     expect(() => formatNumber('1,234,567.89', { currency: 'USD' })).toThrow(
-      'Parameter `amount` is not a number!',
+      `Error: Parameter 'amount' is not a number. typeof amount: string`,
     );
   });
 
@@ -96,7 +102,9 @@ describe('formatNumber', () => {
         currency: 'USD',
         intlOptions: { useGrouping: false },
       }),
-    ).toThrow('Parameter `amount` is not a number!');
+    ).toThrow(
+      `Error: Parameter 'amount' is not a number. typeof amount: string`,
+    );
   });
 
   it('should handle extremely large numbers with precision', () => {
@@ -108,8 +116,7 @@ describe('formatNumber', () => {
 
   it('should handle custom currency symbol and placement', () => {
     const result = formatNumber('1000', {
-      // @ts-expect-error invalid currency code for testing
-      currency: 'XYZ',
+      currency: 'XYZ' as CurrencyCodeType,
       intlOptions: {
         style: 'currency',
         currencyDisplay: 'symbol',

packages/i18nify-js/src/modules/currency/__tests__/formatNumberByParts.test.ts

@@ -1,4 +1,4 @@
-import { formatNumberByParts } from '../index';
+import { CurrencyCodeType, formatNumberByParts } from '../index';
 
 const nbsp = String.fromCharCode(160);
 
@@ -50,7 +50,9 @@ describe('formatNumberByParts', () => {
         currency: 'USD',
         locale: 'en-US',
       }),
-    ).toThrow('Error: Parameter `amount` is not a number!');
+    ).toThrow(
+      `Error: Parameter 'amount' is not a number. typeof amount: string`,
+    );
   });
 
   it('should use the default locale if locale is not provided', () => {
@@ -63,8 +65,7 @@ describe('formatNumberByParts', () => {
 
   it('should handle invalid currency code', () => {
     const result = formatNumberByParts(12345.67, {
-      // @ts-expect-error invalid currency for testing
-      currency: 'XYZ',
+      currency: 'XYZ' as CurrencyCodeType,
       locale: 'en-US',
     });
     expect(result).toEqual({

packages/i18nify-js/src/modules/currency/__tests__/getCurrencyList.spec.ts

@@ -18,6 +18,6 @@ test.describe('getCurrencyList', () => {
   test('should print name correctly for a given currency', async ({ page }) => {
     await injectScript(page, `(await getCurrencyList())['USD'].name`);
 
-    await assertScriptText(page, 'United States Dollar');
+    await assertScriptText(page, 'US Dollar');
   });
 });

packages/i18nify-js/src/modules/currency/__tests__/getCurrencyList.test.ts

@@ -1,9 +1,11 @@
 import { getCurrencyList } from '../index';
-import { CURRENCIES } from '../data/currencies';
+import CURRENCY_INFO from '../data/currencyConfig.json';
+import { Currency } from '../types';
+
 describe('getCurrencyList', () => {
   it('should return the correct currency list', () => {
     const currencyList = getCurrencyList();
-    expect(currencyList).toEqual(CURRENCIES);
+    expect(currencyList).toEqual(CURRENCY_INFO);
   });
 
   it("check properties 'symbol' and 'name' for a sample currency", () => {
@@ -17,10 +19,12 @@ describe('getCurrencyList', () => {
   it("check the values of 'symbol' and 'name' properties for a sample currency", () => {
     const currencyList = getCurrencyList();
     const sampleCurrencyCode = 'USD';
-    const sampleCurrency = currencyList[sampleCurrencyCode];
+    const sampleCurrency: Currency[string] = currencyList[sampleCurrencyCode];
 
     // Assert that the 'symbol' and 'name' properties have the expected values
-    expect(sampleCurrency.symbol).toBe(CURRENCIES[sampleCurrencyCode].symbol);
-    expect(sampleCurrency.name).toBe(CURRENCIES[sampleCurrencyCode].name);
+    expect(sampleCurrency.symbol).toBe(
+      CURRENCY_INFO[sampleCurrencyCode].symbol,
+    );
+    expect(sampleCurrency.name).toBe(CURRENCY_INFO[sampleCurrencyCode].name);
   });
 });

packages/i18nify-js/src/modules/currency/__tests__/getCurrencySymbol.test.ts

@@ -1,4 +1,4 @@
-import { getCurrencySymbol } from '../index';
+import { CurrencyCodeType, getCurrencySymbol } from '../index';
 
 describe('getCurrencySymbol', () => {
   it('should return the correct symbol for a valid currency code', () => {
@@ -10,17 +10,15 @@ describe('getCurrencySymbol', () => {
 
   it('should throw Error for an invalid currency code', () => {
     const currencyCode = 'XYZ'; // An invalid code
-    // @ts-expect-error invalid currency code for testing
-    expect(() => getCurrencySymbol(currencyCode)).toThrow(
-      'Invalid currencyCode!',
+    expect(() => getCurrencySymbol(currencyCode as CurrencyCodeType)).toThrow(
+      'Error: Invalid currencyCode: XYZ',
     );
   });
 
   it('should throw Error for an empty string', () => {
     const currencyCode = '';
-    // @ts-expect-error invalid currency code for testing
-    expect(() => getCurrencySymbol(currencyCode)).toThrow(
-      'Invalid currencyCode!',
+    expect(() => getCurrencySymbol(currencyCode as CurrencyCodeType)).toThrow(
+      'Error: Invalid currencyCode: ',
     );
   });
 });

packages/i18nify-js/src/modules/currency/convertToMajorUnit.ts

@@ -1,13 +1,13 @@
 import { withErrorBoundary } from '../../common/errorBoundary';
-import { CURRENCIES } from './data/currencies';
-import { CurrencyCodeType, CurrencyType } from './types';
+import { CurrencyCodeType } from './types';
+import CURRENCY_INFO from './data/currencyConfig.json';
 
 /**
  * Converts an amount from a minor currency unit to a major currency unit.
  *
  * The function takes an amount in the minor unit (e.g., cents, pence) and a currency code,
  * then converts the amount to the major unit (e.g., dollars, pounds) using the conversion rate
- * defined in the CURRENCIES object. If the currency code is not supported, it throws an error.
+ * defined in the CURRENCY_INFO object. If the currency code is not supported, it throws an error.
  *
  * @param {number} amount - The amount in the minor currency unit.
  * @param {object} options - The options object
@@ -20,14 +20,15 @@ const convertToMajorUnit = (
     currency: CurrencyCodeType;
   },
 ): number => {
-  const currencyInfo = CURRENCIES[options.currency] as CurrencyType;
+  const currencyInfo = CURRENCY_INFO[options.currency];
 
   if (!currencyInfo)
-    throw new Error(`Unsupported currency ${options.currency}`);
+    throw new Error(`Unsupported currency ${String(options.currency)}`);
 
-  const minorUnitMultiplier = currencyInfo.minorUnitMultiplier || 100;
+  const majorUnitMultiplier =
+    Math.pow(10, Number(currencyInfo.minor_unit)) || 100;
 
-  const higherCurrencyValue = amount / minorUnitMultiplier;
+  const higherCurrencyValue = amount / majorUnitMultiplier;
   return higherCurrencyValue;
 };
 

packages/i18nify-js/src/modules/currency/convertToMinorUnit.ts

@@ -1,13 +1,13 @@
 import { withErrorBoundary } from '../../common/errorBoundary';
-import { CURRENCIES } from './data/currencies';
-import { CurrencyCodeType, CurrencyType } from './types';
+import { CurrencyCodeType } from './types';
+import CURRENCY_INFO from './data/currencyConfig.json';
 
 /**
  * Converts an amount from a major currency unit to a minor currency unit.
  *
  * The function takes an amount in the major unit (e.g., dollars, pounds) and a currency code,
  * then converts the amount to the minor unit (e.g., cents, pence) using the conversion rate
- * defined in the CURRENCIES object. If the currency code is not supported, it throws an error.
+ * defined in the CURRENCY_INFO object. If the currency code is not supported, it throws an error.
  *
  * @param {number} amount - The amount in the major currency unit.
  * @param {object} options - The options object
@@ -20,12 +20,13 @@ const convertToMinorUnit = (
     currency: CurrencyCodeType;
   },
 ): number => {
-  const currencyInfo = CURRENCIES[options.currency] as CurrencyType;
+  const currencyInfo = CURRENCY_INFO[options.currency];
 
   if (!currencyInfo)
-    throw new Error(`Unsupported currency ${options.currency}`);
+    throw new Error(`Unsupported currency ${String(options.currency)}`);
 
-  const minorUnitMultiplier = currencyInfo.minorUnitMultiplier || 100;
+  const minorUnitMultiplier =
+    Math.pow(10, Number(currencyInfo.minor_unit)) || 100;
 
   const lowerCurrencyValue = amount * minorUnitMultiplier;
   return lowerCurrencyValue;