n2words 1.12.2 → 1.14.0

package/lib/n2words.mjs

@@ -1,5 +1,6 @@
 /* eslint-disable import/max-dependencies */
 import n2wordsAR from './i18n/AR.mjs';
+import n2wordsAZ from './i18n/AZ.mjs';
 import n2wordsCZ from './i18n/CZ.mjs';
 import n2wordsDE from './i18n/DE.mjs';
 import n2wordsDK from './i18n/DK.mjs';
@@ -26,112 +27,41 @@ import n2wordsUK from './i18n/UK.mjs';
 import n2wordsVI from './i18n/VI.mjs';
 import n2wordsZH from './i18n/ZH.mjs';
 
-const supportedLanguages = [
-  'en',
-  'fr',
-  'es',
-  'de',
-  'pt',
-  'it',
-  'tr',
-  'ru',
-  'cz',
-  'no',
-  'dk',
-  'pl',
-  'uk',
-  'lt',
-  'lv',
-  'ar',
-  'he',
-  'ko',
-  'nl',
-  'sr',
-  'fa',
-  'zh',
-  'hu',
-  'id',
-  'hr',
-  'vi',
-];
-
 /**
  * Converts a number to written form.
- *
- * @param {number} n The number to convert.
+ * @param {number|string} value The number to convert.
  * @param {object} [options={lang: "en"}] User options.
- * @returns {string} Resulting text value.
+ * @returns {string} Value in written format.
  */
-export default function(n, options = {lang: 'en'}) {
-  let lang = 'EN'; // default language
-
-  if (options) {
-    if (options.lang) {
-      // lang is given in options
-      if (supportedLanguages.indexOf(options.lang) !== -1)
-        lang = options.lang.toUpperCase();
-      else
-        throw Error(
-          'ERROR: Unsupported language. Supported languages are: ' +
-            supportedLanguages.sort().join(', ')
-        );
-    }
-  }
-
-  if (lang === 'EN') {
-    return n2wordsEN(n);
-  } else if (lang === 'FR') {
-    return n2wordsFR(n);
-  } else if (lang === 'ES') {
-    return n2wordsES(n);
-  } else if (lang === 'DE') {
-    return n2wordsDE(n);
-  } else if (lang === 'PT') {
-    return n2wordsPT(n);
-  } else if (lang === 'ID') {
-    return n2wordsID(n);
-  } else if (lang === 'IT') {
-    return n2wordsIT(n);
-  } else if (lang === 'TR') {
-    return n2wordsTR(n, options);
-  } else if (lang === 'RU') {
-    return n2wordsRU(n);
-  } else if (lang === 'CZ') {
-    return n2wordsCZ(n);
-  } else if (lang === 'NO') {
-    return n2wordsNO(n);
-  } else if (lang === 'DK') {
-    return n2wordsDK(n);
-  } else if (lang === 'PL') {
-    return n2wordsPL(n);
-  } else if (lang === 'UK') {
-    return n2wordsUK(n);
-  } else if (lang === 'LT') {
-    return n2wordsLT(n);
-  } else if (lang === 'LV') {
-    return n2wordsLV(n);
-  } else if (lang === 'AR') {
-    return n2wordsAR(n);
-  } else if (lang === 'HE') {
-    // only for numbers <= 9999
-    return n2wordsHE(n);
-  } else if (lang === 'HR') {
-    return n2wordsHR(n);
-  } else if (lang === 'HU') {
-    return n2wordsHU(n);
-  } else if (lang === 'KO') {
-    return n2wordsKO(n);
-  } else if (lang === 'NL') {
-    return n2wordsNL(n, options);
-  } else if (lang === 'SR') {
-    return n2wordsSR(n);
-  } else if (lang === 'FA') {
-    return n2wordsFA(n);
-  } else if (lang === 'ZH') {
-    return n2wordsZH(n);
-  } else if (lang === 'VI') {
-    return n2wordsVI(n);
-  } else {
-    return n2wordsEN(n);
+export default function(value, options = {lang: 'en'}) {
+  switch (options.lang) {
+    case 'en': return n2wordsEN(value);
+    case 'fr': return n2wordsFR(value);
+    case 'es': return n2wordsES(value);
+    case 'de': return n2wordsDE(value);
+    case 'pt': return n2wordsPT(value);
+    case 'it': return n2wordsIT(value);
+    case 'tr': return n2wordsTR(value, options);
+    case 'ru': return n2wordsRU(value);
+    case 'cz': return n2wordsCZ(value);
+    case 'no': return n2wordsNO(value);
+    case 'dk': return n2wordsDK(value);
+    case 'pl': return n2wordsPL(value);
+    case 'uk': return n2wordsUK(value);
+    case 'lt': return n2wordsLT(value);
+    case 'lv': return n2wordsLV(value);
+    case 'ar': return n2wordsAR(value);
+    case 'he': return n2wordsHE(value); // only for numbers <= 9999
+    case 'ko': return n2wordsKO(value);
+    case 'nl': return n2wordsNL(value, options);
+    case 'sr': return n2wordsSR(value);
+    case 'fa': return n2wordsFA(value);
+    case 'zh': return n2wordsZH(value);
+    case 'hu': return n2wordsHU(value);
+    case 'id': return n2wordsID(value);
+    case 'hr': return n2wordsHR(value);
+    case 'vi': return n2wordsVI(value);
+    case 'az': return n2wordsAZ(value);
+    default: throw Error('Unsupported language: ' + value + '.');
   }
 }

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "n2words",
-  "version": "1.12.2",
+  "version": "1.14.0",
   "description": "Convert numbers to words, in multiple languages",
   "main": "dist/n2words.js",
   "scripts": {
     "lint": "eslint --config .eslintrc.json lib/ test/",
     "test": "ava --verbose",
     "coverage": "c8 ava",
-    "build": "webpack --config webpack.config.js --progress"
+    "build": "webpack --config webpack.config.js --progress",
+    "bench": "node bench.mjs"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/forzagreen/n2words.git"
   },
+  "engines": {
+    "node": "16 || >=18"
+  },
   "keywords": [
     "n2words",
     "convert",
@@ -47,7 +51,8 @@
     "hungarian",
     "indonesian",
     "croatian",
-    "vietnamese"
+    "vietnamese",
+    "azerbaijani"
   ],
   "author": "Wael TELLAT",
   "license": "MIT",
@@ -56,19 +61,21 @@
   },
   "homepage": "https://github.com/forzagreen/n2words#readme",
   "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/preset-env": "^7.20.2",
+    "@babel/core": "^7.21.8",
+    "@babel/preset-env": "^7.21.5",
     "ava": "^5.2.0",
     "babel-loader": "^9.1.2",
-    "c8": "^7.12.0",
-    "core-js": "^3.27.2",
-    "eslint": "^8.33.0",
+    "benchmark": "^2.1.4",
+    "c8": "^7.13.0",
+    "core-js": "^3.30.2",
+    "eslint": "^8.40.0",
     "eslint-plugin-ava": "^14.0.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^39.8.0",
+    "eslint-plugin-jsdoc": "^44.2.3",
     "eslint-plugin-node": "^11.1.0",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^5.0.1"
+    "microtime": "^3.1.1",
+    "webpack": "^5.82.1",
+    "webpack-cli": "^5.1.1"
   },
   "ava": {
     "files": [

package/webpack.config.js

@@ -20,7 +20,7 @@ module.exports = {
               '@babel/preset-env',
               {
                 useBuiltIns: 'usage',
-                corejs: '3.27.2',
+                corejs: '3.30.1',
               },
             ],
           ],

package/lib/classes/N2WordsAbs.mjs

@@ -1,72 +0,0 @@
-/**
- * Abstract class that must be inherited by all languages.
- */
-export default class {
-  constructor() {
-    this.negativeWord = '';
-    this.separatorWord;
-    this.zero;
-    this.spaceSeparator = ' ';
-  }
-
-  /**
-   * Convert a number to cardinal (written) format.
-   *
-   * @param {number} value The number value to convert to cardinal form.
-   * @returns {string} Cardinal representation of number value.
-   */
-  toCardinal(value) {
-    return value;
-  }
-
-  /**
-   *
-   * @param {number} decimalPart Decimal part of the number to convert.
-   * @returns {string} Decimal part in written format.
-   */
-  toDecimal(decimalPart) {
-    let decimalPartArray = Array.from(decimalPart);
-    let decimalPartWordsArray = [];
-    while (decimalPartArray[0] === '0') {
-      // Leading zeros
-      decimalPartArray.shift();
-      decimalPartWordsArray.push(this.zero);
-    }
-    decimalPartWordsArray.push(this.toCardinal(parseInt(decimalPart, 10)));
-
-    return decimalPartWordsArray.join(this.spaceSeparator);
-  }
-
-  /**
-   *
-   * @param {number} value Float number.
-   * @throws {TypeError} Value must be a valid number.
-   * @returns {string|undefined} Cardinal number in written format.
-   */
-  floatToCardinal(value) {
-    if (isNaN(Number(value))) {
-      throw new TypeError(`Invalid number: ${value}, of type: ${typeof value}`);
-    }
-    value = Number(value);
-    let words = [];
-    let positiveValue = Math.abs(value);
-    if (value % 1 === 0 || typeof this.separatorWord === 'undefined') {
-      // if value is integer or if separatorWord is not defined
-      words = [this.toCardinal(positiveValue)];
-    } else {
-      const splittedValue = positiveValue.toString().split('.');
-      const wholeNumberStr = this.toCardinal(parseInt(splittedValue[0], 10));
-      this.wholeNumberInt = parseInt(splittedValue[0]);
-
-      let decimalPart = splittedValue[1];
-
-      const decimalPartStr = this.toDecimal(decimalPart);
-      words = [wholeNumberStr, this.separatorWord, decimalPartStr];
-    }
-    if (value < 0) {
-      // negative numbers
-      words = [this.negativeWord].concat(words);
-    }
-    return words.join(this.spaceSeparator);
-  }
-}

package/lib/classes/N2WordsBase.mjs

@@ -1,105 +0,0 @@
-import N2WordsAbs from './N2WordsAbs.mjs';
-
-/**
- * This class has common functions used by multiple languages (mostly european).
- */
-export default class extends N2WordsAbs {
-  getValueFromCards(elem) {
-    // 100
-    for (let i = 0; i < this.cards.length; i++) {
-      if (Object.prototype.hasOwnProperty.call(this.cards[i], elem)) {
-        return this.cards[i][elem];
-      }
-    }
-  }
-
-  splitNum(value) {
-    for (let i = 0; i < this.cards.length; i++) {
-      if (this.cards[i][0] == '.') {
-        continue;
-      }
-      const elem = parseInt(Object.keys(this.cards[i])[0], 10); // 100
-      if (elem > value) {
-        continue;
-      }
-      const out = [];
-      let div;
-      let mod;
-      if (value == 0) {
-        div = 1;
-        mod = 0;
-      } else {
-        div = Math.floor(value / elem);
-        mod = value % elem;
-      }
-      if (div == 1) {
-        out.push({
-          [this.getValueFromCards(1)]: 1,
-        }); // 'one'
-      } else {
-        if (div == value) {
-          return [(div * this.getValueFromCards(elem), div * elem)];
-        }
-        out.push(this.splitNum(div));
-      }
-      out.push({
-        [this.getValueFromCards(elem)]: elem,
-      });
-
-      if (mod) {
-        out.push(this.splitNum(mod));
-      }
-      return out;
-    }
-  }
-
-  scanNum(value) {
-    return value.split('').map(v => this.getValueFromCards(parseInt(v, 10)));
-  }
-
-  clean(val) {
-    let out = val;
-    while (val.length != 1) {
-      out = [];
-      const left = val[0];
-      const right = val[1];
-      if (!Array.isArray(left) && !Array.isArray(right)) {
-        // both json objects, not arrays
-        out.push(this.merge(left, right));
-        if (val.slice(2).length > 0) {
-          // all but first 2 elems
-          out.push(val.slice(2));
-        }
-      } else {
-        for (let i = 0; i < val.length; i++) {
-          const elem = val[i];
-          if (Array.isArray(elem)) {
-            if (elem.length == 1) out.push(elem[0]);
-            else out.push(this.clean(elem));
-          } else {
-            out.push(elem);
-          }
-        }
-      }
-      val = out;
-    }
-    return out[0];
-  }
-
-  postClean(out0) {
-    return out0.trimRight();
-  }
-
-  /**
-   * Convert a number to cardinal (written) format.
-   *
-   * @param {number} value The number value to convert to cardinal form.
-   * @returns {string} Cardinal representation of number value.
-   */
-  toCardinal(value) {
-    const val = this.splitNum(value);
-    const preWords = Object.keys(this.clean(val))[0];
-    const words = this.postClean(preWords);
-    return words;
-  }
-}