n2words 3.1.0 → 4.0.0

package/{lib/languages/bn.js → src/bn-BD.js}

@@ -1,7 +1,7 @@
 /**
- * Bangla language converter - Functional Implementation
+ * Bangla (Bangladesh) language converter
  *
- * Self-contained module with its own input validation, ready for subpath exports.
+ * CLDR: bn-BD | Bengali as used in Bangladesh
  *
  * Key features:
  * - Indian numbering system (হাজার, লাখ, কোটি)
@@ -10,7 +10,9 @@
  * - Complete word forms for 0-99
  */
 
-import { parseNumericValue } from '../utils/parse-numeric.js'
+import { parseCardinalValue } from './utils/parse-cardinal.js'
+import { parseCurrencyValue } from './utils/parse-currency.js'
+import { parseOrdinalValue } from './utils/parse-ordinal.js'
 
 // ============================================================================
 // Vocabulary
@@ -21,6 +23,26 @@ const NEGATIVE = 'মাইনাস'
 const DECIMAL_SEP = 'দশমিক'
 const HUNDRED = 'শত'
 
+// ============================================================================
+// Ordinal Vocabulary
+// ============================================================================
+
+// Ordinal suffix (adds to cardinal for numbers >= 7)
+const ORDINAL_SUFFIX = 'তম'
+
+// Special ordinals for first few numbers (1-6 have irregular forms)
+const ORDINAL_SPECIAL = ['', 'প্রথম', 'দ্বিতীয়', 'তৃতীয়', 'চতুর্থ', 'পঞ্চম', 'ষষ্ঠ']
+
+// ============================================================================
+// Currency Vocabulary (Bangladeshi Taka)
+// ============================================================================
+
+// Taka: singular/plural (same form used in Bengali)
+const TAKA = 'টাকা'
+
+// Paisa: singular/plural (same form used in Bengali)
+const PAISA = 'পয়সা'
+
 const BELOW_HUNDRED = [
   'শূন্য', 'এক', 'দুই', 'তিন', 'চার', 'পাঁচ', 'ছয়', 'সাত', 'আট', 'নয়',
   'দশ', 'এগারো', 'বারো', 'তেরো', 'চৌদ্দ', 'পনেরো', 'ষোল', 'সতেরো', 'আঠারো', 'উনিশ',
@@ -141,8 +163,8 @@ function decimalPartToWords (decimalPart) {
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Bengali words
  */
-function toWords (value) {
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+function toCardinal (value) {
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
 
   let result = ''
 
@@ -159,8 +181,90 @@ function toWords (value) {
   return result
 }
 
+// ============================================================================
+// ORDINAL: toOrdinal(value)
+// ============================================================================
+
+/**
+ * Converts a positive integer to Bengali ordinal words.
+ *
+ * Bengali ordinals: First 6 are irregular, then add -তম suffix.
+ *
+ * @param {bigint} n - Positive integer to convert
+ * @returns {string} Bengali ordinal words
+ */
+function integerToOrdinal (n) {
+  // Special ordinals for 1-6
+  if (n >= 1n && n <= 6n) {
+    return ORDINAL_SPECIAL[Number(n)]
+  }
+
+  // For 7 and above, add suffix to cardinal
+  const cardinal = integerToWords(n)
+  return cardinal + ORDINAL_SUFFIX
+}
+
+/**
+ * Converts a numeric value to Bengali 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)   // 'দশতম'
+ */
+function toOrdinal (value) {
+  const integerPart = parseOrdinalValue(value)
+  return integerToOrdinal(integerPart)
+}
+
+// ============================================================================
+// CURRENCY: toCurrency(value, options?)
+// ============================================================================
+
+/**
+ * Converts a numeric value to Bengali currency words (Bangladeshi Taka).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Bengali 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)   // 'এক পয়সা'
+ */
+function toCurrency (value) {
+  const { isNegative, dollars: taka, cents: paisa } = parseCurrencyValue(value)
+
+  // Build result
+  let result = ''
+  if (isNegative) result = NEGATIVE + ' '
+
+  // Taka part - show if non-zero, or if no paisa
+  if (taka > 0n || paisa === 0n) {
+    result += integerToWords(taka) + ' ' + TAKA
+  }
+
+  // Paisa part
+  if (paisa > 0n) {
+    if (taka > 0n) {
+      result += ' '
+    }
+    result += integerToWords(paisa) + ' ' + PAISA
+  }
+
+  return result
+}
+
 // ============================================================================
 // Exports
 // ============================================================================
 
-export { toWords }
+export { toCardinal, toOrdinal, toCurrency }

package/src/cs-CZ.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Converts a numeric value to Czech 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
+ * @returns {string} The number in Czech words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCardinal(21)           // 'dvacet jedna'
+ * toCardinal(1000)         // 'tisíc'
+ * toCardinal(2000)         // 'dva tisíce'
+ * toCardinal(5000)         // 'pět tisíc'
+ */
+export function toCardinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Czech 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)    // 'první'
+ * toOrdinal(2)    // 'druhý'
+ * toOrdinal(21)   // 'dvacet první'
+ * toOrdinal(100)  // 'stý'
+ * toOrdinal(1000) // 'tisící'
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Czech currency words (Koruna).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Czech 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)     // 'čtyřicet dva koruny'
+ * toCurrency(1)      // 'jedna koruna'
+ * toCurrency(1.50)   // 'jedna koruna padesát haléřů'
+ * toCurrency(-5)     // 'mínus pět korun'
+ */
+export function toCurrency(value: number | string | bigint): string;

package/{lib/languages/cs.js → src/cs-CZ.js}

@@ -1,7 +1,7 @@
 /**
- * Czech language converter - Functional Implementation
+ * Czech (Czechia) language converter
  *
- * Self-contained module with its own input validation, ready for subpath exports.
+ * CLDR: cs-CZ | Czech as used in Czechia
  *
  * Czech-specific rules:
  * - Three-form pluralization: 1 = singular, 2-4 = few, 5+ = many
@@ -11,7 +11,9 @@
  * - Dynamic decimal separator: celá/celé/celých based on integer
  */
 
-import { parseNumericValue } from '../utils/parse-numeric.js'
+import { parseCardinalValue } from './utils/parse-cardinal.js'
+import { parseCurrencyValue } from './utils/parse-currency.js'
+import { parseOrdinalValue } from './utils/parse-ordinal.js'
 
 // ============================================================================
 // Vocabulary (module-level constants)
@@ -45,6 +47,34 @@ const PLURAL_FORMS = {
 const ZERO = 'nula'
 const NEGATIVE = 'mínus'
 
+// ============================================================================
+// Ordinal Vocabulary
+// ============================================================================
+
+// Czech ordinals (masculine nominative singular)
+const ORDINAL_ONES = ['', 'první', 'druhý', 'třetí', 'čtvrtý', 'pátý', 'šestý', 'sedmý', 'osmý', 'devátý']
+
+// Ordinal teens
+const ORDINAL_TEENS = ['desátý', 'jedenáctý', 'dvanáctý', 'třináctý', 'čtrnáctý', 'patnáctý', 'šestnáctý', 'sedmnáctý', 'osmnáctý', 'devatenáctý']
+
+// Ordinal tens (for exact tens)
+const ORDINAL_TENS = ['', '', 'dvacátý', 'třicátý', 'čtyřicátý', 'padesátý', 'šedesátý', 'sedmdesátý', 'osmdesátý', 'devadesátý']
+
+// Ordinal hundreds (for exact hundreds)
+const ORDINAL_HUNDREDS = ['', 'stý', 'dvoustý', 'třístý', 'čtyřstý', 'pětistý', 'šestistý', 'sedmistý', 'osmistý', 'devítistý']
+
+// Scale ordinals
+const ORDINAL_SCALES = ['tisící', 'miliontý', 'miliardtý', 'biliontý']
+
+// ============================================================================
+// Currency Vocabulary (Czech Koruna)
+// ============================================================================
+
+// Koruna forms: [singular, few (2-4), many (5+)]
+const KORUNA_FORMS = ['koruna', 'koruny', 'korun']
+// Haléř forms: [singular, few (2-4), many (5+)]
+const HALER_FORMS = ['haléř', 'haléře', 'haléřů']
+
 // ============================================================================
 // Segment Building
 // ============================================================================
@@ -56,8 +86,8 @@ 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 tens = Math.trunc(n / 10) % 10
+  const hundreds = Math.trunc(n / 100)
 
   const parts = []
 
@@ -90,8 +120,8 @@ function buildSegmentWithHundreds (n) {
   if (n === 0) return ''
 
   const ones = n % 10
-  const tens = Math.floor(n / 10) % 10
-  const hundreds = Math.floor(n / 100)
+  const tens = Math.trunc(n / 10) % 10
+  const hundreds = Math.trunc(n / 100)
 
   const parts = []
 
@@ -291,13 +321,13 @@ function decimalPartToWords (decimalPart) {
  * @throws {Error} If value is not a valid number format
  *
  * @example
- * toWords(21)           // 'dvacet jedna'
- * toWords(1000)         // 'tisíc'
- * toWords(2000)         // 'dva tisíce'
- * toWords(5000)         // 'pět tisíc'
+ * toCardinal(21)           // 'dvacet jedna'
+ * toCardinal(1000)         // 'tisíc'
+ * toCardinal(2000)         // 'dva tisíce'
+ * toCardinal(5000)         // 'pět tisíc'
  */
-function toWords (value) {
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+function toCardinal (value) {
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
 
   let result = ''
 
@@ -315,8 +345,204 @@ function toWords (value) {
   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 Czech ordinal words (masculine nominative).
+ *
+ * @param {bigint} n - Positive integer to convert
+ * @returns {string} Ordinal Czech 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 buildSegment(thousands) + ' ' + ORDINAL_SCALES[0]
+    }
+
+    const scaleWord = pluralize(BigInt(thousands), PLURAL_FORMS[1])
+    const thousandsWord = thousands === 1 ? '' : buildSegment(thousands) + ' '
+    return (thousands === 1 ? 'tisíc' : 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 Czech words
+ */
+function buildLargeOrdinal (n) {
+  const segmentValues = []
+  let temp = n
+  while (temp > 0n) {
+    segmentValues.push(temp % 1000n)
+    temp = temp / 1000n
+  }
+
+  let lastNonZeroIdx = 0
+  for (let i = 0; i < segmentValues.length; i++) {
+    if (segmentValues[i] !== 0n) {
+      lastNonZeroIdx = i
+    }
+  }
+
+  const parts = []
+
+  for (let i = segmentValues.length - 1; i >= 0; i--) {
+    const segment = segmentValues[i]
+    if (segment === 0n) continue
+
+    const isLastNonZero = (i === lastNonZeroIdx)
+
+    if (i === 0) {
+      if (isLastNonZero) {
+        parts.push(integerToOrdinal(segment))
+      } else {
+        parts.push(buildSegmentWithHundreds(Number(segment)))
+      }
+    } else {
+      if (isLastNonZero) {
+        if (segment === 1n) {
+          parts.push(ORDINAL_SCALES[i - 1] || PLURAL_FORMS[i][0])
+        } else {
+          parts.push(buildSegment(Number(segment)) + ' ' + (ORDINAL_SCALES[i - 1] || PLURAL_FORMS[i][0]))
+        }
+      } else {
+        const forms = PLURAL_FORMS[i]
+        if (forms) {
+          const scaleWord = pluralize(segment, forms)
+          if (segment === 1n) {
+            parts.push(scaleWord)
+          } else {
+            parts.push(buildSegment(Number(segment)) + ' ' + scaleWord)
+          }
+        }
+      }
+    }
+  }
+
+  return parts.join(' ')
+}
+
+/**
+ * Converts a numeric value to Czech 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)    // 'první'
+ * toOrdinal(2)    // 'druhý'
+ * toOrdinal(21)   // 'dvacet první'
+ * toOrdinal(100)  // 'stý'
+ * toOrdinal(1000) // 'tisící'
+ */
+function toOrdinal (value) {
+  const integerPart = parseOrdinalValue(value)
+  return integerToOrdinal(integerPart)
+}
+
+// ============================================================================
+// CURRENCY: toCurrency(value)
+// ============================================================================
+
+/**
+ * Converts a numeric value to Czech currency words (Koruna).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Czech 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)     // 'čtyřicet dva koruny'
+ * toCurrency(1)      // 'jedna koruna'
+ * toCurrency(1.50)   // 'jedna koruna padesát haléřů'
+ * toCurrency(-5)     // 'mínus pět korun'
+ */
+function toCurrency (value) {
+  const { isNegative, dollars: koruny, cents: halere } = parseCurrencyValue(value)
+
+  let result = ''
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  // Koruna part
+  if (koruny > 0n || halere === 0n) {
+    result += integerToWords(koruny)
+    result += ' ' + pluralize(koruny, KORUNA_FORMS)
+  }
+
+  // Haléř part
+  if (halere > 0n) {
+    if (koruny > 0n) {
+      result += ' '
+    }
+    result += integerToWords(halere)
+    result += ' ' + pluralize(halere, HALER_FORMS)
+  }
+
+  return result
+}
+
 // ============================================================================
 // Public API
 // ============================================================================
 
-export { toWords }
+export { toCardinal, toOrdinal, toCurrency }

package/src/da-DK.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Converts a numeric value to Danish words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Danish words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCardinal(21)       // 'enogtyve'
+ * toCardinal(1000)     // 'ettusind'
+ * toCardinal(1000000)  // 'en millioner'
+ */
+export function toCardinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Danish 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)    // 'første'
+ * toOrdinal(2)    // 'anden'
+ * toOrdinal(21)   // 'enogtyvede'
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Danish currency words (Danish Krone).
+ *
+ * Uses krone/kroner and øre (100 øre = 1 krone).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Danish currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(1)      // 'en krone'
+ * toCurrency(42)     // 'toogfyrre kroner'
+ * toCurrency(1.50)   // 'en krone og halvtreds øre'
+ */
+export function toCurrency(value: number | string | bigint): string;