n2words 2.0.0 → 3.1.0

package/lib/languages/uk.js

@@ -1,96 +1,224 @@
-import { SlavicLanguage } from '../classes/slavic-language.js'
-
 /**
- * Ukrainian language converter.
+ * Ukrainian language converter - Functional Implementation
+ *
+ * Self-contained module with its own input validation, ready for subpath exports.
  *
- * Supports:
+ * Key features:
  * - Three-form pluralization (one/few/many)
- * - Gender agreement (один/одна, два/дві)
- * - Ukrainian orthography and phonology
+ * - Gender: thousands are feminine, millions+ are masculine
+ * - Irregular hundreds
+ * - Long scale naming
  */
-export class Ukrainian extends SlavicLanguage {
-  negativeWord = 'мiнус'
-  decimalSeparatorWord = 'кома'
-  zeroWord = 'нуль'
-
-  onesWords = {
-    1: 'один',
-    2: 'два',
-    3: 'три',
-    4: 'чотири',
-    5: 'п\'ять',
-    6: 'шiсть',
-    7: 'сiм',
-    8: 'вiсiм',
-    9: 'дев\'ять'
+
+import { parseNumericValue } from '../utils/parse-numeric.js'
+import { validateOptions } from '../utils/validate-options.js'
+
+// ============================================================================
+// Vocabulary
+// ============================================================================
+
+const ONES_MASC = ['', 'один', 'два', 'три', 'чотири', 'п\'ять', 'шiсть', 'сiм', 'вiсiм', 'дев\'ять']
+const ONES_FEM = ['', 'одна', 'двi', 'три', 'чотири', 'п\'ять', 'шiсть', 'сiм', 'вiсiм', 'дев\'ять']
+
+const TEENS = ['десять', 'одинадцять', 'дванадцять', 'тринадцять', 'чотирнадцять', 'п\'ятнадцять', 'шiстнадцять', 'сiмнадцять', 'вiсiмнадцять', 'дев\'ятнадцять']
+const TENS = ['', '', 'двадцять', 'тридцять', 'сорок', 'п\'ятдесят', 'шiстдесят', 'сiмдесят', 'вiсiмдесят', 'дев\'яносто']
+
+// Irregular hundreds
+const HUNDREDS = ['', 'сто', 'двiстi', 'триста', 'чотириста', 'п\'ятсот', 'шiстсот', 'сiмсот', 'вiсiмсот', 'дев\'ятсот']
+
+const ZERO = 'нуль'
+const NEGATIVE = 'мiнус'
+const DECIMAL_SEP = 'кома'
+
+// Scale words: [singular, few, many]
+// Thousands (index 0) are feminine, rest are masculine
+const SCALE_FORMS = [
+  ['тисяча', 'тисячi', 'тисяч'],
+  ['мiльйон', 'мiльйони', 'мiльйонiв'],
+  ['мiльярд', 'мiльярди', 'мiльярдiв'],
+  ['трильйон', 'трильйони', 'трильйонiв'],
+  ['квадрильйон', 'квадрильйони', 'квадрильйонiв'],
+  ['квiнтильйон', 'квiнтильйони', 'квiнтильйонiв'],
+  ['секстильйон', 'секстильйони', 'секстильйонiв'],
+  ['септильйон', 'септильйони', 'септильйонiв'],
+  ['октильйон', 'октильйони', 'октильйонiв']
+]
+
+// ============================================================================
+// Segment Building
+// ============================================================================
+
+function pluralize (n, forms) {
+  const num = typeof n === 'bigint' ? Number(n) : n
+  const lastDigit = num % 10
+  const lastTwoDigits = num % 100
+
+  if (lastTwoDigits >= 11 && lastTwoDigits <= 19) {
+    return forms[2]
+  }
+
+  if (lastDigit === 1) return forms[0]
+  if (lastDigit >= 2 && lastDigit <= 4) return forms[1]
+  return forms[2]
+}
+
+function buildSegmentMasc (n) {
+  if (n === 0) return ''
+
+  const onesDigit = n % 10
+  const tensDigit = Math.floor(n / 10) % 10
+  const hundredsDigit = Math.floor(n / 100)
+
+  const parts = []
+
+  if (hundredsDigit > 0) {
+    parts.push(HUNDREDS[hundredsDigit])
+  }
+
+  if (tensDigit > 1) {
+    parts.push(TENS[tensDigit])
+  }
+
+  if (tensDigit === 1) {
+    parts.push(TEENS[onesDigit])
+  } else if (onesDigit > 0) {
+    parts.push(ONES_MASC[onesDigit])
+  }
+
+  return parts.join(' ')
+}
+
+function buildSegmentFem (n) {
+  if (n === 0) return ''
+
+  const onesDigit = n % 10
+  const tensDigit = Math.floor(n / 10) % 10
+  const hundredsDigit = Math.floor(n / 100)
+
+  const parts = []
+
+  if (hundredsDigit > 0) {
+    parts.push(HUNDREDS[hundredsDigit])
+  }
+
+  if (tensDigit > 1) {
+    parts.push(TENS[tensDigit])
   }
 
-  onesFeminineWords = {
-    1: 'одна',
-    2: 'двi',
-    3: 'три',
-    4: 'чотири',
-    5: 'п\'ять',
-    6: 'шiсть',
-    7: 'сiм',
-    8: 'вiсiм',
-    9: 'дев\'ять'
+  if (tensDigit === 1) {
+    parts.push(TEENS[onesDigit])
+  } else if (onesDigit > 0) {
+    parts.push(ONES_FEM[onesDigit])
   }
 
-  teensWords = {
-    0: 'десять',
-    1: 'одинадцять',
-    2: 'дванадцять',
-    3: 'тринадцять',
-    4: 'чотирнадцять',
-    5: 'п\'ятнадцять',
-    6: 'шiстнадцять',
-    7: 'сiмнадцять',
-    8: 'вiсiмнадцять',
-    9: 'дев\'ятнадцять'
+  return parts.join(' ')
+}
+
+// ============================================================================
+// Conversion Functions
+// ============================================================================
+
+function integerToWords (n, options = {}) {
+  if (n === 0n) return ZERO
+
+  if (n < 1000n) {
+    return options.gender === 'feminine' ? buildSegmentFem(Number(n)) : buildSegmentMasc(Number(n))
   }
 
-  twentiesWords = {
-    2: 'двадцять',
-    3: 'тридцять',
-    4: 'сорок',
-    5: 'п\'ятдесят',
-    6: 'шiстдесят',
-    7: 'сiмдесят',
-    8: 'вiсiмдесят',
-    9: 'дев\'яносто'
+  return buildLargeNumberWords(n, options)
+}
+
+function buildLargeNumberWords (n, options) {
+  const numStr = n.toString()
+  const len = numStr.length
+
+  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
   }
 
-  hundredsWords = {
-    1: 'сто',
-    2: 'двiстi',
-    3: 'триста',
-    4: 'чотириста',
-    5: 'п\'ятсот',
-    6: 'шiстсот',
-    7: 'сiмсот',
-    8: 'вiсiмсот',
-    9: 'дев\'ятсот'
+  const parts = []
+  let scaleIndex = segments.length - 1
+
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i]
+
+    if (segment !== 0) {
+      if (scaleIndex === 0) {
+        parts.push(options.gender === 'feminine' ? buildSegmentFem(segment) : buildSegmentMasc(segment))
+      } else {
+        const scaleForms = SCALE_FORMS[scaleIndex - 1]
+        const scaleWord = pluralize(segment, scaleForms)
+        // Thousands (scaleIndex=1) are feminine, others masculine
+        const isFeminine = scaleIndex === 1
+        const segmentWord = isFeminine ? buildSegmentFem(segment) : buildSegmentMasc(segment)
+        parts.push(segmentWord + ' ' + scaleWord)
+      }
+    }
+
+    scaleIndex--
   }
 
-  pluralForms = {
-    1: ['тисяча', 'тисячi', 'тисяч'], // 10^ 3
-    2: ['мiльйон', 'мiльйони', 'мiльйонiв'], // 10^ 6
-    3: ['мiльярд', 'мiльярди', 'мiльярдiв'], // 10^ 9
-    4: ['трильйон', 'трильйони', 'трильйонiв'], // 10^ 12
-    5: ['квадрильйон', 'квадрильйони', 'квадрильйонiв'], // 10^ 15
-    6: ['квiнтильйон', 'квiнтильйони', 'квiнтильйонiв'], // 10^ 18
-    7: ['секстильйон', 'секстильйони', 'секстильйонiв'], // 10^ 21
-    8: ['септильйон', 'септильйони', 'септильйонiв'], // 10^ 24
-    9: ['октильйон', 'октильйони', 'октильйонiв'], // 10^ 27
-    10: ['нонiльйон', 'нонiльйони', 'нонiльйонiв'] // 10^ 30
+  return parts.join(' ')
+}
+
+function decimalPartToWords (decimalPart, options) {
+  let result = ''
+  let i = 0
+
+  while (i < decimalPart.length && decimalPart[i] === '0') {
+    if (result) result += ' '
+    result += ZERO
+    i++
   }
 
-  /**
-   * Ukrainian thousands (тисяча) are feminine, requiring одна/двi forms.
-   * Other scales (million, billion, etc.) are masculine.
-   */
-  scaleGenders = {
-    1: true // thousands are feminine
+  const remainder = decimalPart.slice(i)
+  if (remainder) {
+    if (result) result += ' '
+    result += integerToWords(BigInt(remainder), options)
   }
+
+  return result
 }
+
+/**
+ * Converts a numeric value to Ukrainian words.
+ *
+ * @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 Ukrainian words
+ */
+function toWords (value, options) {
+  options = validateOptions(options)
+  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+
+  let result = ''
+
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  result += integerToWords(integerPart, options)
+
+  if (decimalPart) {
+    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart, options)
+  }
+
+  return result
+}
+
+// ============================================================================
+// Exports
+// ============================================================================
+
+export { toWords }

package/lib/languages/ur.d.ts

@@ -1,11 +1,7 @@
 /**
- * Urdu language converter.
+ * Converts a numeric value to Urdu words.
  *
- * Supports:
- * - Indian numbering system (ہزار, لاکھ, کروڑ)
- * - Urdu script (right-to-left)
- * - Complete word forms for 0-99
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Urdu words
  */
-export class Urdu extends SouthAsianLanguage {
-}
-import { SouthAsianLanguage } from '../classes/south-asian-language.js';
+export function toWords(value: number | string | bigint): string;

package/lib/languages/ur.js

@@ -1,131 +1,158 @@
-import { SouthAsianLanguage } from '../classes/south-asian-language.js'
-
 /**
- * Urdu language converter.
+ * Urdu language converter - Functional Implementation
+ *
+ * Self-contained module with its own input validation, ready for subpath exports.
  *
- * Supports:
+ * Key features:
  * - Indian numbering system (ہزار, لاکھ, کروڑ)
  * - Urdu script (right-to-left)
+ * - 3-2-2 grouping pattern (last 3 digits, then groups of 2)
  * - Complete word forms for 0-99
  */
-export class Urdu extends SouthAsianLanguage {
-  negativeWord = 'منفی'
-  decimalSeparatorWord = 'اعشاریہ'
-  zeroWord = 'صفر'
-  hundredWord = 'سو'
-
-  belowHundredWords = [
-    'صفر',
-    'ایک',
-    'دو',
-    'تین',
-    'چار',
-    'پانچ',
-    'چھ',
-    'سات',
-    'آٹھ',
-    'نو',
-    'دس',
-    'گیارہ',
-    'بارہ',
-    'تیرہ',
-    'چودہ',
-    'پندرہ',
-    'سولہ',
-    'سترہ',
-    'اٹھارہ',
-    'انیس',
-    'بیس',
-    'اکیس',
-    'بائیس',
-    'تیئیس',
-    'چوبیس',
-    'پچیس',
-    'چھبیس',
-    'ستائیس',
-    'اٹھائیس',
-    'انتیس',
-    'تیس',
-    'اکتیس',
-    'بتیس',
-    'تینتیس',
-    'چونتیس',
-    'پینتیس',
-    'چھتیس',
-    'سینتیس',
-    'اڑتیس',
-    'انتالیس',
-    'چالیس',
-    'اکتالیس',
-    'بیالیس',
-    'تینتالیس',
-    'چوالیس',
-    'پینتالیس',
-    'چھالیس',
-    'سینتالیس',
-    'اڑتالیس',
-    'انچاس',
-    'پچاس',
-    'اکاون',
-    'باون',
-    'ترپن',
-    'چون',
-    'پچپن',
-    'چھپن',
-    'ستاون',
-    'اٹھاون',
-    'انسٹھ',
-    'ساٹھ',
-    'اکسٹھ',
-    'باسٹھ',
-    'ترسٹھ',
-    'چونسٹھ',
-    'پینسٹھ',
-    'چھیاسٹھ',
-    'سڑسٹھ',
-    'اڑسٹھ',
-    'انہتر',
-    'ستر',
-    'اکہتر',
-    'بہتر',
-    'تہتر',
-    'چوہتر',
-    'پچھتر',
-    'چھہتر',
-    'ستتر',
-    'اٹھہتر',
-    'اناسی',
-    'اسی',
-    'اکیاسی',
-    'بیاسی',
-    'تریاسی',
-    'چوراسی',
-    'پچاسی',
-    'چھیاسی',
-    'ستاسی',
-    'اٹھاسی',
-    'نواسی',
-    'نوے',
-    'اکانوے',
-    'بانوے',
-    'ترانوے',
-    'چورانوے',
-    'پچانوے',
-    'چھیانوے',
-    'ستانوے',
-    'اٹھانوے',
-    'ننانوے'
-  ]
-
-  scaleWords = [
-    '',
-    'ہزار',
-    'لاکھ',
-    'کروڑ',
-    'ارب',
-    'کھرب',
-    'نیل',
-    'پدم',
-    'شنکھ'
-  ]
+
+import { parseNumericValue } from '../utils/parse-numeric.js'
+
+// ============================================================================
+// Vocabulary
+// ============================================================================
+
+const ZERO = 'صفر'
+const NEGATIVE = 'منفی'
+const DECIMAL_SEP = 'اعشاریہ'
+const HUNDRED = 'سو'
+
+const BELOW_HUNDRED = [
+  'صفر', 'ایک', 'دو', 'تین', 'چار', 'پانچ', 'چھ', 'سات', 'آٹھ', 'نو',
+  'دس', 'گیارہ', 'بارہ', 'تیرہ', 'چودہ', 'پندرہ', 'سولہ', 'سترہ', 'اٹھارہ', 'انیس',
+  'بیس', 'اکیس', 'بائیس', 'تیئیس', 'چوبیس', 'پچیس', 'چھبیس', 'ستائیس', 'اٹھائیس', 'انتیس',
+  'تیس', 'اکتیس', 'بتیس', 'تینتیس', 'چونتیس', 'پینتیس', 'چھتیس', 'سینتیس', 'اڑتیس', 'انتالیس',
+  'چالیس', 'اکتالیس', 'بیالیس', 'تینتالیس', 'چوالیس', 'پینتالیس', 'چھالیس', 'سینتالیس', 'اڑتالیس', 'انچاس',
+  'پچاس', 'اکاون', 'باون', 'ترپن', 'چون', 'پچپن', 'چھپن', 'ستاون', 'اٹھاون', 'انسٹھ',
+  'ساٹھ', 'اکسٹھ', 'باسٹھ', 'ترسٹھ', 'چونسٹھ', 'پینسٹھ', 'چھیاسٹھ', 'سڑسٹھ', 'اڑسٹھ', 'انہتر',
+  'ستر', 'اکہتر', 'بہتر', 'تہتر', 'چوہتر', 'پچھتر', 'چھہتر', 'ستتر', 'اٹھہتر', 'اناسی',
+  'اسی', 'اکیاسی', 'بیاسی', 'تریاسی', 'چوراسی', 'پچاسی', 'چھیاسی', 'ستاسی', 'اٹھاسی', 'نواسی',
+  'نوے', 'اکانوے', 'بانوے', 'ترانوے', 'چورانوے', 'پچانوے', 'چھیانوے', 'ستانوے', 'اٹھانوے', 'ننانوے'
+]
+
+// Scale words: index 0 = units (empty), 1 = thousand, 2 = lakh, 3 = crore, etc.
+const SCALE_WORDS = ['', 'ہزار', 'لاکھ', 'کروڑ', 'ارب', 'کھرب', 'نیل', 'پدم', 'شنکھ']
+
+// ============================================================================
+// Segment Building
+// ============================================================================
+
+/**
+ * Builds words for a 0-999 segment.
+ */
+function buildSegment (n) {
+  if (n === 0) return ''
+  if (n < 100) return BELOW_HUNDRED[n]
+
+  const hundreds = Math.trunc(n / 100)
+  const remainder = n % 100
+
+  if (remainder === 0) {
+    return BELOW_HUNDRED[hundreds] + ' ' + HUNDRED
+  }
+  return BELOW_HUNDRED[hundreds] + ' ' + HUNDRED + ' ' + BELOW_HUNDRED[remainder]
+}
+
+// ============================================================================
+// Conversion Functions
+// ============================================================================
+
+/**
+ * Converts a non-negative integer to Urdu words.
+ *
+ * Uses BigInt modulo for segment extraction (faster than string slicing).
+ * South Asian 3-2-2 grouping: first 3 digits, then groups of 2.
+ *
+ * @param {bigint} n - Non-negative integer to convert
+ * @returns {string} Urdu words
+ */
+function integerToWords (n) {
+  if (n === 0n) return ZERO
+
+  // Fast path: numbers < 1000 (direct lookup)
+  if (n < 1000n) {
+    return buildSegment(Number(n))
+  }
+
+  // Extract segments using BigInt modulo
+  const segments = []
+  segments.push(Number(n % 1000n))
+  let temp = n / 1000n
+
+  while (temp > 0n) {
+    segments.push(Number(temp % 100n))
+    temp = temp / 100n
+  }
+
+  // Build result string (process from most-significant to least)
+  const words = []
+  for (let i = segments.length - 1; i >= 0; i--) {
+    const segment = segments[i]
+    if (segment === 0) continue
+
+    if (i === 0) {
+      words.push(buildSegment(segment))
+    } else {
+      words.push(BELOW_HUNDRED[segment])
+    }
+
+    if (i > 0 && SCALE_WORDS[i]) {
+      words.push(SCALE_WORDS[i])
+    }
+  }
+
+  return words.join(' ')
+}
+
+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 numeric value to Urdu words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Urdu words
+ */
+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 }