n2words 1.23.0 → 1.24.0

package/lib/languages/sv.js

@@ -0,0 +1,127 @@
+import GreedyScaleLanguage from '../classes/greedy-scale-language.js'
+
+/**
+ * Swedish language converter.
+ *
+ * Converts numbers to Swedish words, supporting:
+ * - Negative numbers (prepended with "minus")
+ * - Decimal numbers (word "komma" between whole and fractional parts)
+ * - Numbers up to quadrillions
+ *
+ * Merge rules:
+ * - Hyphenated for compound tens (e.g., "tjugo-tre")
+ * - "och" (and) after hundreds (e.g., "hundra och ett")
+ * - Space-separated for larger composites (e.g., "en miljon")
+ */
+export class Swedish extends GreedyScaleLanguage {
+  negativeWord = 'minus'
+  decimalSeparatorWord = 'komma'
+  zeroWord = 'noll'
+  wordSeparator = ' '
+  scaleWordPairs = [
+    [1_000_000_000_000_000_000_000_000_000n, 'kvadriljon'],
+    [1_000_000_000_000_000_000_000_000n, 'triljon'],
+    [1_000_000_000_000_000_000_000n, 'biljon'],
+    [1_000_000_000_000_000_000n, 'miljard'],
+    [1_000_000_000_000n, 'biljon'],
+    [1_000_000_000n, 'miljard'],
+    [1_000_000n, 'miljon'],
+    [1000n, 'tusen'],
+    [100n, 'hundra'],
+    [90n, 'nittio'],
+    [80n, 'åttio'],
+    [70n, 'sjuttio'],
+    [60n, 'sextio'],
+    [50n, 'femtio'],
+    [40n, 'fyrtio'],
+    [30n, 'trettio'],
+    [20n, 'tjugo'],
+    [19n, 'nitton'],
+    [18n, 'arton'],
+    [17n, 'sjutton'],
+    [16n, 'sexton'],
+    [15n, 'femton'],
+    [14n, 'fjorton'],
+    [13n, 'tretton'],
+    [12n, 'tolv'],
+    [11n, 'elva'],
+    [10n, 'tio'],
+    [9n, 'nio'],
+    [8n, 'åtta'],
+    [7n, 'sju'],
+    [6n, 'sex'],
+    [5n, 'fem'],
+    [4n, 'fyra'],
+    [3n, 'tre'],
+    [2n, 'två'],
+    [1n, 'ett'],
+    [0n, 'noll']
+  ]
+
+  /**
+   * Merges two adjacent word-number pairs according to Swedish grammar rules.
+   *
+   * Swedish-specific rules:
+   * - Implicit "ett": `mergeScales({ 'ett': 1n }, { 'hundra': 100n })` → `{ 'hundra': 100n }`
+   * - Hyphenated compounds: `mergeScales({ 'tjugo': 20n }, { 'tre': 3n })` → `{ 'tjugo-tre': 23n }`
+   * - "och" after hundreds: `mergeScales({ 'hundra': 100n }, { 'ett': 1n })` → `{ 'hundra och ett': 101n }`
+   * - "en" for millions: `mergeScales({ 'ett': 1n }, { 'miljon': 1000000n })` → `{ 'en miljon': 1000000n }`
+   *
+   * @param {Object} leftPair Left word-set as `{ word: BigInt }`.
+   * @param {Object} rightPair Right word-set as `{ word: BigInt }`.
+   * @returns {Object} Merged pair with combined word and resulting numeric value.
+   *
+   * @example
+   * mergeScales({ 'ett': 1n }, { 'hundra': 100n }); // { 'hundra': 100n }
+   * mergeScales({ 'tjugo': 20n }, { 'tre': 3n }); // { 'tjugo-tre': 23n }
+   */
+  mergeScales (leftPair, rightPair) {
+    const leftWord = Object.keys(leftPair)[0]
+    const rightWord = Object.keys(rightPair)[0]
+    const leftNumber = Object.values(leftPair)[0]
+    const rightNumber = Object.values(rightPair)[0]
+
+    if (leftNumber === 1n && rightNumber < 100n) {
+      return rightPair
+    }
+
+    // Omit 'ett' before 'hundra' and 'tusen'
+    if (leftNumber === 1n && (rightNumber === 100n || rightNumber === 1000n)) {
+      return rightPair
+    }
+
+    if (leftNumber < 100n && leftNumber > rightNumber) {
+      return { [`${leftWord}-${rightWord}`]: leftNumber + rightNumber }
+    }
+
+    if (leftNumber >= 100n && rightNumber < 100n) {
+      return { [`${leftWord} och ${rightWord}`]: leftNumber + rightNumber }
+    }
+
+    if (rightNumber > leftNumber) {
+      if (leftNumber === 1n && rightNumber >= 1_000_000n) {
+        return { [`en ${rightWord}`]: leftNumber * rightNumber }
+      }
+      return { [`${leftWord} ${rightWord}`]: leftNumber * rightNumber }
+    }
+
+    return { [`${leftWord} ${rightWord}`]: leftNumber + rightNumber }
+  }
+}
+
+/**
+ * Converts a number to Swedish cardinal (written) form.
+ *
+ * @param {number|string|bigint} value The number to convert.
+ * @param {Object} [options] Conversion options (see Swedish class options).
+ * @returns {string} The number expressed in Swedish words.
+ * @throws {TypeError} If value is NaN or invalid type.
+ * @throws {Error} If value is an invalid number string.
+ *
+ * @example
+ * convertToWords(42); // 'fyrtio-två'
+ * convertToWords('1.5'); // 'ett komma fem'
+ */
+export default function convertToWords (value, options = {}) {
+  return new Swedish(options).convertToWords(value)
+}

package/lib/languages/sw.js

@@ -0,0 +1,121 @@
+import AbstractLanguage from '../classes/abstract-language.js'
+
+class Swahili extends AbstractLanguage {
+  negativeWord = 'minus'
+  decimalSeparatorWord = 'nukta'
+  zeroWord = 'sifuri'
+  digits = {
+    0: 'sifuri',
+    1: 'moja',
+    2: 'mbili',
+    3: 'tatu',
+    4: 'nne',
+    5: 'tano',
+    6: 'sita',
+    7: 'saba',
+    8: 'nane',
+    9: 'tisa'
+  }
+
+  tens = {
+    10: 'kumi',
+    20: 'ishirini',
+    30: 'thelathini',
+    40: 'arobaini',
+    50: 'hamsini',
+    60: 'sitini',
+    70: 'sabini',
+    80: 'themanini',
+    90: 'tisini'
+  }
+
+  scales = [
+    '',
+    'elfu',
+    'milioni',
+    'bilioni',
+    'trilioni'
+  ]
+
+  wordsUnder100 (n) {
+    if (n < 10) return this.digits[n]
+    if (n === 10) return this.tens[10]
+    if (n < 20) {
+      // 11-19: 'kumi na <digit>'
+      return this.tens[10] + ' na ' + this.digits[n - 10]
+    }
+    const tens = Math.trunc(n / 10) * 10
+    const ones = n % 10
+    if (ones === 0) return this.tens[tens]
+    return this.tens[tens] + ' na ' + this.digits[ones]
+  }
+
+  wordsUnder1000 (n) {
+    if (n < 100) return this.wordsUnder100(n)
+    if (n === 100) return 'mia moja'
+    const hundreds = Math.trunc(n / 100)
+    const rest = n % 100
+    const parts = []
+
+    // Hundreds: 'mia <digit>'
+    parts.push('mia ' + this.digits[hundreds])
+    if (rest > 0) {
+      if (rest < 10) {
+        parts.push('na ' + this.digits[rest])
+      } else {
+        parts.push(this.wordsUnder100(rest))
+      }
+    }
+
+    return parts.join(' ')
+  }
+
+  splitBy3 (number) {
+    const s = number.toString()
+    if (s.length <= 3) return [Number(s)]
+    const groups = []
+    const last3 = s.slice(-3)
+    groups.unshift(Number(last3))
+    let remaining = s.slice(0, -3)
+    while (remaining.length > 0) {
+      const group = remaining.slice(-3)
+      groups.unshift(Number(group))
+      remaining = remaining.slice(0, -3)
+    }
+    return groups
+  }
+
+  convertWholePart (number) {
+    if (number === 0n) return this.zeroWord
+
+    const groups = this.splitBy3(number)
+    const parts = []
+
+    for (let i = 0; i < groups.length; i++) {
+      const val = groups[i]
+      if (val === 0) continue
+      const scaleIndex = groups.length - i - 1
+      // scale word
+      if (scaleIndex === 0) {
+        if (val < 10 && parts.length > 0) {
+          parts.push('na ' + this.digits[val])
+        } else if (val === 100 && parts.length > 0) {
+          // In compound numbers (e.g., 1100 -> 'elfu moja mia'), use 'mia' not 'mia moja'
+          parts.push('mia')
+        } else {
+          parts.push(this.wordsUnder1000(val))
+        }
+      } else {
+        // e.g., 'elfu moja', 'milioni mbili'
+        const unit = (val === 1) ? 'moja' : this.wordsUnder1000(val)
+        parts.push(this.scales[scaleIndex] + ' ' + unit)
+      }
+    }
+
+    return parts.join(' ').trim()
+  }
+}
+
+export default function convertToWords (value, options = {}) {
+  return new Swahili(options).convertToWords(value)
+}

package/lib/languages/ta.js

@@ -0,0 +1,226 @@
+import AbstractLanguage from '../classes/abstract-language.js'
+
+class Tamil extends AbstractLanguage {
+  negativeWord = 'மைனஸ்'
+  decimalSeparatorWord = 'புள்ளி'
+  zeroWord = 'பூஜ்ஜியம்'
+  convertDecimalsPerDigit = true // Enable digit-by-digit decimal conversion
+  belowHundred = [
+    'பூஜ்ஜியம்',
+    'ஒன்று',
+    'இரண்டு',
+    'மூன்று',
+    'நான்கு',
+    'ஐந்து',
+    'ஆறு',
+    'ஏழு',
+    'எட்டு',
+    'ஒன்பது',
+    'பத்து',
+    'பதினொன்று',
+    'பன்னிரண்டு',
+    'பதிமூன்று',
+    'பதினான்கு',
+    'பதினைந்து',
+    'பதினாறு',
+    'பதினேழு',
+    'பதினெட்டு',
+    'பத்தொன்பது',
+    'இருபது',
+    'இருபத்தொன்று',
+    'இருபத்திரண்டு',
+    'இருபத்திமூன்று',
+    'இருபத்திநான்கு',
+    'இருபத்தைந்து',
+    'இருபத்தாறு',
+    'இருபத்தேழு',
+    'இருபத்தெட்டு',
+    'இருபத்தொன்பது',
+    'முப்பது',
+    'முப்பத்தொன்று',
+    'முப்பத்திரண்டு',
+    'முப்பத்திமூன்று',
+    'முப்பத்திநான்கு',
+    'முப்பத்தைந்து',
+    'முப்பத்தாறு',
+    'முப்பத்தேழு',
+    'முப்பத்தெட்டு',
+    'முப்பத்தொன்பது',
+    'நாற்பது',
+    'நாற்பத்தொன்று',
+    'நாற்பத்திரண்டு',
+    'நாற்பத்திமூன்று',
+    'நாற்பத்திநான்கு',
+    'நாற்பத்தைந்து',
+    'நாற்பத்தாறு',
+    'நாற்பத்தேழு',
+    'நாற்பத்தெட்டு',
+    'நாற்பத்தொன்பது',
+    'ஐம்பது',
+    'ஐம்பத்தொன்று',
+    'ஐம்பத்திரண்டு',
+    'ஐம்பத்திமூன்று',
+    'ஐம்பத்திநான்கு',
+    'ஐம்பத்தைந்து',
+    'ஐம்பத்தாறு',
+    'ஐம்பத்தேழு',
+    'ஐம்பத்தெட்டு',
+    'ஐம்பத்தொன்பது',
+    'அறுபது',
+    'அறுபத்தொன்று',
+    'அறுபத்திரண்டு',
+    'அறுபத்திமூன்று',
+    'அறுபத்திநான்கு',
+    'அறுபத்தைந்து',
+    'அறுபத்தாறு',
+    'அறுபத்தேழு',
+    'அறுபத்தெட்டு',
+    'அறுபத்தொன்பது',
+    'எழுபது',
+    'எழுபத்தொன்று',
+    'எழுபத்திரண்டு',
+    'எழுபத்திமூன்று',
+    'எழுபத்திநான்கு',
+    'எழுபத்தைந்து',
+    'எழுபத்தாறு',
+    'எழுபத்தேழு',
+    'எழுபத்தெட்டு',
+    'எழுபத்தொன்பது',
+    'எண்பது',
+    'எண்பத்தொன்று',
+    'எண்பத்திரண்டு',
+    'எண்பத்திமூன்று',
+    'எண்பத்திநான்கு',
+    'எண்பத்தைந்து',
+    'எண்பத்தாறு',
+    'எண்பத்தேழு',
+    'எண்பத்தெட்டு',
+    'எண்பத்தொன்பது',
+    'தொண்ணூறு',
+    'தொண்ணூற்று ஒன்று',
+    'தொண்ணூற்று இரண்டு',
+    'தொண்ணூற்று மூன்று',
+    'தொண்ணூற்று நான்கு',
+    'தொண்ணூற்று ஐந்து',
+    'தொண்ணூற்று ஆறு',
+    'தொண்ணூற்று ஏழு',
+    'தொண்ணூற்று எட்டு',
+    'தொண்ணூற்று ஒன்பது'
+  ]
+
+  hundreds = [
+    '',
+    'நூறு',
+    'இருநூறு',
+    'முன்னூறு',
+    'நானூறு',
+    'ஐநூறு',
+    'அறுநூறு',
+    'எழுநூறு',
+    'எண்நூறு',
+    'தொள்ளாயிரம்'
+  ]
+
+  // Digits map 1–9 for decimal reading
+  digits = [
+    'ஒன்று',
+    'இரண்டு',
+    'மூன்று',
+    'நான்கு',
+    'ஐந்து',
+    'ஆறு',
+    'ஏழு',
+    'எட்டு',
+    'ஒன்பது'
+  ]
+
+  scales = [
+    '',
+    'ஆயிரம்',
+    'லட்சம்',
+    'கோடி',
+    'அரபு',
+    'கராபு',
+    'நீல்',
+    'பத்ம',
+    'சங்கு'
+  ]
+
+  /**
+   * Convert numbers below 100 to Tamil words.
+   *
+   * @param {number} number The number to convert (0-99).
+   * @returns {string} The Tamil representation.
+   */
+  convertBelowHundred (number) {
+    return this.belowHundred[number]
+  }
+
+  convertBelowThousand (number) {
+    if (number === 0) return ''
+    if (number < 100) return this.convertBelowHundred(number)
+
+    const hundreds = Math.trunc(number / 100)
+    const remainder = number % 100
+    let hundredPart = this.hundreds[hundreds]
+
+    if (remainder > 0) {
+      if (hundredPart.endsWith('ம்')) {
+        hundredPart = hundredPart.replace(/ம்$/, 'த்து')
+      } else if (hundredPart.endsWith('று')) {
+        hundredPart = hundredPart.slice(0, -2) + 'ற்று'
+      }
+    }
+
+    const parts = [hundredPart]
+    if (remainder > 0) {
+      parts.push(this.convertBelowHundred(remainder))
+    }
+
+    return parts.join(' ').trim()
+  }
+
+  splitIndian (number) {
+    const numStr = number.toString()
+    if (numStr.length <= 3) return [Number(numStr)]
+
+    const groups = []
+    const last3 = numStr.slice(-3)
+    groups.unshift(Number(last3))
+
+    let remaining = numStr.slice(0, -3)
+    while (remaining.length > 0) {
+      const group = remaining.slice(-2)
+      groups.unshift(Number(group))
+      remaining = remaining.slice(0, -2)
+    }
+
+    return groups
+  }
+
+  convertWholePart (number) {
+    if (number === 0n) return this.zeroWord
+
+    const groups = this.splitIndian(number)
+    const groupCount = groups.length
+    const words = []
+
+    for (let i = 0; i < groupCount; i++) {
+      const groupValue = groups[i]
+      if (groupValue === 0) continue
+
+      const scaleIndex = groupCount - i - 1
+      const groupWords = (groupValue === 1 && scaleIndex > 0) ? 'ஒரு' : this.convertBelowThousand(groupValue)
+      words.push(groupWords)
+      if (scaleIndex > 0 && this.scales[scaleIndex]) {
+        words.push(this.scales[scaleIndex])
+      }
+    }
+
+    return words.join(' ').trim()
+  }
+}
+
+export default function convertToWords (value, options = {}) {
+  return new Tamil(options).convertToWords(value)
+}

package/lib/languages/te.js

@@ -0,0 +1,229 @@
+import AbstractLanguage from '../classes/abstract-language.js'
+
+class Telugu extends AbstractLanguage {
+  negativeWord = 'మైనస్'
+  decimalSeparatorWord = 'పాయింట్'
+  zeroWord = 'సున్నా'
+  convertDecimalsPerDigit = true // Enable digit-by-digit decimal conversion
+  belowHundred = [
+    'సున్నా',
+    'ఒకటి',
+    'రెండు',
+    'మూడు',
+    'నాలుగు',
+    'ఐదు',
+    'ఆరు',
+    'ఏడు',
+    'ఎనిమిది',
+    'తొమ్మిది',
+    'పది',
+    'పదకొండు',
+    'పన్నెండు',
+    'పదమూడు',
+    'పద్నాలుగు',
+    'పదిహేను',
+    'పదహారు',
+    'పదిహేడు',
+    'పద్దెనిమిది',
+    'పంతొమ్మిది',
+    'ఇరవై',
+    'ఇరవై ఒక్కటి',
+    'ఇరవై రెండు',
+    'ఇరవై మూడు',
+    'ఇరవై నాలుగు',
+    'ఇరవై ఐదు',
+    'ఇరవై ఆరు',
+    'ఇరవై ఏడు',
+    'ఇరవై ఎనిమిది',
+    'ఇరవై తొమ్మిది',
+    'ముప్పై',
+    'ముప్పై ఒకటి',
+    'ముప్పై రెండు',
+    'ముప్పై మూడు',
+    'ముప్పై నాలుగు',
+    'ముప్పై ఐదు',
+    'ముప్పై ఆరు',
+    'ముప్పై ఏడు',
+    'ముప్పై ఎనిమిది',
+    'ముప్పై తొమ్మిది',
+    'నలభై',
+    'నలభై ఒకటి',
+    'నలభై రెండు',
+    'నలభై మూడు',
+    'నలభై నాలుగు',
+    'నలభై ఐదు',
+    'నలభై ఆరు',
+    'నలభై ఏడు',
+    'నలభై ఎనిమిది',
+    'నలభై తొమ్మిది',
+    'యాభై',
+    'యాభై ఒకటి',
+    'యాభై రెండు',
+    'యాభై మూడు',
+    'యాభై నాలుగు',
+    'యాభై ఐదు',
+    'యాభై ఆరు',
+    'యాభై ఏడు',
+    'యాభై ఎనిమిది',
+    'యాభై తొమ్మిది',
+    'అరవై',
+    'అరవై ఒకటి',
+    'అరవై రెండు',
+    'అరవై మూడు',
+    'అరవై నాలుగు',
+    'అరవై ఐదు',
+    'అరవై ఆరు',
+    'అరవై ఏడు',
+    'అరవై ఎనిమిది',
+    'అరవై తొమ్మిది',
+    'డెబ్బై',
+    'డెబ్బై ఒకటి',
+    'డెబ్బై రెండు',
+    'డెబ్బై మూడు',
+    'డెబ్బై నాలుగు',
+    'డెబ్బై ఐదు',
+    'డెబ్బై ఆరు',
+    'డెబ్బై ఏడు',
+    'డెబ్బై ఎనిమిది',
+    'డెబ్బై తొమ్మిది',
+    'ఎనభై',
+    'ఎనభై ఒకటి',
+    'ఎనభై రెండు',
+    'ఎనభై మూడు',
+    'ఎనభై నాలుగు',
+    'ఎనభై ఐదు',
+    'ఎనభై ఆరు',
+    'ఎనభై ఏడు',
+    'ఎనభై ఎనిమిది',
+    'ఎనభై తొమ్మిది',
+    'తొంభై',
+    'తొంభై ఒకటి',
+    'తొంభై రెండు',
+    'తొంభై మూడు',
+    'తొంభై నాలుగు',
+    'తొంభై ఐదు',
+    'తొంభై ఆరు',
+    'తొంభై ఏడు',
+    'తొంభై ఎనిమిది',
+    'తొంభై తొమ్మిది'
+  ]
+
+  hundreds = [
+    '',
+    'వంద',
+    'రెండు వందలు',
+    'మూడు వందలు',
+    'నాలుగు వందలు',
+    'ఐదు వందలు',
+    'ఆరు వందలు',
+    'ఏడు వందలు',
+    'ఎనిమిది వందలు',
+    'తొమ్మిది వందలు'
+  ]
+
+  // Digits map 1–9 for decimal reading
+  digits = [
+    'ఒకటి',
+    'రెండు',
+    'మూడు',
+    'నాలుగు',
+    'ఐదు',
+    'ఆరు',
+    'ఏడు',
+    'ఎనిమిది',
+    'తొమ్మిది'
+  ]
+
+  scales = [
+    '',
+    'వెయ్యి',
+    'లక్ష',
+    'కోటి',
+    'అరబ్',
+    'ఖరబ్',
+    'నిల్',
+    'పడ్మ',
+    'శంకు'
+  ]
+
+  /**
+   * Convert numbers below 100 to Telugu words.
+   *
+   * @param {number} number The number to convert (0-99).
+   * @returns {string} The Telugu representation.
+   */
+  convertBelowHundred (number) {
+    return this.belowHundred[number]
+  }
+
+  /**
+   * Convert numbers below 1000 to Telugu words.
+   *
+   * @param {number} number The number to convert (0-999).
+   * @returns {string} The Telugu representation.
+   */
+  convertBelowThousand (number) {
+    if (number === 0) return ''
+    if (number < 100) return this.convertBelowHundred(number)
+
+    const hundreds = Math.trunc(number / 100)
+    const remainder = number % 100
+    const parts = [this.hundreds[hundreds]]
+
+    if (remainder > 0) {
+      parts.push(this.convertBelowHundred(remainder))
+    }
+
+    return parts.join(' ').trim()
+  }
+
+  /**
+   * Split a number using Indian-style grouping (3-2-2 digits from right).
+   *
+   * @param {bigint} number The number to split.
+   * @returns {number[]} Array of number groups.
+   */
+  splitIndian (number) {
+    const numStr = number.toString()
+    if (numStr.length <= 3) return [Number(numStr)]
+
+    const groups = []
+    const last3 = numStr.slice(-3)
+    groups.unshift(Number(last3))
+
+    let remaining = numStr.slice(0, -3)
+    while (remaining.length > 0) {
+      const group = remaining.slice(-2)
+      groups.unshift(Number(group))
+      remaining = remaining.slice(0, -2)
+    }
+
+    return groups
+  }
+
+  convertWholePart (number) {
+    if (number === 0n) return this.zeroWord
+
+    const groups = this.splitIndian(number)
+    const groupCount = groups.length
+    const words = []
+
+    for (let i = 0; i < groupCount; i++) {
+      const groupValue = groups[i]
+      if (groupValue === 0) continue
+
+      const scaleIndex = groupCount - i - 1
+      const groupWords = (groupValue === 1 && scaleIndex > 0) ? 'ఒక' : this.convertBelowThousand(groupValue)
+      words.push(groupWords)
+      if (scaleIndex > 0 && this.scales[scaleIndex]) {
+        words.push(this.scales[scaleIndex])
+      }
+    }
+
+    return words.join(' ').trim()
+  }
+}
+
+export default function convertToWords (value, options = {}) {
+  return new Telugu(options).convertToWords(value)
+}