n2words 3.0.0 → 4.0.0

package/{lib/languages/nl.js → src/nl-NL.js}

@@ -1,13 +1,9 @@
 /**
- * Dutch language converter - Functional Implementation
+ * Dutch (Netherlands) language converter
  *
- * A performance-optimized number-to-words converter using precomputed lookup tables.
- * Self-contained module with its own input validation, ready for subpath exports.
+ * CLDR: nl-NL | Dutch as used in the Netherlands
  *
- * Key optimization: Precompute all segment values (0-999) at module load.
- * This eliminates all per-call string manipulation for segment conversion.
- *
- * Dutch-specific rules (handled in precomputation):
+ * Dutch-specific rules:
  * - Inverted tens-ones: eenentwintig (one-and-twenty)
  * - "ën" connector when ones ends in 'e' (twee, drie)
  * - Compound words without spaces
@@ -17,8 +13,10 @@
  * - Long scale with -ard forms
  */
 
-import { parseNumericValue } from '../utils/parse-numeric.js'
-import { validateOptions } from '../utils/validate-options.js'
+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 (module-level constants)
@@ -37,8 +35,14 @@ const ZERO = 'nul'
 const NEGATIVE = 'min'
 const DECIMAL_SEP = 'komma'
 
+// Currency vocabulary (Euro)
+const EURO = 'euro'
+const EUROS = 'euro' // Euro doesn't pluralize in Dutch
+const CENT = 'cent'
+const CENTEN = 'cent' // Cent doesn't pluralize in written currency
+
 // ============================================================================
-// Precomputed Lookup Tables (built once at module load)
+// Segment Building
 // ============================================================================
 
 /**
@@ -51,8 +55,8 @@ function buildSegment (n, withAnd) {
   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 tensOnes = n % 100
 
   let result = ''
@@ -98,18 +102,6 @@ function buildSegment (n, withAnd) {
   return result
 }
 
-// Precompute all 1000 segment words (0-999) - standard form
-const SEGMENTS = new Array(1000)
-for (let i = 0; i < 1000; i++) {
-  SEGMENTS[i] = buildSegment(i, false)
-}
-
-// Precompute all 1000 segment words (0-999) - with optional "en"
-const SEGMENTS_WITH_AND = new Array(1000)
-for (let i = 0; i < 1000; i++) {
-  SEGMENTS_WITH_AND[i] = buildSegment(i, true)
-}
-
 // ============================================================================
 // Conversion Functions
 // ============================================================================
@@ -125,7 +117,6 @@ function integerToWords (n, options) {
   if (n === 0n) return ZERO
 
   const { accentOne, includeOptionalAnd, noHundredPairing } = options
-  const segments = includeOptionalAnd ? SEGMENTS_WITH_AND : SEGMENTS
 
   // Apply één/een replacement
   const applyAccent = (word) => {
@@ -135,9 +126,9 @@ function integerToWords (n, options) {
     return word
   }
 
-  // Fast path: numbers < 1000 (direct lookup)
+  // Fast path: numbers < 1000
   if (n < 1000n) {
-    return applyAccent(segments[Number(n)])
+    return applyAccent(buildSegment(Number(n), includeOptionalAnd))
   }
 
   // Hundred pairing for 1100-9999
@@ -147,9 +138,9 @@ function integerToWords (n, options) {
 
     // Only use pairing when high is not a multiple of 10
     if (high % 10 !== 0) {
-      let result = segments[high] + HUNDRED
+      let result = buildSegment(high, includeOptionalAnd) + HUNDRED
       if (low > 0) {
-        const lowWord = segments[low]
+        const lowWord = buildSegment(low, includeOptionalAnd)
         if (includeOptionalAnd && low < 13) {
           result += ' en ' + lowWord
         } else {
@@ -171,11 +162,11 @@ function integerToWords (n, options) {
       result = SCALES[0]
     } else {
       // Compound: "vijfduizend"
-      result = segments[thousands] + SCALES[0]
+      result = buildSegment(thousands, includeOptionalAnd) + SCALES[0]
     }
 
     if (remainder > 0) {
-      const remainderWord = segments[remainder]
+      const remainderWord = buildSegment(remainder, includeOptionalAnd)
       if (includeOptionalAnd && remainder < 13) {
         result += ' en ' + remainderWord
       } else {
@@ -200,7 +191,6 @@ function integerToWords (n, options) {
  */
 function buildLargeNumberWords (n, options) {
   const { includeOptionalAnd } = options
-  const segmentLookup = includeOptionalAnd ? SEGMENTS_WITH_AND : SEGMENTS
 
   // Extract segments using BigInt division (faster than string slicing)
   // Segments stored least-significant first (index 0 = ones, 1 = thousands, etc.)
@@ -221,7 +211,7 @@ function buildLargeNumberWords (n, options) {
 
     if (i === 0) {
       // Units segment
-      const word = segmentLookup[segment]
+      const word = buildSegment(segment, includeOptionalAnd)
       if (result) {
         if (prevWasScale && includeOptionalAnd && segment < 13) {
           result += ' en ' + word
@@ -238,7 +228,7 @@ function buildLargeNumberWords (n, options) {
       if (segment === 1) {
         result += SCALES[0]
       } else {
-        result += segmentLookup[segment] + SCALES[0]
+        result += buildSegment(segment, includeOptionalAnd) + SCALES[0]
       }
       prevWasScale = true
     } else {
@@ -248,7 +238,7 @@ function buildLargeNumberWords (n, options) {
       if (segment === 1) {
         result += 'een ' + scaleWord
       } else {
-        result += segmentLookup[segment] + ' ' + scaleWord
+        result += buildSegment(segment, includeOptionalAnd) + ' ' + scaleWord
       }
       prevWasScale = true
     }
@@ -302,20 +292,23 @@ function decimalPartToWords (decimalPart, options) {
  * @throws {Error} If value is not a valid number format
  *
  * @example
- * toWords(21)                        // 'eenentwintig'
- * toWords(1)                         // 'één'
- * toWords(1, {accentOne: false})     // 'een'
- * toWords(1104)                      // 'elfhonderd vier'
+ * toCardinal(21)                        // 'eenentwintig'
+ * toCardinal(1)                         // 'één'
+ * toCardinal(1, {accentOne: false})     // 'een'
+ * toCardinal(1104)                      // 'elfhonderd vier'
  */
-function toWords (value, options) {
+function toCardinal (value, options) {
   options = validateOptions(options)
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
 
-  const opts = {
-    accentOne: options.accentOne !== false, // default true
-    includeOptionalAnd: options.includeOptionalAnd || false,
-    noHundredPairing: options.noHundredPairing || false
-  }
+  // Apply option defaults
+  const {
+    accentOne = true,
+    includeOptionalAnd = false,
+    noHundredPairing = false
+  } = options
+
+  const opts = { accentOne, includeOptionalAnd, noHundredPairing }
 
   let result = ''
 
@@ -332,8 +325,239 @@ function toWords (value, options) {
   return result
 }
 
+// ============================================================================
+// Ordinal Functions
+// ============================================================================
+
+// Ordinal forms for 1-9
+const ORDINAL_ONES = ['', 'eerste', 'tweede', 'derde', 'vierde', 'vijfde', 'zesde', 'zevende', 'achtste', 'negende']
+
+/**
+ * Converts a small cardinal to ordinal.
+ * Rules: 1-19 add -de (except eerste, derde, achtste), 20+ add -ste
+ *
+ * @param {string} cardinalWord - Cardinal word
+ * @param {number} n - The number value (0-99)
+ * @returns {string} Ordinal word
+ */
+function smallCardinalToOrdinal (cardinalWord, n) {
+  // Special cases for 1-9
+  if (n >= 1 && n <= 9) return ORDINAL_ONES[n]
+
+  // 10-19: add -de or -e if ends in d
+  if (n < 20) {
+    if (cardinalWord.endsWith('d')) {
+      return cardinalWord + 'e'
+    }
+    return cardinalWord + 'de'
+  }
+
+  // 20+: add -ste
+  return cardinalWord + 'ste'
+}
+
+/**
+ * Builds ordinal words for 0-999.
+ *
+ * @param {number} n - Number 0-999
+ * @returns {string} Dutch ordinal words
+ */
+function buildOrdinalSegment (n) {
+  if (n === 0) return ''
+
+  const hundreds = Math.trunc(n / 100)
+  const tensOnes = n % 100
+
+  // Simple cases: 1-99
+  if (hundreds === 0) {
+    const cardinalWord = buildSegment(n, false)
+    return smallCardinalToOrdinal(cardinalWord, n)
+  }
+
+  // Hundreds: need to build prefix + ordinal suffix
+  let prefix = ''
+  if (hundreds === 1) {
+    prefix = HUNDRED
+  } else {
+    prefix = ONES[hundreds] + HUNDRED
+  }
+
+  if (tensOnes === 0) {
+    // Exact hundred: honderdste, tweehonderdste
+    return prefix + 'ste'
+  }
+
+  // Hundreds + remainder: honderd eerste, tweehonderd drieëntwintigste
+  // Dutch ordinals with hundreds use a space before the ordinal part
+  const ordinalPart = smallCardinalToOrdinal(buildSegment(tensOnes, false), tensOnes)
+  return prefix + ' ' + ordinalPart
+}
+
+/**
+ * Converts a number to Dutch ordinal words.
+ *
+ * @param {number | string | bigint} value - The number to convert
+ * @returns {string} Dutch ordinal words
+ *
+ * @example
+ * toOrdinal(1)     // 'eerste'
+ * toOrdinal(21)    // 'eenentwintigste'
+ * toOrdinal(100)   // 'honderdste'
+ */
+function toOrdinal (value) {
+  const n = parseOrdinalValue(value)
+
+  // Fast path: 1-9
+  if (n < 10n) return ORDINAL_ONES[Number(n)]
+
+  // Fast path: 10-99
+  if (n < 100n) {
+    const cardinalWord = buildSegment(Number(n), false)
+    return smallCardinalToOrdinal(cardinalWord, Number(n))
+  }
+
+  // Fast path: 100-999
+  if (n < 1000n) {
+    return buildOrdinalSegment(Number(n))
+  }
+
+  // Large numbers: build with cardinal then convert last segment
+  return buildLargeOrdinal(n)
+}
+
+/**
+ * Builds ordinal words for large numbers.
+ *
+ * @param {bigint} n - Non-negative integer >= 1000
+ * @returns {string} Dutch ordinal words
+ */
+function buildLargeOrdinal (n) {
+  // Extract segments
+  const segments = []
+  let temp = n
+  while (temp > 0n) {
+    segments.push(Number(temp % 1000n))
+    temp = temp / 1000n
+  }
+
+  // Find the lowest non-zero segment
+  let lowestNonZeroIdx = 0
+  for (let i = 0; i < segments.length; i++) {
+    if (segments[i] !== 0) {
+      lowestNonZeroIdx = i
+      break
+    }
+  }
+
+  // Scale ordinal words
+  const SCALE_ORDINAL = ['', 'duizendste', 'miljoenste', 'miljardste', 'biljoenste', 'biljardste', 'triljoenste']
+
+  let result = ''
+
+  for (let i = segments.length - 1; i >= 0; i--) {
+    const segment = segments[i]
+    if (segment === 0) continue
+
+    if (result) result += ' '
+
+    if (i === lowestNonZeroIdx) {
+      // Last non-zero segment gets ordinal form
+      if (i === 0) {
+        // Units segment: use ordinal segment builder
+        result += buildOrdinalSegment(segment)
+      } else if (segment === 1 && i > 0) {
+        // Exact scale: duizendste, miljoenste, etc.
+        if (i === 1) {
+          result += SCALE_ORDINAL[i]
+        } else {
+          result += 'een ' + SCALE_ORDINAL[i]
+        }
+      } else {
+        // Segment + scale ordinal
+        if (i === 1) {
+          result += buildSegment(segment, false) + SCALE_ORDINAL[i]
+        } else {
+          result += buildSegment(segment, false) + ' ' + SCALE_ORDINAL[i]
+        }
+      }
+    } else {
+      // Higher segments use cardinal form
+      if (i === 1) {
+        if (segment === 1) {
+          result += SCALES[0]
+        } else {
+          result += buildSegment(segment, false) + SCALES[0]
+        }
+      } else {
+        const scaleWord = SCALES[i - 1]
+        if (segment === 1) {
+          result += 'een ' + scaleWord
+        } else {
+          result += buildSegment(segment, false) + ' ' + scaleWord
+        }
+      }
+    }
+  }
+
+  return result
+}
+
+// ============================================================================
+// Currency Functions
+// ============================================================================
+
+/**
+ * Converts a number to Dutch currency words (Euro).
+ *
+ * @param {number | string | bigint} value - The amount to convert
+ * @param {Object} [options]
+ * @param {boolean} [options.and=true] - Include "en" between euros and cents
+ * @returns {string} Dutch currency words
+ *
+ * @example
+ * toCurrency(42.50)  // 'tweeënveertig euro en vijftig cent'
+ * toCurrency(1)      // 'één euro'
+ * toCurrency(0.01)   // 'één cent'
+ */
+function toCurrency (value, options) {
+  options = validateOptions(options)
+  const { isNegative, dollars: euros, cents } = parseCurrencyValue(value)
+  const { and = true } = options
+
+  let result = ''
+
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  const hasEuros = euros > 0n
+  const hasCents = cents > 0n
+
+  if (!hasEuros && !hasCents) {
+    return ZERO + ' ' + EUROS
+  }
+
+  // Use accentOne: true for currency (één euro, één cent)
+  const opts = { accentOne: true, includeOptionalAnd: false, noHundredPairing: true }
+
+  if (hasEuros) {
+    const euroWords = integerToWords(euros, opts)
+    result += euroWords + ' ' + (euros === 1n ? EURO : EUROS)
+  }
+
+  if (hasCents) {
+    if (hasEuros) {
+      result += and ? ' en ' : ' '
+    }
+    const centWords = integerToWords(cents, opts)
+    result += centWords + ' ' + (cents === 1n ? CENT : CENTEN)
+  }
+
+  return result
+}
+
 // ============================================================================
 // Public API
 // ============================================================================
 
-export { toWords }
+export { toCardinal, toOrdinal, toCurrency }

package/src/pa-IN.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Converts a numeric value to Punjabi words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Punjabi words
+ */
+export function toCardinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Punjabi 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 Punjabi currency words (Indian Rupee).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Punjabi 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;