n2words 1.19.1 → 1.20.0

package/lib/i18n/ar.d.ts

@@ -22,7 +22,20 @@ export class Arabic extends AbstractLanguage {
     arabicAppendedGroup: string[];
     arabicPluralGroups: string[];
     digitFeminineStatus(digit: any): string;
-    processArabicGroup(groupNumber: any, groupLevel: any, remainingNumber: any): string;
-    toCardinal(number: any): string;
+    /**
+     * Processes the Arabic group number and returns the corresponding Arabic representation.
+     * @param {number} groupNumber - The number to process. From 1 to 999.
+     * @param {number} groupLevel - The level of the group.
+     *     Example: 12345678 is processed in blocks: '678' (group 0), '345' (group 1), '12' (group 2)
+     * @returns {string} The Arabic representation of the group number.
+     */
+    processArabicGroup(groupNumber: number, groupLevel: number): string;
+    /**
+     * Converts a number to its cardinal representation in Arabic.
+     * It process by blocks of 3 digits.
+     * @param {number} number - The number to convert.
+     * @returns {string} The cardinal representation of the number in Arabic.
+     */
+    toCardinal(number: number): string;
 }
 import AbstractLanguage from '../classes/AbstractLanguage.js';

package/lib/i18n/ar.js

@@ -28,7 +28,7 @@ export class Arabic extends AbstractLanguage {
       'تسعة عشر',
     ],
     feminine: [
-      'إحدى',
+      'واحدة',
       'اثنتان',
       'ثلاث',
       'أربع',
@@ -64,10 +64,6 @@ export class Arabic extends AbstractLanguage {
 
   arabicPluralGroups = ['', 'آلاف', 'ملايين', 'مليارات', 'تريليونات', 'كوادريليونات', 'كوينتليونات', 'سكستيليونات'];
 
-  // isCurrencyPartNameFeminine = true
-
-  // isCurrencyNameFeminine = false
-
   constructor(options) {
     options = Object.assign({
       negativeWord: 'ناقص',
@@ -82,67 +78,70 @@ export class Arabic extends AbstractLanguage {
   }
 
   digitFeminineStatus(digit) {
-    // if ((groupLevel == -1 && this.isCurrencyPartNameFeminine) || (groupLevel == 0 && this.isCurrencyNameFeminine)) {
-    //   return this.arabicFeminineOnes[digit]
-    // }
     return this.ones[this.feminine ? 'feminine' : 'masculine'][digit - 1];
   }
 
-  processArabicGroup(groupNumber, groupLevel, remainingNumber) {
+  /**
+   * Processes the Arabic group number and returns the corresponding Arabic representation.
+   * @param {number} groupNumber - The number to process. From 1 to 999.
+   * @param {number} groupLevel - The level of the group.
+   *     Example: 12345678 is processed in blocks: '678' (group 0), '345' (group 1), '12' (group 2)
+   * @returns {string} The Arabic representation of the group number.
+   */
+  processArabicGroup(groupNumber, groupLevel) {
     let tens = groupNumber % 100;
     const hundreds = groupNumber / 100;
     let retVal = '';
 
-    if (hundreds > 0) {
-      retVal = (tens == 0 && Math.trunc(hundreds) == 2 ? this.arabicAppendedTwos[0] : this.arabicHundreds[Math.trunc(hundreds)]);
+    if (Math.trunc(hundreds) > 0) {
+      if (tens == 0 && Math.trunc(hundreds) == 2) {
+        retVal = this.arabicTwos[0];
+      } else {
+        retVal = this.arabicHundreds[Math.trunc(hundreds)];
+        if (retVal != '' && tens != 0) {
+          retVal += ' و';
+        }
+      }
     }
 
-    if (tens > 0) {
-      if (tens < 20) {
-        if (tens == 2 && Math.trunc(hundreds) == 0 && groupLevel > 0) {
-          retVal = ([
-            2000, 2000000, 2000000000, 2000000000000, 2000000000000000, 2000000000000000000
-          ].indexOf(this.number) != -1) ? this.arabicAppendedTwos[groupLevel] : this.arabicTwos[groupLevel];
-        } else {
-          // Add divider
-          if (retVal != '') {
-            retVal += ' و ';
-          }
-
-          if (tens == 1 && groupLevel > 0 && hundreds == 0) {
-            retVal += '';
-          } else if (
-            (tens == 1 || tens == 2) &&
-            (groupLevel == 0 || groupLevel == -1) &&
-            (hundreds == 0 && remainingNumber == 0)
-          ) {
-            retVal += '';
+    if (tens > 0 && tens < 20) { // 1 -> 19
+      if (tens === 2 && Math.trunc(hundreds) === 0 && groupLevel > 0) {
+        const pow = Math.trunc(Math.log10(Number(this.number)));
+        if (pow % 3 === 0 && this.number === 2 * Math.pow(10, pow)) {
+          if (groupNumber === 2) {
+            retVal = this.arabicTwos[Math.trunc(groupLevel)];
           } else {
-            retVal += this.digitFeminineStatus(Math.trunc(tens), groupLevel);
+            retVal = this.arabicAppendedTwos[Math.trunc(groupLevel)];
           }
+        } else {
+          retVal = this.arabicTwos[Math.trunc(groupLevel)];
         }
+      } else if (tens === 1 && groupLevel > 0) {
+        retVal += this.arabicGroup[Math.trunc(groupLevel)];
       } else {
-        const ones = tens % 10;
-        tens = (tens / 10) - 2;
-
-        if (ones > 0) {
-          if (retVal != '' && tens < 4) {
-            retVal += ' و ';
-          }
-
-          retVal += this.digitFeminineStatus(ones, groupLevel);
-        }
-        if (retVal != '' && ones != 0) {
-          retVal += ' و ';
-        }
-
-        retVal += this.arabicTens[Math.trunc(tens)];
+        retVal += this.digitFeminineStatus(Math.trunc(tens), groupLevel);
+      }
+    } else if (tens >= 20) { // 20 -> 99
+      const ones = tens % 10;
+      const tensIndex = (tens / 10) - 2;
+      if (ones > 0) {
+        retVal += this.digitFeminineStatus(ones, groupLevel);
       }
+      if (retVal != '' && ones != 0) {
+        retVal += ' و';
+      }
+      retVal += this.arabicTens[Math.trunc(tensIndex)];
     }
 
     return retVal;
   }
 
+  /**
+   * Converts a number to its cardinal representation in Arabic.
+   * It process by blocks of 3 digits.
+   * @param {number} number - The number to convert.
+   * @returns {string} The cardinal representation of the number in Arabic.
+   */
   toCardinal(number) {
     if (number == 0) {
       return this.zero;
@@ -150,30 +149,30 @@ export class Arabic extends AbstractLanguage {
 
     this.number = number;
     let tempNumber = number;
+    let tempNumberDec;
     let group = 0;
     let retVal = '';
 
     // Loop until number has been reduced to zero or less
     while (tempNumber > 0) {
+      tempNumberDec = tempNumber;
       // Get the remaining value after dividing by 1000
-      const numberToProcess = Number(tempNumber % 1000n); // Maximum: 999
-      // Divide number by 1000
-      tempNumber = tempNumber / 1000n;
+      const numberToProcess = Number(tempNumberDec % 1000n); // Maximum: 999
+      tempNumber = tempNumberDec / 1000n;
 
       // Process "group"
-      const groupDescription = this.processArabicGroup(numberToProcess, group, tempNumber);
+      const groupDescription = this.processArabicGroup(numberToProcess, group);
 
       // Did the group return anything?
       if (groupDescription != '') {
-        // Is this after the first "group"?
-        if (group > 0) {
-          // Is the return value still empty?
+        // Is this after the first "group" ? Because nothing is appeded after group 0.
+        if (group > 0) { // hundreds, thousands, etc...
+          // Is the return value still empty ?
           if (retVal != '') {
-            retVal = ' و ' + retVal;
+            retVal = ' و' + retVal;
           }
 
-          // Process every number other than 2
-          if (numberToProcess != 2) {
+          if (numberToProcess > 2) {
             if (numberToProcess % 100 != 1) {
               if (numberToProcess >= 3 && numberToProcess <= 10) {
                 retVal = this.arabicPluralGroups[group] + ' ' + retVal;
@@ -199,6 +198,9 @@ export class Arabic extends AbstractLanguage {
       group++;
     }
 
+    // Replace multiple spaces with one space
+    retVal = retVal.replace(/ +/g, ' ');
+
     return retVal.trim();
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n2words",
-  "version": "1.19.1",
+  "version": "1.20.0",
   "description": "n2words converts a numerical number into a written one, supports 27 languages and has zero dependencies.",
   "keywords": [
     "n2words",