n2words 2.0.0 → 3.1.0

package/lib/languages/es.d.ts

@@ -1,15 +1,21 @@
 /**
- * Spanish language converter.
+ * Converts a numeric value to Spanish words.
  *
- * Supports:
- * - Gender agreement (masculine/feminine via genderStem option)
- * - "y" conjunction between tens and units
- * - Special hundred forms (cien/ciento)
+ * This is the main public API. It accepts any valid numeric input
+ * (number, string, or bigint) and handles parsing internally.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @param {Object} [options] - Optional configuration
+ * @param {('masculine'|'feminine')} [options.gender='masculine'] - Grammatical gender
+ * @returns {string} The number in Spanish words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toWords(21)                        // 'veintiuno'
+ * toWords(21, {gender: 'feminine'})  // 'veintiuna'
+ * toWords(1000000)                   // 'un millón'
  */
-export class Spanish extends GreedyScaleLanguage {
-    constructor(options?: {});
-    scaleWords: (string | bigint)[][];
-    /** Combines two word-sets with Spanish gender and conjunction rules. */
-    combineWordSets(preceding: any, following: any): any;
-}
-import { GreedyScaleLanguage } from '../classes/greedy-scale-language.js';
+export function toWords(value: number | string | bigint, options?: {
+    gender?: "masculine" | "feminine" | undefined;
+}): string;

package/lib/languages/es.js

@@ -1,121 +1,315 @@
-import { GreedyScaleLanguage } from '../classes/greedy-scale-language.js'
-
 /**
- * Spanish language converter.
+ * Spanish language converter - Functional Implementation
+ *
+ * Self-contained module with its own input validation, ready for subpath exports.
  *
- * Supports:
- * - Gender agreement (masculine/feminine via genderStem option)
- * - "y" conjunction between tens and units
- * - Special hundred forms (cien/ciento)
+ * Spanish-specific rules:
+ * - Gender agreement: uno/una, veintiuno/veintiuna, hundreds
+ * - Special twenties: veinte, veintiuno, veintidós, ... veintinueve
+ * - "y" conjunction: treinta y uno (only 30-99 with ones)
+ * - "cien" for exact 100, "ciento/cienta" otherwise
+ * - Irregular hundreds: quinientos, setecientos, novecientos
+ * - Compound long scale: millón, mil millones, billón, mil billones
+ * - "un" before millón (not "uno"), omit before mil
  */
-export class Spanish extends GreedyScaleLanguage {
-  negativeWord = 'menos'
-  decimalSeparatorWord = 'punto'
-  zeroWord = 'cero'
-
-  scaleWords = [
-    [1_000_000_000_000_000_000_000_000n, 'cuatrillón'],
-    [1_000_000_000_000_000_000n, 'trillón'],
-    [1_000_000_000_000n, 'billón'],
-    [1_000_000n, 'millón'],
-    [1000n, 'mil'],
-    [100n, 'cien'],
-    [90n, 'noventa'],
-    [80n, 'ochenta'],
-    [70n, 'setenta'],
-    [60n, 'sesenta'],
-    [50n, 'cincuenta'],
-    [40n, 'cuarenta'],
-    [30n, 'treinta'],
-    [29n, 'veintinueve'],
-    [28n, 'veintiocho'],
-    [27n, 'veintisiete'],
-    [26n, 'veintiséis'],
-    [25n, 'veinticinco'],
-    [24n, 'veinticuatro'],
-    [23n, 'veintitrés'],
-    [22n, 'veintidós'],
-    [21n, 'veintiuno'],
-    [20n, 'veinte'],
-    [19n, 'diecinueve'],
-    [18n, 'dieciocho'],
-    [17n, 'diecisiete'],
-    [16n, 'dieciseis'],
-    [15n, 'quince'],
-    [14n, 'catorce'],
-    [13n, 'trece'],
-    [12n, 'doce'],
-    [11n, 'once'],
-    [10n, 'diez'],
-    [9n, 'nueve'],
-    [8n, 'ocho'],
-    [7n, 'siete'],
-    [6n, 'seis'],
-    [5n, 'cinco'],
-    [4n, 'cuatro'],
-    [3n, 'tres'],
-    [2n, 'dos'],
-    [1n, 'uno'],
-    [0n, 'cero']
-  ]
-
-  constructor (options = {}) {
-    super()
-
-    this.setOptions({
-      gender: 'masculine'
-    }, options)
-
-    // Apply gender agreement to scale words if feminine
-    if (this.options.gender === 'feminine') {
-      this.scaleWords = this.scaleWords.map(([value, word]) => {
-        if (word === 'veintiuno') return [value, 'veintiuna']
-        if (word === 'uno') return [value, 'una']
-        return [value, word]
-      })
-    }
+
+import { parseNumericValue } from '../utils/parse-numeric.js'
+import { validateOptions } from '../utils/validate-options.js'
+
+// ============================================================================
+// Vocabulary (module-level constants)
+// ============================================================================
+
+const ONES_MASC = ['', 'uno', 'dos', 'tres', 'cuatro', 'cinco', 'seis', 'siete', 'ocho', 'nueve']
+const ONES_FEM = ['', 'una', 'dos', 'tres', 'cuatro', 'cinco', 'seis', 'siete', 'ocho', 'nueve']
+
+const TEENS = ['diez', 'once', 'doce', 'trece', 'catorce', 'quince', 'dieciseis', 'diecisiete', 'dieciocho', 'diecinueve']
+
+// 20-29 have special compound forms
+const TWENTIES_MASC = ['veinte', 'veintiuno', 'veintidós', 'veintitrés', 'veinticuatro', 'veinticinco', 'veintiséis', 'veintisiete', 'veintiocho', 'veintinueve']
+const TWENTIES_FEM = ['veinte', 'veintiuna', 'veintidós', 'veintitrés', 'veinticuatro', 'veinticinco', 'veintiséis', 'veintisiete', 'veintiocho', 'veintinueve']
+
+const TENS = ['', '', '', 'treinta', 'cuarenta', 'cincuenta', 'sesenta', 'setenta', 'ochenta', 'noventa']
+
+// Irregular hundreds
+const HUNDREDS_MASC = ['', 'ciento', 'doscientos', 'trescientos', 'cuatrocientos', 'quinientos', 'seiscientos', 'setecientos', 'ochocientos', 'novecientos']
+const HUNDREDS_FEM = ['', 'cienta', 'doscientas', 'trescientas', 'cuatrocientas', 'quinientas', 'seiscientas', 'setecientas', 'ochocientas', 'novecientas']
+
+// Scale words (compound long scale)
+const SCALES = ['millón', 'billón', 'trillón', 'cuatrillón']
+const SCALES_PLURAL = ['millones', 'billones', 'trillones', 'cuatrillones']
+
+const THOUSAND = 'mil'
+const ZERO = 'cero'
+const NEGATIVE = 'menos'
+const DECIMAL_SEP = 'punto'
+
+// ============================================================================
+// Segment Building
+// ============================================================================
+
+/**
+ * Builds segment word for 0-999.
+ * @param {number} n - Segment value
+ * @param {boolean} feminine - Use feminine forms
+ * @returns {string} Spanish word
+ */
+function buildSegment (n, feminine) {
+  if (n === 0) return ''
+
+  // Special case: exact 100 is "cien" (no gender)
+  if (n === 100) return 'cien'
+
+  const ones = n % 10
+  const tens = Math.floor(n / 10) % 10
+  const hundreds = Math.floor(n / 100)
+  const tensOnes = n % 100
+
+  const parts = []
+
+  // Hundreds
+  if (hundreds > 0) {
+    const hundredsArr = feminine ? HUNDREDS_FEM : HUNDREDS_MASC
+    parts.push(hundredsArr[hundreds])
   }
 
-  /** Combines two word-sets with Spanish gender and conjunction rules. */
-  combineWordSets (preceding, following) {
-    let precedingWord = Object.keys(preceding)[0]
-    let followingWord = Object.keys(following)[0]
-    const precedingValue = Object.values(preceding)[0]
-    const followingValue = Object.values(following)[0]
-    const genderStem = this.options.gender === 'feminine' ? 'a' : 'o'
-
-    if (precedingValue === 1n) {
-      if (followingValue < 1_000_000n) return following
-      precedingWord = 'un'
-    } else if (precedingValue === 100n && followingValue % 1000n !== 0n) {
-      precedingWord += 't' + genderStem
+  // Tens and ones
+  if (tensOnes === 0) {
+    // Just hundreds
+  } else if (tensOnes < 10) {
+    // Single digit
+    const onesArr = feminine ? ONES_FEM : ONES_MASC
+    parts.push(onesArr[tensOnes])
+  } else if (tensOnes < 20) {
+    // 10-19: teens
+    parts.push(TEENS[ones])
+  } else if (tensOnes < 30) {
+    // 20-29: special twenties
+    const twentiesArr = feminine ? TWENTIES_FEM : TWENTIES_MASC
+    parts.push(twentiesArr[ones])
+  } else {
+    // 30-99: tens y ones
+    if (ones === 0) {
+      parts.push(TENS[tens])
+    } else {
+      const onesArr = feminine ? ONES_FEM : ONES_MASC
+      parts.push(TENS[tens] + ' y ' + onesArr[ones])
     }
+  }
+
+  return parts.join(' ')
+}
+
+// ============================================================================
+// Helper Functions
+// ============================================================================
+
+/**
+ * Gets scale word for Spanish compound long scale.
+ *
+ * @param {number} scaleIndex - Scale level (1 = thousand, 2 = million, etc.)
+ * @param {bigint} segment - Segment value for pluralization
+ * @returns {string} Scale word
+ */
+function getScaleWord (scaleIndex, segment) {
+  if (scaleIndex === 1) return THOUSAND
+
+  // Even indices (2, 4, 6, 8): millón, billón, trillón, cuatrillón
+  // Odd indices > 1 (3, 5, 7): mil millones, mil billones, mil trillones
+  if (scaleIndex % 2 === 0) {
+    const arrayIndex = (scaleIndex / 2) - 1
+    const baseWord = SCALES[arrayIndex]
+    if (!baseWord) return ''
+    return segment > 1n ? SCALES_PLURAL[arrayIndex] : baseWord
+  } else {
+    // Compound: "mil millones" pattern
+    const arrayIndex = ((scaleIndex - 1) / 2) - 1
+    const pluralWord = SCALES_PLURAL[arrayIndex]
+    if (!pluralWord) return THOUSAND
+    return THOUSAND + ' ' + pluralWord
+  }
+}
+
+// ============================================================================
+// Conversion Functions
+// ============================================================================
+
+/**
+ * Converts a non-negative integer to Spanish words.
+ *
+ * @param {bigint} n - Non-negative integer to convert
+ * @param {boolean} feminine - Use feminine forms
+ * @returns {string} Spanish words
+ */
+function integerToWords (n, feminine) {
+  if (n === 0n) return ZERO
+
+  // Fast path: numbers < 1000
+  if (n < 1000n) {
+    return buildSegment(Number(n), feminine)
+  }
 
-    if (followingValue < precedingValue) {
-      if (precedingValue < 100n) {
-        return { [`${precedingWord} y ${followingWord}`]: precedingValue + followingValue }
+  // Fast path: numbers < 1,000,000 (thousands)
+  if (n < 1_000_000n) {
+    const thousands = Number(n / 1000n)
+    const remainder = Number(n % 1000n)
+
+    let result
+    if (thousands === 1) {
+      // "mil" not "uno mil"
+      result = THOUSAND
+    } else {
+      // Use masculine for thousands segment, but check for "uno" → omit before mil
+      const thousandsWord = buildSegment(thousands, false)
+      // "uno mil" → "mil" (handled in joinSegments equivalent)
+      if (thousandsWord === 'uno' || thousandsWord === 'una') {
+        result = THOUSAND
+      } else {
+        result = thousandsWord + ' ' + THOUSAND
       }
-      return { [`${precedingWord} ${followingWord}`]: precedingValue + followingValue }
     }
 
-    if (followingValue % 1_000_000n === 0n && precedingValue > 1n) {
-      followingWord = followingWord.slice(0, -3) + 'lones'
+    if (remainder > 0) {
+      result += ' ' + buildSegment(remainder, feminine)
     }
 
-    if (followingValue === 100n) {
-      if (precedingValue === 5n) {
-        precedingWord = 'quinien'
-        followingWord = ''
-      } else if (precedingValue === 7n) {
-        precedingWord = 'sete'
-      } else if (precedingValue === 9n) {
-        precedingWord = 'nove'
+    return result
+  }
+
+  // For numbers >= 1,000,000, use scale decomposition
+  return buildLargeNumberWords(n, feminine)
+}
+
+/**
+ * Builds words for numbers >= 1,000,000.
+ * Uses BigInt division for faster segment extraction.
+ *
+ * @param {bigint} n - Number >= 1,000,000
+ * @param {boolean} feminine - Use feminine forms
+ * @returns {string} Spanish words
+ */
+function buildLargeNumberWords (n, feminine) {
+  // Extract segments using BigInt division (faster than string slicing)
+  // Segments stored least-significant first (index 0 = ones, 1 = thousands, etc.)
+  const segmentValues = []
+  let temp = n
+  while (temp > 0n) {
+    segmentValues.push(temp % 1000n)
+    temp = temp / 1000n
+  }
+
+  // Build result string directly
+  let result = ''
+
+  for (let i = segmentValues.length - 1; i >= 0; i--) {
+    const segment = segmentValues[i]
+    if (segment === 0n) continue
+
+    const scaleWord = i > 0 ? getScaleWord(i, segment) : ''
+
+    if (result) result += ' '
+
+    if (i === 0) {
+      // Units segment
+      result += buildSegment(Number(segment), feminine)
+    } else if (i === 1) {
+      // Thousands: omit "uno" before mil
+      if (segment === 1n) {
+        result += THOUSAND
+      } else {
+        result += buildSegment(Number(segment), false) + ' ' + scaleWord
+      }
+    } else if (i % 2 === 1) {
+      // Odd scale indices (3, 5, 7): "mil millones", "mil billones", etc.
+      // Omit "uno" before these compound scales
+      if (segment === 1n) {
+        result += scaleWord
+      } else {
+        result += buildSegment(Number(segment), false) + ' ' + scaleWord
       }
-      followingWord += 't' + genderStem + 's'
     } else {
-      followingWord = ' ' + followingWord
+      // Even scale indices (2, 4, 6): millón, billón, trillón
+      if (segment === 1n) {
+        // "un millón" not "uno millón"
+        result += 'un ' + scaleWord
+      } else {
+        // Use masculine for scale segment
+        result += buildSegment(Number(segment), false) + ' ' + scaleWord
+      }
     }
+  }
 
-    return { [`${precedingWord}${followingWord}`]: precedingValue * followingValue }
+  return result
+}
+
+/**
+ * Converts decimal digits to Spanish words.
+ *
+ * @param {string} decimalPart - Decimal digits (without the point)
+ * @param {boolean} feminine - Use feminine forms
+ * @returns {string} Spanish words for decimal part
+ */
+function decimalPartToWords (decimalPart, feminine) {
+  let result = ''
+
+  // Handle leading zeros
+  let i = 0
+  while (i < decimalPart.length && decimalPart[i] === '0') {
+    if (result) result += ' '
+    result += ZERO
+    i++
+  }
+
+  // Convert remainder as a single number
+  const remainder = decimalPart.slice(i)
+  if (remainder) {
+    if (result) result += ' '
+    result += integerToWords(BigInt(remainder), feminine)
+  }
+
+  return result
+}
+
+/**
+ * Converts a numeric value to Spanish words.
+ *
+ * This is the main public API. It accepts any valid numeric input
+ * (number, string, or bigint) and handles parsing internally.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @param {Object} [options] - Optional configuration
+ * @param {('masculine'|'feminine')} [options.gender='masculine'] - Grammatical gender
+ * @returns {string} The number in Spanish words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toWords(21)                        // 'veintiuno'
+ * toWords(21, {gender: 'feminine'})  // 'veintiuna'
+ * toWords(1000000)                   // 'un millón'
+ */
+function toWords (value, options) {
+  options = validateOptions(options)
+  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+  const feminine = options.gender === 'feminine'
+
+  let result = ''
+
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  result += integerToWords(integerPart, feminine)
+
+  if (decimalPart) {
+    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart, feminine)
   }
+
+  return result
 }
+
+// ============================================================================
+// Public API
+// ============================================================================
+
+export { toWords }

package/lib/languages/fa.d.ts

@@ -1,47 +1,7 @@
 /**
- * Persian language converter.
+ * Converts a numeric value to Persian words.
  *
- * Supports:
- * - "و" (and) conjunction for compound numbers
- * - Recursive conversion for larger numbers
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Persian words
  */
-export class Persian extends AbstractLanguage {
-    /**
-     * Words for digits 1-9.
-     * @type {Object.<number, string>}
-     */
-    onesWords: {
-        [x: number]: string;
-    };
-    /**
-     * Words for teen numbers (10-19).
-     * @type {Object.<number, string>}
-     */
-    teensWords: {
-        [x: number]: string;
-    };
-    /**
-     * Words for multiples of ten (20-90).
-     * @type {Object.<number, string>}
-     */
-    tensWords: {
-        [x: number]: string;
-    };
-    /**
-     * Words for hundreds (100-900).
-     * @type {Object.<number, string>}
-     */
-    hundredsWords: {
-        [x: number]: string;
-    };
-    /**
-     * Scale magnitude words.
-     * @type {Object.<number, string>}
-     */
-    scaleWords: {
-        [x: number]: string;
-    };
-    /** Converts integer part using categorized word tables. */
-    integerToWords(integerPart: any): any;
-}
-import { AbstractLanguage } from '../classes/abstract-language.js';
+export function toWords(value: number | string | bigint): string;