n2words 1.24.0 → 3.0.0

package/lib/languages/fa.js

@@ -1,127 +1,134 @@
-import AbstractLanguage from '../classes/abstract-language.js'
-
 /**
- * Persian (Farsi) language converter.
- *
- * Converts numbers to Persian words using Persian-Arabic numerals:
- * - Right-to-left script orientation
- * - Base-10 decimal system with Persian number words
- * - Conjunction "و" (va/and) for compound numbers
- * - Traditional Persian number naming conventions
+ * Persian language converter - Functional Implementation
  *
- * Key Features:
- * - Named number lookup table (namedNumbers) for direct mapping 0-999
- * - Group-based algorithm for numbers >= 1000:
- *   1. Split into groups of 3 digits
- *   2. Convert each group to words using named table or recursion
- *   3. Append magnitude word (هزار/میلیون/میلیارد)
- *   4. Join with "و" (and) conjunction
- * - Special compound forms (دویست for 200, سیصد for 300)
- * - Proper Persian grammatical structure
- * - Support for large numbers (thousands, millions, billions, trillions)
+ * Self-contained converter using recursive decomposition.
  *
- * Features:
- * - Native Persian digits and words
- * - Special compound forms (e.g., دویست for 200, سیصد for 300)
- * - Support for large numbers (thousands, millions)
- * - Proper Persian grammatical structure
+ * Key features:
+ * - "و" (and) conjunction for compound numbers
+ * - Omit "یک" (one) before thousand
+ * - Pre-composed hundreds (دویست, سيصد, etc.)
  */
-export class Farsi extends AbstractLanguage {
-  negativeWord = 'منفى'
-  decimalSeparatorWord = 'ممیّز'
-  zeroWord = 'صفر'
-  namedNumbers = {
-    0: 'صفر',
-    1: 'یک',
-    2: 'دو',
-    3: 'سه',
-    4: 'چهار',
-    5: 'پنج',
-    6: 'شش',
-    7: 'هفت',
-    8: 'هشت',
-    9: 'نه',
-    10: 'ده',
-    11: 'یازده',
-    12: 'دوازده',
-    13: 'سیزده',
-    14: 'چهارده',
-    15: 'پانزده',
-    16: 'شانزده',
-    17: 'هفده',
-    18: 'هجده',
-    19: 'نوزده',
-    20: 'بیست',
-    30: 'سی',
-    40: 'چهل',
-    50: 'پنجاه',
-    60: 'شصت',
-    70: 'هفتاد',
-    80: 'هشتاد',
-    90: 'نود',
-    100: 'صد',
-    200: 'دویست',
-    300: 'سيصد',
-    400: 'چهار صد',
-    500: 'پانصد',
-    600: 'ششصد',
-    700: 'هفتصد',
-    800: 'هشتصد',
-    900: 'نهصد',
-    1000: 'هزار',
-    1_000_000: 'میلیون'
+
+import { parseNumericValue } from '../utils/parse-numeric.js'
+
+// ============================================================================
+// Vocabulary
+// ============================================================================
+
+const ONES = { 1: 'یک', 2: 'دو', 3: 'سه', 4: 'چهار', 5: 'پنج', 6: 'شش', 7: 'هفت', 8: 'هشت', 9: 'نه' }
+const TEENS = { 10: 'ده', 11: 'یازده', 12: 'دوازده', 13: 'سیزده', 14: 'چهارده', 15: 'پانزده', 16: 'شانزده', 17: 'هفده', 18: 'هجده', 19: 'نوزده' }
+const TENS = { 20: 'بیست', 30: 'سی', 40: 'چهل', 50: 'پنجاه', 60: 'شصت', 70: 'هفتاد', 80: 'هشتاد', 90: 'نود' }
+const HUNDREDS = { 100: 'صد', 200: 'دویست', 300: 'سيصد', 400: 'چهار صد', 500: 'پانصد', 600: 'ششصد', 700: 'هفتصد', 800: 'هشتصد', 900: 'نهصد' }
+
+const THOUSAND = 'هزار'
+const MILLION = 'میلیون'
+
+const ZERO = 'صفر'
+const NEGATIVE = 'منفى'
+const DECIMAL_SEP = 'ممیّز'
+
+// ============================================================================
+// Conversion Functions
+// ============================================================================
+
+function integerToWords (n) {
+  if (n === 0n) return ZERO
+
+  // 1-9
+  if (n <= 9n) {
+    return ONES[Number(n)]
   }
 
-  convertWholePart (number) {
-    if (this.namedNumbers[number] && number !== 1_000_000n) {
-      return this.namedNumbers[number]
-    }
+  // 10-19
+  if (n <= 19n) {
+    return TEENS[Number(n)]
+  }
 
-    if (number > 20n && number < 100n) {
-      const xone = number % 10n
-      const xten = number - xone
-      return `${this.namedNumbers[xten]} و ${this.namedNumbers[xone]}`
+  // 20-99
+  if (n < 100n) {
+    const ones = n % 10n
+    const tens = n - ones
+    if (ones === 0n) {
+      return TENS[Number(tens)]
     }
+    return `${TENS[Number(tens)]} و ${ONES[Number(ones)]}`
+  }
 
-    if (number > 100n && number < 1000n) {
-      const xhundred = 100n * (number / 100n)
-      const tail = this.convertWholePart(number - xhundred)
-      return `${this.namedNumbers[xhundred]} و ${tail}`
+  // 100-999
+  if (n < 1000n) {
+    const hundreds = 100n * (n / 100n)
+    const remainder = n - hundreds
+    if (remainder === 0n) {
+      return HUNDREDS[Number(hundreds)]
     }
+    return `${HUNDREDS[Number(hundreds)]} و ${integerToWords(remainder)}`
+  }
 
-    if (number > 1000n && number < 1_000_000n) {
-      const thousandMultiplier = number / 1000n
-      const namedThousandMultiplier =
-        (thousandMultiplier === 1n
-          ? ''
-          : this.convertWholePart(thousandMultiplier)) +
-        ' ' +
-        this.namedNumbers[1000]
-      const tailNumber = number - thousandMultiplier * 1000n
-      const tail = tailNumber === 0n ? '' : ' ' + this.convertWholePart(tailNumber)
-      return `${namedThousandMultiplier}${tail}`
-    }
+  // 1000-999999
+  if (n < 1_000_000n) {
+    const thousandMultiplier = n / 1000n
+    // Persian omits "one" before thousand: 1000 is just "هزار", not "یک هزار"
+    const thousandPrefix = thousandMultiplier === 1n
+      ? ''
+      : integerToWords(thousandMultiplier) + ' '
+    const remainder = n % 1000n
+    const suffix = remainder === 0n ? '' : ' ' + integerToWords(remainder)
+    return `${thousandPrefix}${THOUSAND}${suffix}`
+  }
 
-    if (number >= 1_000_000n) {
-      const millionMultiplier = number / 1_000_000n
-      const namedMillion =
-        this.convertWholePart(millionMultiplier) + ' ' + this.namedNumbers[1_000_000]
-      const tailNumber = number - millionMultiplier * 1_000_000n
-      const tail = tailNumber === 0n ? '' : ' و ' + this.convertWholePart(tailNumber)
-      return `${namedMillion}${tail}`
-    }
+  // 1000000+
+  const millionMultiplier = n / 1_000_000n
+  const millionPrefix = integerToWords(millionMultiplier) + ' ' + MILLION
+  const remainder = n % 1_000_000n
+  const suffix = remainder === 0n ? '' : ' و ' + integerToWords(remainder)
+  return `${millionPrefix}${suffix}`
+}
+
+function decimalPartToWords (decimalPart) {
+  let result = ''
+  let i = 0
+
+  while (i < decimalPart.length && decimalPart[i] === '0') {
+    if (result) result += ' '
+    result += ZERO
+    i++
   }
+
+  const remainder = decimalPart.slice(i)
+  if (remainder) {
+    if (result) result += ' '
+    result += integerToWords(BigInt(remainder))
+  }
+
+  return result
 }
 
 /**
- * Converts a number to Persian cardinal (written) form.
+ * Converts a numeric value to Persian words.
  *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @returns {string} The number expressed in Persian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Persian words
  */
-export default function convertToWords (value, options = {}) {
-  return new Farsi(options).convertToWords(value)
+function toWords (value) {
+  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+
+  let result = ''
+
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  result += integerToWords(integerPart)
+
+  if (decimalPart) {
+    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart)
+  }
+
+  return result
 }
+
+// ============================================================================
+// Exports
+// ============================================================================
+
+export { toWords }

package/lib/languages/fi.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Converts a numeric value to Finnish words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Finnish words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toWords(21)       // 'kaksikymmentäyksi'
+ * toWords(1000)     // 'tuhat'
+ * toWords('3.14')   // 'kolme pilkku yksi neljä'
+ */
+export function toWords(value: number | string | bigint): string;

package/lib/languages/fi.js

@@ -0,0 +1,245 @@
+/**
+ * Finnish language converter - Functional Implementation
+ *
+ * A performance-optimized number-to-words converter using precomputed lookup tables.
+ *
+ * Key features:
+ * - Compound tens+ones without spaces: "kaksikymmentäyksi" (21)
+ * - Teens with "-toista" suffix
+ * - Omit "yksi" before sata/tuhat but keep before miljoona+
+ * - Long scale: miljoona, miljardi, biljoona
+ * - Per-digit decimal reading
+ */
+
+import { parseNumericValue } from '../utils/parse-numeric.js'
+
+// ============================================================================
+// Vocabulary (module-level constants)
+// ============================================================================
+
+const ONES = ['', 'yksi', 'kaksi', 'kolme', 'neljä', 'viisi', 'kuusi', 'seitsemän', 'kahdeksan', 'yhdeksän']
+
+const TEENS = ['kymmenen', 'yksitoista', 'kaksitoista', 'kolmetoista', 'neljätoista', 'viisitoista', 'kuusitoista', 'seitsemäntoista', 'kahdeksantoista', 'yhdeksäntoista']
+
+// Tens use "kymmentä" suffix
+const TENS = ['', '', 'kaksikymmentä', 'kolmekymmentä', 'neljäkymmentä', 'viisikymmentä', 'kuusikymmentä', 'seitsemänkymmentä', 'kahdeksankymmentä', 'yhdeksänkymmentä']
+
+const HUNDRED = 'sata'
+const THOUSAND = 'tuhat'
+
+const ZERO = 'nolla'
+const NEGATIVE = 'miinus'
+const DECIMAL_SEP = 'pilkku'
+
+// Long scale
+const SCALES = ['miljoona', 'miljardi', 'biljoona', 'triljoona']
+
+// ============================================================================
+// Precomputed Lookup Tables (built once at module load)
+// ============================================================================
+
+/**
+ * Builds segment word for 0-999.
+ * Omits "yksi" before "sata" (hundred).
+ */
+function buildSegment (n) {
+  if (n === 0) return ''
+
+  const ones = n % 10
+  const tens = Math.floor(n / 10) % 10
+  const hundreds = Math.floor(n / 100)
+
+  const parts = []
+
+  // Hundreds - omit "yksi" before sata
+  if (hundreds > 0) {
+    if (hundreds === 1) {
+      parts.push(HUNDRED)
+    } else {
+      parts.push(ONES[hundreds] + ' ' + HUNDRED)
+    }
+  }
+
+  // Tens and ones
+  const tensOnes = n % 100
+
+  if (tensOnes === 0) {
+    // Just hundreds
+  } else if (tensOnes < 10) {
+    parts.push(ONES[ones])
+  } else if (tensOnes < 20) {
+    parts.push(TEENS[ones])
+  } else if (ones === 0) {
+    parts.push(TENS[tens])
+  } else {
+    // Compound: "kaksikymmentäyksi" (no space)
+    parts.push(TENS[tens] + ONES[ones])
+  }
+
+  return parts.join(' ')
+}
+
+// Precompute all 1000 segment words (0-999)
+const SEGMENTS = new Array(1000)
+
+for (let i = 0; i < 1000; i++) {
+  SEGMENTS[i] = buildSegment(i)
+}
+
+// ============================================================================
+// Conversion Functions
+// ============================================================================
+
+/**
+ * Converts a non-negative integer to Finnish words.
+ *
+ * @param {bigint} n - Non-negative integer to convert
+ * @returns {string} Finnish words
+ */
+function integerToWords (n) {
+  if (n === 0n) return ZERO
+
+  // Fast path: numbers < 1000 (direct lookup)
+  if (n < 1000n) {
+    return SEGMENTS[Number(n)]
+  }
+
+  // Fast path: numbers < 1,000,000 (thousands)
+  if (n < 1_000_000n) {
+    const thousands = Number(n / 1000n)
+    const remainder = Number(n % 1000n)
+
+    // Omit "yksi" before tuhat
+    let result
+    if (thousands === 1) {
+      result = THOUSAND
+    } else {
+      result = SEGMENTS[thousands] + ' ' + THOUSAND
+    }
+
+    if (remainder > 0) {
+      result += ' ' + SEGMENTS[remainder]
+    }
+
+    return result
+  }
+
+  // For numbers >= 1,000,000, use scale decomposition
+  return buildLargeNumberWords(n)
+}
+
+/**
+ * Builds words for numbers >= 1,000,000.
+ *
+ * @param {bigint} n - Number >= 1,000,000
+ * @returns {string} Finnish words
+ */
+function buildLargeNumberWords (n) {
+  const numStr = n.toString()
+  const len = numStr.length
+
+  // Build segments of 3 digits from right to left
+  const segments = []
+  const segmentSize = 3
+
+  const remainderLen = len % segmentSize
+  let pos = 0
+  if (remainderLen > 0) {
+    segments.push(Number(numStr.slice(0, remainderLen)))
+    pos = remainderLen
+  }
+  while (pos < len) {
+    segments.push(Number(numStr.slice(pos, pos + segmentSize)))
+    pos += segmentSize
+  }
+
+  // Convert segments to words
+  const parts = []
+  let scaleIndex = segments.length - 1
+
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i]
+
+    if (segment !== 0) {
+      const segmentWord = SEGMENTS[segment]
+
+      if (scaleIndex === 0) {
+        // Units segment
+        parts.push(segmentWord)
+      } else if (scaleIndex === 1) {
+        // Thousands - omit "yksi" before tuhat
+        if (segment === 1) {
+          parts.push(THOUSAND)
+        } else {
+          parts.push(segmentWord + ' ' + THOUSAND)
+        }
+      } else {
+        // Millions+ - keep "yksi" before scale words
+        const scaleWord = SCALES[scaleIndex - 2]
+        parts.push(segmentWord + ' ' + scaleWord)
+      }
+    }
+
+    scaleIndex--
+  }
+
+  return parts.join(' ')
+}
+
+/**
+ * Converts decimal digits to Finnish words (per-digit).
+ *
+ * @param {string} decimalPart - Decimal digits (without the point)
+ * @returns {string} Finnish words for decimal part
+ */
+function decimalPartToWords (decimalPart) {
+  const parts = []
+
+  for (const digit of decimalPart) {
+    const d = parseInt(digit, 10)
+    if (d === 0) {
+      parts.push(ZERO)
+    } else {
+      parts.push(ONES[d])
+    }
+  }
+
+  return parts.join(' ')
+}
+
+/**
+ * Converts a numeric value to Finnish words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Finnish words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toWords(21)       // 'kaksikymmentäyksi'
+ * toWords(1000)     // 'tuhat'
+ * toWords('3.14')   // 'kolme pilkku yksi neljä'
+ */
+function toWords (value) {
+  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+
+  let result = ''
+
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  result += integerToWords(integerPart)
+
+  if (decimalPart) {
+    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart)
+  }
+
+  return result
+}
+
+// ============================================================================
+// Public API
+// ============================================================================
+
+export { toWords }

package/lib/languages/fil.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts a numeric value to Filipino words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Filipino words
+ */
+export function toWords(value: number | string | bigint): string;