n2words 3.0.0 → 4.0.0

package/src/uk-UA.js

@@ -0,0 +1,463 @@
+/**
+ * Ukrainian (Ukraine) language converter
+ *
+ * CLDR: uk-UA | Ukrainian as used in Ukraine
+ *
+ * Key features:
+ * - Three-form pluralization (one/few/many)
+ * - Gender: thousands are feminine, millions+ are masculine
+ * - Irregular hundreds
+ * - Long scale naming
+ */
+
+import { parseCardinalValue } from './utils/parse-cardinal.js'
+import { parseCurrencyValue } from './utils/parse-currency.js'
+import { parseOrdinalValue } from './utils/parse-ordinal.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 = 'кома'
+
+// ============================================================================
+// Ordinal Vocabulary
+// ============================================================================
+
+// Ukrainian ordinals (masculine nominative singular)
+const ORDINAL_ONES = ['', 'перший', 'другий', 'третiй', 'четвертий', 'п\'ятий', 'шостий', 'сьомий', 'восьмий', 'дев\'ятий']
+
+// Teens ordinals
+const ORDINAL_TEENS = ['десятий', 'одинадцятий', 'дванадцятий', 'тринадцятий', 'чотирнадцятий', 'п\'ятнадцятий', 'шiстнадцятий', 'сiмнадцятий', 'вiсiмнадцятий', 'дев\'ятнадцятий']
+
+// Tens ordinals (for exact tens)
+const ORDINAL_TENS = ['', '', 'двадцятий', 'тридцятий', 'сороковий', 'п\'ятдесятий', 'шiстдесятий', 'сiмдесятий', 'вiсiмдесятий', 'дев\'яностий']
+
+// Hundreds ordinals (for exact hundreds)
+const ORDINAL_HUNDREDS = ['', 'сотий', 'двохсотий', 'трьохсотий', 'чотирьохсотий', 'п\'ятисотий', 'шестисотий', 'семисотий', 'восьмисотий', 'дев\'ятисотий']
+
+// Scale ordinals
+const ORDINAL_SCALES = ['тисячний', 'мiльйонний', 'мiльярдний', 'трильйонний']
+
+// ============================================================================
+// Currency Vocabulary (Ukrainian Hryvnia)
+// ============================================================================
+
+// Hryvnia forms: [singular, few (2-4), many (5+)]
+const HRYVNIA_FORMS = ['гривня', 'гривнi', 'гривень']
+// Kopiyka forms: [singular, few (2-4), many (5+)]
+const KOPIYKA_FORMS = ['копiйка', 'копiйки', 'копiйок']
+
+// 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.trunc(n / 10) % 10
+  const hundredsDigit = Math.trunc(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.trunc(n / 10) % 10
+  const hundredsDigit = Math.trunc(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_FEM[onesDigit])
+  }
+
+  return parts.join(' ')
+}
+
+// ============================================================================
+// Conversion Functions
+// ============================================================================
+
+function integerToWords (n, gender) {
+  if (n === 0n) return ZERO
+
+  if (n < 1000n) {
+    return gender === 'feminine' ? buildSegmentFem(Number(n)) : buildSegmentMasc(Number(n))
+  }
+
+  return buildLargeNumberWords(n, gender)
+}
+
+function buildLargeNumberWords (n, gender) {
+  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
+  }
+
+  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(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--
+  }
+
+  return parts.join(' ')
+}
+
+function decimalPartToWords (decimalPart, gender) {
+  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), gender)
+  }
+
+  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 toCardinal (value, options) {
+  options = validateOptions(options)
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
+
+  // Apply option defaults
+  const { gender = 'masculine' } = options
+
+  let result = ''
+
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  result += integerToWords(integerPart, gender)
+
+  if (decimalPart) {
+    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart, gender)
+  }
+
+  return result
+}
+
+// ============================================================================
+// ORDINAL: toOrdinal(value)
+// ============================================================================
+
+/**
+ * Builds ordinal for a 0-99 segment when it's the final (ordinal) part.
+ *
+ * @param {number} n - Number 0-99
+ * @returns {string} Ordinal words
+ */
+function buildOrdinalTensOnes (n) {
+  if (n === 0) return ''
+
+  const onesDigit = n % 10
+  const tensDigit = Math.trunc(n / 10)
+
+  if (tensDigit === 0) {
+    return ORDINAL_ONES[onesDigit]
+  }
+
+  if (tensDigit === 1) {
+    return ORDINAL_TEENS[onesDigit]
+  }
+
+  if (onesDigit === 0) {
+    return ORDINAL_TENS[tensDigit]
+  }
+
+  return TENS[tensDigit] + ' ' + ORDINAL_ONES[onesDigit]
+}
+
+/**
+ * Converts a positive integer to Ukrainian ordinal words (masculine nominative).
+ *
+ * @param {bigint} n - Positive integer to convert
+ * @returns {string} Ordinal Ukrainian words
+ */
+function integerToOrdinal (n) {
+  if (n < 100n) {
+    return buildOrdinalTensOnes(Number(n))
+  }
+
+  if (n < 1000n) {
+    const num = Number(n)
+    const hundredsDigit = Math.trunc(num / 100)
+    const remainder = num % 100
+
+    if (remainder === 0) {
+      return ORDINAL_HUNDREDS[hundredsDigit]
+    }
+
+    return HUNDREDS[hundredsDigit] + ' ' + buildOrdinalTensOnes(remainder)
+  }
+
+  if (n < 1_000_000n) {
+    const thousands = Number(n / 1000n)
+    const remainder = Number(n % 1000n)
+
+    if (remainder === 0) {
+      if (thousands === 1) {
+        return ORDINAL_SCALES[0]
+      }
+      return buildSegmentFem(thousands) + ' ' + ORDINAL_SCALES[0]
+    }
+
+    const scaleWord = pluralize(thousands, SCALE_FORMS[0])
+    const thousandsWord = buildSegmentFem(thousands)
+    return thousandsWord + ' ' + scaleWord + ' ' + integerToOrdinal(BigInt(remainder))
+  }
+
+  return buildLargeOrdinal(n)
+}
+
+/**
+ * Builds ordinal words for numbers >= 1,000,000.
+ *
+ * @param {bigint} n - Number >= 1,000,000
+ * @returns {string} Ordinal Ukrainian words
+ */
+function buildLargeOrdinal (n) {
+  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
+  }
+
+  let lastNonZeroIdx = segments.length - 1
+  while (lastNonZeroIdx >= 0 && segments[lastNonZeroIdx] === 0) {
+    lastNonZeroIdx--
+  }
+
+  const parts = []
+  let scaleIndex = segments.length - 1
+
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i]
+
+    if (segment !== 0) {
+      const isLastNonZero = (i === lastNonZeroIdx)
+
+      if (scaleIndex === 0) {
+        if (isLastNonZero) {
+          parts.push(integerToOrdinal(BigInt(segment)))
+        } else {
+          parts.push(buildSegmentMasc(segment))
+        }
+      } else {
+        if (isLastNonZero) {
+          if (segment === 1) {
+            parts.push(ORDINAL_SCALES[scaleIndex - 1])
+          } else {
+            const isFeminine = scaleIndex === 1
+            const segmentWord = isFeminine ? buildSegmentFem(segment) : buildSegmentMasc(segment)
+            parts.push(segmentWord + ' ' + ORDINAL_SCALES[scaleIndex - 1])
+          }
+        } else {
+          const scaleForms = SCALE_FORMS[scaleIndex - 1]
+          const scaleWord = pluralize(segment, scaleForms)
+          const isFeminine = scaleIndex === 1
+          const segmentWord = isFeminine ? buildSegmentFem(segment) : buildSegmentMasc(segment)
+          parts.push(segmentWord + ' ' + scaleWord)
+        }
+      }
+    }
+
+    scaleIndex--
+  }
+
+  return parts.join(' ')
+}
+
+/**
+ * Converts a numeric value to Ukrainian ordinal words (masculine nominative).
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (must be a positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'перший'
+ * toOrdinal(2)    // 'другий'
+ * toOrdinal(21)   // 'двадцять перший'
+ * toOrdinal(100)  // 'сотий'
+ * toOrdinal(1000) // 'тисячний'
+ */
+function toOrdinal (value) {
+  const integerPart = parseOrdinalValue(value)
+  return integerToOrdinal(integerPart)
+}
+
+// ============================================================================
+// CURRENCY: toCurrency(value)
+// ============================================================================
+
+/**
+ * Converts a numeric value to Ukrainian currency words (Hryvnia).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Ukrainian currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42)     // 'сорок двi гривнi'
+ * toCurrency(1)      // 'одна гривня'
+ * toCurrency(1.50)   // 'одна гривня п\'ятдесят копiйок'
+ * toCurrency(-5)     // 'мiнус п\'ять гривень'
+ */
+function toCurrency (value) {
+  const { isNegative, dollars: hryvnia, cents: kopiyky } = parseCurrencyValue(value)
+
+  let result = ''
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  // Hryvnia part (feminine)
+  if (hryvnia > 0n || kopiyky === 0n) {
+    result += integerToWords(hryvnia, 'feminine')
+    result += ' ' + pluralize(hryvnia, HRYVNIA_FORMS)
+  }
+
+  // Kopiyky part (feminine)
+  if (kopiyky > 0n) {
+    if (hryvnia > 0n) {
+      result += ' '
+    }
+    result += integerToWords(kopiyky, 'feminine')
+    result += ' ' + pluralize(kopiyky, KOPIYKA_FORMS)
+  }
+
+  return result
+}
+
+// ============================================================================
+// Exports
+// ============================================================================
+
+export { toCardinal, toOrdinal, toCurrency }

package/src/ur-PK.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Converts a numeric value to Urdu words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Urdu words
+ */
+export function toCardinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Urdu ordinal words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'پہلا'
+ * toOrdinal(2)    // 'دوسرا'
+ * toOrdinal(3)    // 'تیسرا'
+ * toOrdinal(10)   // 'دسواں'
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Urdu currency words (Pakistani Rupee).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Urdu currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42.50)  // 'بیالیس روپے پچاس پیسے'
+ * toCurrency(1)      // 'ایک روپیہ'
+ * toCurrency(0.01)   // 'ایک پیسہ'
+ */
+export function toCurrency(value: number | string | bigint): string;