n2words 2.0.0 → 3.1.0

package/lib/languages/hbo.js

@@ -1,251 +1,282 @@
-import { SlavicLanguage } from '../classes/slavic-language.js'
-
 /**
- * Biblical Hebrew language converter.
+ * Biblical Hebrew language converter - Functional Implementation
+ *
+ * Self-contained module with its own input validation, ready for subpath exports.
  *
- * Supports:
- * - Three-form pluralization (one/few/many)
- * - Gender agreement (masculine/feminine)
- * - Optional "ו" (and) conjunction control
+ * Key features:
+ * - Gender agreement (masculine default, feminine via option)
+ * - Dual forms for 2, 200, 2000
+ * - Special 1-9 thousands construct state
+ * - "ו" (ve) conjunction rules vary by position
+ * - Per-digit decimal reading
  */
-export class BiblicalHebrew extends SlavicLanguage {
-  negativeWord = 'מינוס'
-  decimalSeparatorWord = 'נקודה'
-  zeroWord = 'אפס'
-  usePerDigitDecimals = true
-
-  // Biblical Hebrew (masculine forms as default - historically accurate)
-  onesWords = {
-    1: 'אחד',
-    2: 'שניים',
-    3: 'שלשה',
-    4: 'ארבעה',
-    5: 'חמשה',
-    6: 'ששה',
-    7: 'שבעה',
-    8: 'שמונה',
-    9: 'תשעה'
-  }
 
-  teensWords = {
-    0: 'עשרה',
-    1: 'אחד עשר',
-    2: 'שנים עשר',
-    3: 'שלשה עשר',
-    4: 'ארבעה עשר',
-    5: 'חמשה עשר',
-    6: 'ששה עשר',
-    7: 'שבעה עשר',
-    8: 'שמונה עשר',
-    9: 'תשעה עשר'
-  }
+import { parseNumericValue } from '../utils/parse-numeric.js'
+import { validateOptions } from '../utils/validate-options.js'
 
-  twentiesWords = {
-    2: 'עשרים',
-    3: 'שלשים',
-    4: 'ארבעים',
-    5: 'חמישים',
-    6: 'ששים',
-    7: 'שבעים',
-    8: 'שמונים',
-    9: 'תשעים'
-  }
+// ============================================================================
+// Vocabulary (arrays for indexed access - faster than object property lookup)
+// ============================================================================
 
-  hundredsWords = {
-    1: 'מאה',
-    2: 'מאתיים',
-    3: 'מאות'
-  }
+// Masculine forms (default in Biblical Hebrew) - index 0 unused
+const ONES_MASC = ['', 'אחד', 'שניים', 'שלשה', 'ארבעה', 'חמשה', 'ששה', 'שבעה', 'שמונה', 'תשעה']
+const TEENS_MASC = ['עשרה', 'אחד עשר', 'שנים עשר', 'שלשה עשר', 'ארבעה עשר', 'חמשה עשר', 'ששה עשר', 'שבעה עשר', 'שמונה עשר', 'תשעה עשר']
+const THOUSANDS_MASC = ['', 'אלף', 'אלפיים', 'שלשה אלפים', 'ארבעה אלפים', 'חמשה אלפים', 'ששה אלפים', 'שבעה אלפים', 'שמונה אלפים', 'תשעה אלפים']
 
-  pluralForms = {
-    1: 'אלף',
-    2: 'אלפיים',
-    3: 'שלשה אלפים',
-    4: 'ארבעה אלפים',
-    5: 'חמשה אלפים',
-    6: 'ששה אלפים',
-    7: 'שבעה אלפים',
-    8: 'שמונה אלפים',
-    9: 'תשעה אלפים'
-  }
+// Feminine forms - index 0 unused
+const ONES_FEM = ['', 'אחת', 'שתים', 'שלש', 'ארבע', 'חמש', 'שש', 'שבע', 'שמונה', 'תשע']
+const TEENS_FEM = ['עשר', 'אחת עשרה', 'שתים עשרה', 'שלש עשרה', 'ארבע עשרה', 'חמש עשרה', 'שש עשרה', 'שבע עשרה', 'שמונה עשרה', 'תשע עשרה']
+const THOUSANDS_FEM = ['', 'אלף', 'אלפיים', 'שלשת אלפים', 'ארבעת אלפים', 'חמשת אלפים', 'ששת אלפים', 'שבעת אלפים', 'שמונת אלפים', 'תשעת אלפים']
 
-  // Feminine forms for thousands (when feminine=true is specified)
-  femininePluralForms = {
-    1: 'אלף',
-    2: 'אלפיים',
-    3: 'שלשת אלפים',
-    4: 'ארבעת אלפים',
-    5: 'חמשת אלפים',
-    6: 'ששת אלפים',
-    7: 'שבעת אלפים',
-    8: 'שמונת אלפים',
-    9: 'תשעת אלפים'
-  }
+// Shared vocabulary
+const TENS = ['', '', 'עשרים', 'שלשים', 'ארבעים', 'חמישים', 'ששים', 'שבעים', 'שמונים', 'תשעים']
+const HUNDREDS = ['', 'מאה', 'מאתיים', 'שלשה מאות', 'ארבעה מאות', 'חמשה מאות', 'ששה מאות', 'שבעה מאות', 'שמונה מאות', 'תשעה מאות']
+const HUNDREDS_FEM = ['', 'מאה', 'מאתיים', 'שלש מאות', 'ארבע מאות', 'חמש מאות', 'שש מאות', 'שבע מאות', 'שמונה מאות', 'תשע מאות']
 
-  scale = {
-    1: 'אלף', // thousand (singular)
-    2: 'מיליון', // million
-    3: 'מיליארד', // billion
-    4: 'טריליון', // trillion
-    5: 'קוודרליון', // quadrillion
-    6: 'קווינטיליון' // quintillion
-  }
+// Scale words (index 1 = thousands, 2 = millions, etc.)
+const SCALE = ['', 'אלף', 'מיליון', 'מיליארד', 'טריליון', 'קוודרליון', 'קווינטיליון']
+const SCALE_PLURAL = ['', 'אלפים', 'מיליונים', 'מיליארדים', 'טריליונים', 'קוודרליונים', 'קווינטיליונים']
 
-  scalePlural = {
-    1: 'אלפים', // thousands
-    2: 'מיליונים', // millions
-    3: 'מיליארדים', // billions
-    4: 'טריליונים', // trillions
-    5: 'קוודרליונים', // quadrillions
-    6: 'קווינטיליונים' // quintillions
-  }
+const ZERO = 'אפס'
+const NEGATIVE = 'מינוס'
+const DECIMAL_SEP = 'נקודה'
+
+// ============================================================================
+// Segment Building
+// ============================================================================
+
+/**
+ * Builds segment word for scale segments (thousands, millions, etc.).
+ * "ו" is added before tens and ones when following hundreds.
+ */
+function buildScaleSegment (n, andWord, ONES, TEENS, HUNDREDS_ARR) {
+  if (n === 0) return ''
 
-  // Feminine forms (for when gender='feminine' is specified)
-  onesFeminineWords = {
-    1: 'אחת',
-    2: 'שתים',
-    3: 'שלש',
-    4: 'ארבע',
-    5: 'חמש',
-    6: 'שש',
-    7: 'שבע',
-    8: 'שמונה',
-    9: 'תשע'
+  const ones = n % 10
+  const tens = Math.floor(n / 10) % 10
+  const hundreds = Math.floor(n / 100)
+
+  let result = ''
+
+  // Hundreds
+  if (hundreds > 0) {
+    result = HUNDREDS_ARR[hundreds]
   }
 
-  teensFeminineWords = {
-    0: 'עשר',
-    1: 'אחת עשרה',
-    2: 'שתים עשרה',
-    3: 'שלש עשרה',
-    4: 'ארבע עשרה',
-    5: 'חמש עשרה',
-    6: 'שש עשרה',
-    7: 'שבע עשרה',
-    8: 'שמונה עשרה',
-    9: 'תשע עשרה'
+  // Tens and ones
+  if (tens === 1) {
+    // Teens (10-19)
+    const teenWord = TEENS[ones]
+    if (result) {
+      result += ' ' + andWord + teenWord
+    } else {
+      result = teenWord
+    }
+  } else {
+    // Tens (20-90)
+    if (tens >= 2) {
+      if (result) {
+        result += ' ' + andWord + TENS[tens]
+      } else {
+        result = TENS[tens]
+      }
+    }
+
+    // Ones
+    if (ones > 0) {
+      if (result) {
+        result += ' ' + andWord + ONES[ones]
+      } else {
+        result = ONES[ones]
+      }
+    }
   }
 
-  constructor (options = {}) {
-    super(options)
+  return result
+}
 
-    this.setOptions({
-      andWord: 'ו',
-      gender: 'masculine'
-    }, options)
+/**
+ * Builds segment word for units segment (no scale word).
+ * "ו" is only added before the final ones digit.
+ */
+function buildUnitsSegment (n, andWord, ONES, TEENS, HUNDREDS_ARR) {
+  if (n === 0) return ''
 
-    if (this.options.gender === 'feminine') {
-      this.onesWords = this.onesFeminineWords
-      this.teensWords = this.teensFeminineWords
-      this.pluralForms = this.femininePluralForms
-    }
+  const ones = n % 10
+  const tens = Math.floor(n / 10) % 10
+  const hundreds = Math.floor(n / 100)
+
+  let result = ''
+
+  // Hundreds
+  if (hundreds > 0) {
+    result = HUNDREDS_ARR[hundreds]
   }
 
-  /** Converts integer part with Biblical Hebrew three-form pluralization. */
-  integerToWords (integerPart) {
-    if (integerPart === 0n) {
-      return this.zeroWord
+  // Tens (no conjunction)
+  if (tens === 1) {
+    // Teens (10-19)
+    if (result) {
+      result += ' ' + TEENS[ones]
+    } else {
+      result = TEENS[ones]
     }
-    const words = []
-    const segments = this.splitToSegments(integerPart.toString(), 3)
-    let index = segments.length
-    for (const x of segments) {
-      index = index - 1
-      if (x === 0n) {
-        continue
+  } else {
+    if (tens >= 2) {
+      if (result) {
+        result += ' ' + TENS[tens]
+      } else {
+        result = TENS[tens]
       }
+    }
 
-      const [n1, n2, n3] = this.extractDigits(x)
-
-      if (index > 0) {
-        // For thousands and above, handle the full chunk value
-        const chunkWords = []
-        let hasHundreds = false
-
-        // Process hundreds in this chunk
-        if (n3 > 0n) {
-          hasHundreds = true
-          if (n3 <= 2n) {
-            chunkWords.push(this.hundredsWords[n3])
-          } else {
-            chunkWords.push(this.onesWords[n3] + ' ' + this.hundredsWords[3])
-          }
-        }
+    // Ones - conjunction only here
+    if (ones > 0) {
+      if (result) {
+        result += ' ' + andWord + ONES[ones]
+      } else {
+        result = ONES[ones]
+      }
+    }
+  }
 
-        // Process tens in this chunk
-        if (n2 > 1n) {
-          // Add conjunction if there were hundreds before
-          const tensWord = this.twentiesWords[n2]
-          chunkWords.push(hasHundreds ? this.options.andWord + tensWord : tensWord)
-        }
+  return result
+}
 
-        // Process ones in this chunk
-        if (n2 === 1n) {
-          // Add conjunction if there were hundreds before
-          const onesWord = this.teensWords[n1]
-          chunkWords.push(hasHundreds ? this.options.andWord + onesWord : onesWord)
-        } else if (n1 > 0n) {
-          // For "one million", "one billion", etc., don't add the word "one"
-          if (x === 1n && index > 1) {
-            // Skip adding "one" for millions/billions/etc.
-          } else if (x <= 9n && chunkWords.length === 0 && index === 1) {
-            // Use special forms for 1-9 thousand
-            chunkWords.push(this.pluralForms[n1])
-          } else {
-            const onesWord = this.onesWords[n1]
-            // Add conjunction if there were hundreds or tens before
-            chunkWords.push((hasHundreds || n2 > 0n) ? this.options.andWord + onesWord : onesWord)
-          }
-        }
+// ============================================================================
+// Conversion Functions
+// ============================================================================
 
-        // Add scale word (thousand, million, billion, etc.)
-        if (x > 9n || index > 1) {
-          // For numbers > 9 or higher scales, use appropriate scale word
-          if (x === 1n) {
-            // Singular form (e.g., "one thousand", "one million")
-            chunkWords.push(this.scale[index])
-          } else if (x === 2n && index === 1) {
-            // Special dual form for "two thousand" (already in thousands[2])
-            return [this.pluralForms[2], ...words].join(' ')
-          } else if (x === 2n) {
-            // For two million, two billion, etc. - use plural form
-            chunkWords.push(this.scalePlural[index])
-          } else if (index === 1) {
-            // For thousands (10+), always use singular "אלף"
-            chunkWords.push(this.scale[index])
-          } else {
-            // For millions/billions/etc. use plural form
-            chunkWords.push(this.scalePlural[index])
-          }
-        }
+/**
+ * Converts a non-negative integer to Biblical Hebrew words.
+ *
+ * @param {bigint} n - Non-negative integer to convert
+ * @param {Object} options - Conversion options
+ * @returns {string} Biblical Hebrew words
+ */
+function integerToWords (n, options) {
+  if (n === 0n) return ZERO
 
-        words.push(chunkWords.join(' '))
-        continue
-      }
+  const andWord = options.andWord ?? 'ו'
+  const gender = options.gender || 'masculine'
+  const isFeminine = gender === 'feminine'
+
+  // Select vocabulary based on gender
+  const ONES = isFeminine ? ONES_FEM : ONES_MASC
+  const TEENS = isFeminine ? TEENS_FEM : TEENS_MASC
+  const THOUSANDS_SPECIAL = isFeminine ? THOUSANDS_FEM : THOUSANDS_MASC
+  const HUNDREDS_ARR = isFeminine ? HUNDREDS_FEM : HUNDREDS
+
+  // Fast path: numbers < 1000
+  if (n < 1000n) {
+    return buildUnitsSegment(Number(n), andWord, ONES, TEENS, HUNDREDS_ARR)
+  }
+
+  // Extract segments using BigInt modulo
+  const segments = []
+  let temp = n
+  while (temp > 0n) {
+    segments.push(Number(temp % 1000n))
+    temp = temp / 1000n
+  }
+
+  // Build result string directly
+  let result = ''
+
+  for (let i = segments.length - 1; i >= 0; i--) {
+    const segment = segments[i]
+    if (segment === 0) continue
 
-      if (n3 > 0n) {
-        if (n3 <= 2n) {
-          words.push(this.hundredsWords[n3])
+    if (i === 0) {
+      // Units segment (no scale word)
+      const segmentWord = buildUnitsSegment(segment, andWord, ONES, TEENS, HUNDREDS_ARR)
+      if (result) {
+        // Add "ו" before single-digit units when following scale words
+        if (segment <= 9) {
+          result += ' ' + andWord + segmentWord
         } else {
-          words.push(this.onesWords[n3] + ' ' + this.hundredsWords[3])
+          result += ' ' + segmentWord
         }
+      } else {
+        result = segmentWord
       }
-
-      if (n2 > 1n) {
-        words.push(this.twentiesWords[n2])
+    } else if (i === 1) {
+      // Thousands - special handling for 1-9
+      if (segment <= 9) {
+        if (result) result += ' '
+        result += THOUSANDS_SPECIAL[segment]
+      } else {
+        const segmentWord = buildScaleSegment(segment, andWord, ONES, TEENS, HUNDREDS_ARR)
+        if (result) result += ' '
+        result += segmentWord + ' ' + SCALE[1]
       }
-
-      if (n2 === 1n) {
-        words.push(this.teensWords[n1])
-      } else if (n1 > 0n) {
-        words.push(this.onesWords[n1])
+    } else {
+      // Millions and above
+      if (segment === 1) {
+        if (result) result += ' '
+        result += SCALE[i]
+      } else {
+        const segmentWord = buildScaleSegment(segment, andWord, ONES, TEENS, HUNDREDS_ARR)
+        if (result) result += ' '
+        result += segmentWord + ' ' + SCALE_PLURAL[i]
       }
     }
+  }
 
-    if (words.length > 1) {
-      words[words.length - 1] = this.options.andWord + words.at(-1)
-    }
+  return result
+}
+
+/**
+ * Converts decimal digits to Biblical Hebrew words (digit by digit).
+ *
+ * @param {string} decimalPart - Decimal digits (without the point)
+ * @param {Object} options - Conversion options
+ * @returns {string} Biblical Hebrew words for decimal part
+ */
+function decimalPartToWords (decimalPart, options) {
+  const gender = options.gender || 'masculine'
+  const ONES = gender === 'feminine' ? ONES_FEM : ONES_MASC
+
+  let result = ''
+  for (let i = 0; i < decimalPart.length; i++) {
+    const d = parseInt(decimalPart[i], 10)
+    if (result) result += ' '
+    result += d === 0 ? ZERO : ONES[d]
+  }
+
+  return result
+}
+
+/**
+ * Converts a numeric value to Biblical Hebrew words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @param {Object} [options] - Optional configuration
+ * @param {('masculine'|'feminine')} [options.gender='masculine'] - Grammatical gender
+ * @param {string} [options.andWord] - Custom conjunction word
+ * @returns {string} The number in Biblical Hebrew words
+ */
+function toWords (value, options) {
+  options = validateOptions(options)
+  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+
+  let result = ''
 
-    return words.join(' ')
+  if (isNegative) {
+    result = NEGATIVE + ' '
   }
+
+  result += integerToWords(integerPart, options)
+
+  if (decimalPart) {
+    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart, options)
+  }
+
+  return result
 }
+
+// ============================================================================
+// Exports
+// ============================================================================
+
+export { toWords }

package/lib/languages/he.d.ts

@@ -1,80 +1,13 @@
 /**
- * Modern Hebrew language converter.
+ * Converts a numeric value to Modern Hebrew words.
  *
- * Supports:
- * - Right-to-left text orientation
- * - Feminine grammatical forms (default in Modern Hebrew)
- * - Three-form pluralization (singular/few/many)
- * - Optional "ve" (ו) conjunction via options
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @param {Object} [options] - Optional configuration
+ * @param {('masculine'|'feminine')} [options.gender='masculine'] - Grammatical gender
+ * @param {string} [options.andWord] - Custom conjunction word
+ * @returns {string} The number in Modern Hebrew words
  */
-export class Hebrew extends SlavicLanguage {
-    constructor(options?: {});
-    onesWords: {
-        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;
-    };
-    pluralForms: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    scale: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-    };
-    scalePlural: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-    };
-    /** Converts integer part to Hebrew words with special handling for thousands. */
-    integerToWords(integerPart: any): string;
-}
-import { SlavicLanguage } from '../classes/slavic-language.js';
+export function toWords(value: number | string | bigint, options?: {
+    gender?: "masculine" | "feminine" | undefined;
+    andWord?: string | undefined;
+}): string;