feat: API contract for formatNumberByParts updated (#51)

razorpay · Jan 10, 2024 · 61774b3 · 61774b3
1 parent 55218a6
commit 61774b3
Show file tree

Hide file tree

Showing 7 changed files with 383 additions and 84 deletions.
diff --git a/.changeset/six-squids-admire.md b/.changeset/six-squids-admire.md
@@ -0,0 +1,5 @@
+---
+"@razorpay/i18nify-js": minor
+---
+
+feat: API contract for formatNumberByParts updated
diff --git a/README.md b/README.md
@@ -230,64 +230,204 @@ console.log(
     locale: "en-US",
   })
 ); /* {
-      currencySymbol: '$',
-      integerValue: '12,345',
-      decimalValue: '67',
-      separator: '.',
-      symbolAtFirst: true,
-    } */
+    "currency": "$",
+    "integer": "12,345",
+    "decimal": ".",
+    "fraction": "67",
+    "isPrefixSymbol": true,
+    "rawParts": [
+        {
+            "type": "currency",
+            "value": "$"
+        },
+        {
+            "type": "integer",
+            "value": "12"
+        },
+        {
+            "type": "group",
+            "value": ","
+        },
+        {
+            "type": "integer",
+            "value": "345"
+        },
+        {
+            "type": "decimal",
+            "value": "."
+        },
+        {
+            "type": "fraction",
+            "value": "67"
+        }
+    ]
+} */
 
 console.log(
   formatNumberByParts(12345.67, {
     currency: "XYZ",
     locale: "en-US",
   })
 ); /* {
-      currencySymbol: 'XYZ',
-      decimalValue: '67',
-      integerValue: '12,345',
-      separator: '.',
-      symbolAtFirst: true,
-    } */
+    "currency": "XYZ",
+    "integer": "12,345",
+    "decimal": ".",
+    "fraction": "67",
+    "isPrefixSymbol": true,
+    "rawParts": [
+        {
+            "type": "currency",
+            "value": "XYZ"
+        },
+        {
+            "type": "literal",
+            "value": " "
+        },
+        {
+            "type": "integer",
+            "value": "12"
+        },
+        {
+            "type": "group",
+            "value": ","
+        },
+        {
+            "type": "integer",
+            "value": "345"
+        },
+        {
+            "type": "decimal",
+            "value": "."
+        },
+        {
+            "type": "fraction",
+            "value": "67"
+        }
+    ]
+} */
 
 console.log(
   formatNumberByParts(12345.67, {
     currency: "EUR",
     locale: "fr-FR",
   })
 ); /* {
-      currencySymbol: '€',
-      decimalValue: '67',
-      integerValue: '12 345',
-      separator: ',',
-      symbolAtFirst: false,
-    } */
+    "integer": "12 345",
+    "decimal": ",",
+    "fraction": "67",
+    "currency": "€",
+    "isPrefixSymbol": false,
+    "rawParts": [
+        {
+            "type": "integer",
+            "value": "12"
+        },
+        {
+            "type": "group",
+            "value": " "
+        },
+        {
+            "type": "integer",
+            "value": "345"
+        },
+        {
+            "type": "decimal",
+            "value": ","
+        },
+        {
+            "type": "fraction",
+            "value": "67"
+        },
+        {
+            "type": "literal",
+            "value": " "
+        },
+        {
+            "type": "currency",
+            "value": "€"
+        }
+    ]
+} */
 
 console.log(
   formatNumberByParts(12345.67, {
     currency: "JPY",
     locale: "ja-JP",
   })
 ); /* {
-      currencySymbol: '￥',
-      decimalValue: '',
-      integerValue: '12,346',
-      separator: '',
-      symbolAtFirst: true,
-    } */
+    "currency": "￥",
+    "integer": "12,346",
+    "isPrefixSymbol": true,
+    "rawParts": [
+        {
+            "type": "currency",
+            "value": "￥"
+        },
+        {
+            "type": "integer",
+            "value": "12"
+        },
+        {
+            "type": "group",
+            "value": ","
+        },
+        {
+            "type": "integer",
+            "value": "346"
+        }
+    ]
+} */
 
 console.log(
   formatNumberByParts(12345.67, {
     currency: "OMR",
     locale: "ar-OM",
   })
 ); /* {
-      currencySymbol: 'ر.ع.',
-      decimalValue: '٦٧٠',
-      integerValue: '١٢٬٣٤٥',
-      separator: '٫',
-      symbolAtFirst: false,
-    } */
+    "integer": "١٢٬٣٤٥",
+    "decimal": "٫",
+    "fraction": "٦٧٠",
+    "currency": "ر.ع.",
+    "isPrefixSymbol": false,
+    "rawParts": [
+        {
+            "type": "literal",
+            "value": " "
+        },
+        {
+            "type": "integer",
+            "value": "١٢"
+        },
+        {
+            "type": "group",
+            "value": "٬"
+        },
+        {
+            "type": "integer",
+            "value": "٣٤٥"
+        },
+        {
+            "type": "decimal",
+            "value": "٫"
+        },
+        {
+            "type": "fraction",
+            "value": "٦٧٠"
+        },
+        {
+            "type": "literal",
+            "value": " "
+        },
+        {
+            "type": "currency",
+            "value": "ر.ع."
+        },
+        {
+            "type": "literal",
+            "value": " "
+        }
+    ]
+} */
 ```
 
 ### Module 02: Phone Number

diff --git a/src/modules/currency/__tests__/formatNumberByParts.spec.ts b/src/modules/currency/__tests__/formatNumberByParts.spec.ts
@@ -4,7 +4,7 @@ import { assertScriptText, injectScript } from '../../../blackbox/utils';
 
 function generateByPartsString(options: string) {
   const methodCallStr = `(await formatNumberByParts(${options}))`;
-  return `${methodCallStr}.currencySymbol + ${methodCallStr}.integerValue + ${methodCallStr}.separator + ${methodCallStr}.decimalValue`;
+  return `${methodCallStr}.currency + ${methodCallStr}.integer + ${methodCallStr}.decimal + ${methodCallStr}.fraction`;
 }
 
 function generateOptionsString(