n2words 1.24.0 → 2.0.0

package/lib/languages/ru.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Russian language converter.
+ *
+ * Supports:
+ * - Gender agreement (masculine/feminine forms)
+ * - Three-form pluralization (one/few/many)
+ * - Large numbers up to nonillions
+ */
+export class Russian extends SlavicLanguage {
+    onesWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    onesFeminineWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    teensWords: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    twentiesWords: {
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    hundredsWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    pluralForms: {
+        1: string[];
+        2: string[];
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+    };
+    /**
+     * Russian thousands (тысяча) are feminine, requiring одна/две forms.
+     * Other scales (million, billion, etc.) are masculine.
+     */
+    scaleGenders: {
+        1: boolean;
+    };
+}
+import { SlavicLanguage } from '../classes/slavic-language.js';

package/lib/languages/ru.js

@@ -1,34 +1,19 @@
-import SlavicLanguage from '../classes/slavic-language.js'
-
-/**
- * @typedef {Object} SlavicOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
+import { SlavicLanguage } from '../classes/slavic-language.js'
 
 /**
  * Russian language converter.
  *
- * Converts numbers to Russian words with full grammatical support:
+ * Supports:
  * - Gender agreement (masculine/feminine forms)
- * - Complex pluralization rules (one/few/many forms)
- * - Declension patterns for thousands, millions, billions, etc.
- * - Proper case endings for number words
- *
- * Features:
- * - Gender-aware forms (один/одна, два/две)
- * - Three-form pluralization (тысяча/тысячи/тысяч)
- * - Support for very large numbers (up to nonillions)
- * - Proper spacing and conjunction rules
- *
- * This class extends SlavicLanguage, which provides the conversion algorithm
- * shared by Czech, Polish, Ukrainian, Serbian, Croatian, Hebrew, Lithuanian, Latvian.
+ * - Three-form pluralization (one/few/many)
+ * - Large numbers up to nonillions
  */
 export class Russian extends SlavicLanguage {
   negativeWord = 'минус'
   decimalSeparatorWord = 'запятая'
   zeroWord = 'ноль'
 
-  ones = {
+  onesWords = {
     1: 'один',
     2: 'два',
     3: 'три',
@@ -40,7 +25,7 @@ export class Russian extends SlavicLanguage {
     9: 'девять'
   }
 
-  onesFeminine = {
+  onesFeminineWords = {
     1: 'одна',
     2: 'две',
     3: 'три',
@@ -52,7 +37,7 @@ export class Russian extends SlavicLanguage {
     9: 'девять'
   }
 
-  tens = {
+  teensWords = {
     0: 'десять',
     1: 'одиннадцать',
     2: 'двенадцать',
@@ -65,7 +50,7 @@ export class Russian extends SlavicLanguage {
     9: 'девятнадцать'
   }
 
-  twenties = {
+  twentiesWords = {
     2: 'двадцать',
     3: 'тридцать',
     4: 'сорок',
@@ -76,7 +61,7 @@ export class Russian extends SlavicLanguage {
     9: 'девяносто'
   }
 
-  hundreds = {
+  hundredsWords = {
     1: 'сто',
     2: 'двести',
     3: 'триста',
@@ -88,7 +73,7 @@ export class Russian extends SlavicLanguage {
     9: 'девятьсот'
   }
 
-  thousands = {
+  pluralForms = {
     1: ['тысяча', 'тысячи', 'тысяч'], // 10^ 3
     2: ['миллион', 'миллиона', 'миллионов'], // 10^ 6
     3: ['миллиард', 'миллиарда', 'миллиардов'], // 10^ 9
@@ -100,17 +85,12 @@ export class Russian extends SlavicLanguage {
     9: ['октиллион', 'октиллиона', 'октиллионов'], // 10^ 27
     10: ['нониллион', 'нониллиона', 'нониллионов'] // 10^ 30
   }
-}
 
-/**
- * Converts a number to Russian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {SlavicOptions} [options={}] Configuration options.
- * @returns {string} The number expressed in Russian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords (value, options = {}) {
-  return new Russian(options).convertToWords(value)
+  /**
+   * Russian thousands (тысяча) are feminine, requiring одна/две forms.
+   * Other scales (million, billion, etc.) are masculine.
+   */
+  scaleGenders = {
+    1: true // thousands are feminine
+  }
 }

package/lib/languages/sr-Cyrl.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Serbian language converter (Cyrillic script).
+ *
+ * Supports:
+ * - Three-form pluralization (one/few/many)
+ * - Gender agreement (један/једна, два/две)
+ * - Cyrillic script representation
+ */
+export class SerbianCyrillic extends SlavicLanguage {
+    onesWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    onesFeminineWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    teensWords: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    twentiesWords: {
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    hundredsWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    pluralForms: {
+        1: string[];
+        2: string[];
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+    };
+    /** Selects Serbian plural form: 1 = singular, 2-4 = few, else = many. */
+    pluralize(n: any, forms: any): any;
+}
+import { SlavicLanguage } from '../classes/slavic-language.js';

package/lib/languages/sr-Cyrl.js

@@ -0,0 +1,113 @@
+import { SlavicLanguage } from '../classes/slavic-language.js'
+
+/**
+ * Serbian language converter (Cyrillic script).
+ *
+ * Supports:
+ * - Three-form pluralization (one/few/many)
+ * - Gender agreement (један/једна, два/две)
+ * - Cyrillic script representation
+ */
+export class SerbianCyrillic extends SlavicLanguage {
+  negativeWord = 'минус'
+  decimalSeparatorWord = 'запета'
+  zeroWord = 'нула'
+
+  onesWords = {
+    1: 'један',
+    2: 'два',
+    3: 'три',
+    4: 'четири',
+    5: 'пет',
+    6: 'шест',
+    7: 'седам',
+    8: 'осам',
+    9: 'девет'
+  }
+
+  onesFeminineWords = {
+    1: 'једна',
+    2: 'две',
+    3: 'три',
+    4: 'четири',
+    5: 'пет',
+    6: 'шест',
+    7: 'седам',
+    8: 'осам',
+    9: 'девет'
+  }
+
+  teensWords = {
+    0: 'десет',
+    1: 'једанаест',
+    2: 'дванаест',
+    3: 'тринаест',
+    4: 'четрнаест',
+    5: 'петнаест',
+    6: 'шеснаест',
+    7: 'седамнаест',
+    8: 'осамнаест',
+    9: 'деветнаест'
+  }
+
+  twentiesWords = {
+    2: 'двадесет',
+    3: 'тридесет',
+    4: 'четрдесет',
+    5: 'педесет',
+    6: 'шездесет',
+    7: 'седамдесет',
+    8: 'осамдесет',
+    9: 'деведесет'
+  }
+
+  hundredsWords = {
+    1: 'сто',
+    2: 'двеста',
+    3: 'триста',
+    4: 'четиристо',
+    5: 'петсто',
+    6: 'шесто',
+    7: 'седамсто',
+    8: 'осамсто',
+    9: 'девестo'
+  }
+
+  pluralForms = {
+    1: ['хиљада', 'хиљаде', 'хиљада'], // 10 ^ 3
+    2: ['милион', 'милиона', 'милиона'], // 10 ^ 6
+    3: ['милијарда', 'милијарде', 'милијарда'], // 10 ^ 9
+    4: ['билион', 'билиона', 'билиона'], // 10 ^ 12
+    5: ['билијарда', 'билијарде', 'билијарда'], // 10 ^ 15
+    6: ['трилион', 'трилиона', 'трилиона'], // 10 ^ 18
+    7: ['трилијарда', 'трилијарде', 'трилијарда'], // 10 ^ 21
+    8: ['квадрилион', 'квадрилиона', 'квадрилиона'], // 10 ^ 24
+    9: ['квадрилијарда', 'квадрилијарде', 'квадрилијарда'], // 10 ^ 27
+    10: ['квинтилион', 'квинтилиона', 'квинтилиона'] // 10 ^ 30
+  }
+
+  /**
+   * Maps segment indices to whether they are grammatically feminine.
+   * In Serbian, thousands (index 1) are feminine, others are masculine.
+   * @type {Object.<number, boolean>}
+   */
+  scaleGenders = {
+    1: true // thousands are feminine (others default to false)
+  }
+
+  /** Selects Serbian plural form: 1 = singular, 2-4 = few, else = many. */
+  pluralize (n, forms) {
+    const lastDigit = n % 10n
+    const lastTwoDigits = n % 100n
+
+    if ((lastTwoDigits < 10n || lastTwoDigits > 20n) && lastDigit === 1n) {
+      return forms[0]
+    }
+
+    if ((lastTwoDigits < 10n || lastTwoDigits > 20n) && lastDigit > 1n && lastDigit < 5n) {
+      return forms[1]
+    }
+
+    return forms[2]
+  }
+}

package/lib/languages/sr-Latn.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Serbian Latin language converter.
+ *
+ * Supports:
+ * - Three-form pluralization (one/few/many)
+ * - Gender agreement (jedan/jedna, dva/dve)
+ * - Latin script representation
+ */
+export class SerbianLatin extends SlavicLanguage {
+    onesWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    onesFeminineWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    teensWords: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    twentiesWords: {
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    hundredsWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    pluralForms: {
+        1: string[];
+        2: string[];
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+    };
+    /** Selects Serbian plural form: 1 = singular, 2-4 = few, else = many. */
+    pluralize(n: any, forms: any): any;
+}
+import { SlavicLanguage } from '../classes/slavic-language.js';

package/lib/languages/sr-Latn.js

@@ -1,52 +1,43 @@
-import SlavicLanguage from '../classes/slavic-language.js'
+import { SlavicLanguage } from '../classes/slavic-language.js'
 
 /**
- * @typedef {Object} SlavicOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
-
-/**
- * Serbian language converter.
+ * Serbian Latin language converter.
  *
- * Implements Serbian number words using the Slavic language pattern:
- * - Serbian number words (jedan/jedna, dva/dve, tri, četiri...)
- * - Gender-aware forms (masculine/feminine)
- * - Slavic three-form pluralization (hiljada/hiljade/hiljada)
+ * Supports:
+ * - Three-form pluralization (one/few/many)
+ * - Gender agreement (jedan/jedna, dva/dve)
  * - Latin script representation
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic languages
- *   * Form 1 (singular): 1 (e.g., "hiljada")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "hiljade")
- *   * Form 3 (many): all other numbers (e.g., "hiljada")
- * - Chunk-based decomposition (splits into groups of 3 digits: ones, thousands, millions, etc.)
- * - Large number handling via SCALE[] array with indexed [singular, few, many] forms
- * - Gender-specific number forms for 1 and 2 (masculine/feminine dual forms)
- *
- * Features:
- * - Dual gender forms for 1 and 2 (jedan/jedna, dva/dve)
- * - Similar structure to Croatian with different orthography
- * - Latin script (Serbian can use both Latin and Cyrillic)
- *
- * Inherits from SlavicLanguage for complex pluralization algorithms.
  */
-export class Serbian extends SlavicLanguage {
+export class SerbianLatin extends SlavicLanguage {
   negativeWord = 'minus'
   decimalSeparatorWord = 'zapeta'
   zeroWord = 'nula'
-  ones = {
-    1: ['jedan', 'jedna'],
-    2: ['dva', 'dve'],
-    3: ['tri', 'tri'],
-    4: ['četiri', 'četiri'],
-    5: ['pet', 'pet'],
-    6: ['šest', 'šest'],
-    7: ['sedam', 'sedam'],
-    8: ['osam', 'osam'],
-    9: ['devet', 'devet']
+
+  onesWords = {
+    1: 'jedan',
+    2: 'dva',
+    3: 'tri',
+    4: 'četiri',
+    5: 'pet',
+    6: 'šest',
+    7: 'sedam',
+    8: 'osam',
+    9: 'devet'
+  }
+
+  onesFeminineWords = {
+    1: 'jedna',
+    2: 'dve',
+    3: 'tri',
+    4: 'četiri',
+    5: 'pet',
+    6: 'šest',
+    7: 'sedam',
+    8: 'osam',
+    9: 'devet'
   }
 
-  tens = {
+  teensWords = {
     0: 'deset',
     1: 'jedanaest',
     2: 'dvanaest',
@@ -59,7 +50,7 @@ export class Serbian extends SlavicLanguage {
     9: 'devetnaest'
   }
 
-  twenties = {
+  twentiesWords = {
     2: 'dvadeset',
     3: 'trideset',
     4: 'četrdeset',
@@ -70,7 +61,7 @@ export class Serbian extends SlavicLanguage {
     9: 'devedeset'
   }
 
-  hundreds = {
+  hundredsWords = {
     1: 'sto',
     2: 'dvesta',
     3: 'trista',
@@ -82,20 +73,29 @@ export class Serbian extends SlavicLanguage {
     9: 'devetsto'
   }
 
-  SCALE = [
-    ['', '', '', false],
-    ['hiljada', 'hiljade', 'hiljada', true], // 10 ^ 3
-    ['milion', 'miliona', 'miliona', false], // 10 ^ 6
-    ['milijarda', 'milijarde', 'milijarda', false], // 10 ^ 9
-    ['bilion', 'biliona', 'biliona', false], // 10 ^ 12
-    ['bilijarda', 'bilijarde', 'bilijarda', false], // 10 ^ 15
-    ['trilion', 'triliona', 'triliona', false], // 10 ^ 18
-    ['trilijarda', 'trilijarde', 'trilijarda', false], // 10 ^ 21
-    ['kvadrilion', 'kvadriliona', 'kvadriliona', false], // 10 ^ 24
-    ['kvadrilijarda', 'kvadrilijarde', 'kvadrilijarda', false], // 10 ^ 27
-    ['kvintilion', 'kvintiliona', 'kvintiliona', false] // 10 ^ 30
-  ]
+  pluralForms = {
+    1: ['hiljada', 'hiljade', 'hiljada'], // 10 ^ 3
+    2: ['milion', 'miliona', 'miliona'], // 10 ^ 6
+    3: ['milijarda', 'milijarde', 'milijarda'], // 10 ^ 9
+    4: ['bilion', 'biliona', 'biliona'], // 10 ^ 12
+    5: ['bilijarda', 'bilijarde', 'bilijarda'], // 10 ^ 15
+    6: ['trilion', 'triliona', 'triliona'], // 10 ^ 18
+    7: ['trilijarda', 'trilijarde', 'trilijarda'], // 10 ^ 21
+    8: ['kvadrilion', 'kvadriliona', 'kvadriliona'], // 10 ^ 24
+    9: ['kvadrilijarda', 'kvadrilijarde', 'kvadrilijarda'], // 10 ^ 27
+    10: ['kvintilion', 'kvintiliona', 'kvintiliona'] // 10 ^ 30
+  }
 
+  /**
+   * Maps segment indices to whether they are grammatically feminine.
+   * In Serbian, thousands (index 1) are feminine, others are masculine.
+   * @type {Object.<number, boolean>}
+   */
+  scaleGenders = {
+    1: true // thousands are feminine (others default to false)
+  }
+
+  /** Selects Serbian plural form: 1 = singular, 2-4 = few, else = many. */
   pluralize (n, forms) {
     const lastDigit = n % 10n
     const lastTwoDigits = n % 100n
@@ -110,48 +110,4 @@ export class Serbian extends SlavicLanguage {
 
     return forms[2]
   }
-
-  convertWholePart (number) {
-    if (number === 0n) {
-      return this.zeroWord
-    }
-    const words = []
-    const chunks = this.splitByX(number.toString(), 3)
-    let index = chunks.length
-    for (const x of chunks) {
-      index = index - 1
-      const [n1, n2, n3] = this.getDigits(x)
-      if (n3 > 0) {
-        words.push(this.hundreds[n3])
-      }
-      if (n2 > 1) {
-        words.push(this.twenties[n2])
-      }
-      if (n2 === 1n) {
-        words.push(this.tens[n1])
-      } else if (n1 > 0) {
-        const isFeminine = (this.feminine || this.SCALE[index][3])
-        const genderIndex = isFeminine ? 1 : 0
-        words.push(this.ones[n1][genderIndex])
-      }
-      if ((index > 0) && (x !== 0n)) {
-        words.push(this.pluralize(x, this.SCALE[index]))
-      }
-    }
-    return words.join(' ')
-  }
-}
-
-/**
- * Converts a number to Serbian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @param {boolean} [options.feminine=false] Use feminine forms for numbers.
- * @returns {string} The number expressed in Serbian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords (value, options = {}) {
-  return new Serbian(options).convertToWords(value)
 }

package/lib/languages/sv.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Swedish language converter.
+ *
+ * Supports:
+ * - Hyphenation for compound tens (tjugo-tre)
+ * - "och" (and) after hundreds
+ * - Space-separated larger composites
+ */
+export class Swedish extends GreedyScaleLanguage {
+    scaleWords: (string | bigint)[][];
+    /** Combines two word-sets according to Swedish grammar rules. */
+    combineWordSets(preceding: any, following: any): any;
+}
+import { GreedyScaleLanguage } from '../classes/greedy-scale-language.js';