quantible 0.1.9-alpha → 0.1.12-alpha

package/dist/index.cjs

@@ -1,30 +1,4 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  convertQuantities: () => convertQuantities,
-  extractQuantities: () => extractQuantities,
-  validateExtractionResult: () => validateExtractionResult
-});
-module.exports = __toCommonJS(index_exports);
+'use strict';
 
 // src/config/default.ts
 var units = {
@@ -325,17 +299,7 @@ var numbers = {
   ones: ["", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine"],
   teens: ["ten", "eleven", "twelve", "thirteen", "fourteen", "fifteen", "sixteen", "seventeen", "eighteen", "nineteen"],
   tens: ["", "", "twenty", "thirty", "forty", "fifty", "sixty", "seventy", "eighty", "ninety"],
-  scales: ["", "thousand", "million", "billion", "trillion", "quadrillion", "quintillion"],
-  ordinals: {
-    one: "first",
-    two: "second",
-    three: "third",
-    five: "fifth",
-    eight: "eighth",
-    nine: "ninth",
-    twelve: "twelfth"
-  }
-};
+  scales: ["", "thousand", "million", "billion", "trillion", "quadrillion", "quintillion"]};
 var currencySymbols = {
   $: {
     singular: "dollar",
@@ -499,8 +463,6 @@ function extractFirstMatch(input) {
         extractedGroup.exponent = matchedGroup["integerSuperExponent"] || matchedGroup["integerCaretExponent"];
         extractedGroup.negativeInt = matchedGroup["negativeSignInteger"] !== void 0;
         break;
-      default:
-        break;
     }
     extractedGroup.matchType = matchType;
     extractedGroup.input = matchedGroup[matchType];
@@ -683,11 +645,7 @@ function convertNumericUnitToSpokenWord(numericUnit) {
   let sentence = convertNumberToSpokenWord({
     integer,
     decimal,
-    negativeInt,
-    matchType: "number",
-    input: "",
-    index: 0
-  });
+    negativeInt});
   let spokenUnit;
   let directUnitKey = unit + (unitExponent !== void 0 ? unitExponent : "");
   let directUnit = units[directUnitKey];
@@ -730,18 +688,10 @@ function convertScientificExpressionToSpokenWord(expression) {
   let sentence = convertNumberToSpokenWord({
     integer,
     decimal,
-    negativeInt,
-    matchType: "number",
-    input: "",
-    index: 0
-  }) + " " + E + convertNumberToSpokenWord({
+    negativeInt}) + " " + E + convertNumberToSpokenWord({
     decimal: void 0,
     negativeInt: isNegativeExponent,
-    integer: toRegularInteger(isNegativeExponent ? exponent.slice(1) : exponent),
-    matchType: "number",
-    input: "",
-    index: 0
-  });
+    integer: toRegularInteger(isNegativeExponent ? exponent.slice(1) : exponent)});
   return sentence.trim();
 }
 
@@ -804,116 +754,186 @@ function validateExtractionResult(extractionResult) {
   switch (matchType) {
     case "number":
       if (!("integer" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult is missing the 'integer' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult is missing the 'integer' property."
+        );
       }
       if (typeof extractionResult.integer !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'integer' property must be a string.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'integer' property must be a string."
+        );
       }
       if (!isValidIntegerString(extractionResult.integer)) {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'integer' property must contain only integers.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'integer' property must contain only integers."
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && typeof extractionResult.decimal !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'decimal' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'decimal' property must be a string if present."
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && !isValidIntegerString(extractionResult.decimal)) {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'decimal' property must contain only integers.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'decimal' property must contain only integers."
+        );
       }
       if (!("negativeInt" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult is missing the 'negativeInt' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult is missing the 'negativeInt' property."
+        );
       }
       if (typeof extractionResult.negativeInt !== "boolean") {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'negativeInt' property must be a boolean.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'negativeInt' property must be a boolean."
+        );
       }
       if ("exponent" in extractionResult && extractionResult.exponent !== void 0 && typeof extractionResult.exponent !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'exponent' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'exponent' property must be a string if present."
+        );
       }
       if ("exponent" in extractionResult && extractionResult.exponent !== void 0 && !isValidIntegerString(extractionResult.exponent, true)) {
-        throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'exponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B).");
+        throw new Error(
+          "validateExtractionResult: For matchType 'number', ExtractionResult 'exponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B)."
+        );
       }
       break;
     case "symbolCurrency":
     case "codeCurrency":
       if (!("integer" in extractionResult)) {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult is missing the 'integer' property.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult is missing the 'integer' property.`
+        );
       }
       if (typeof extractionResult.integer !== "string") {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'integer' property must be a string.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult 'integer' property must be a string.`
+        );
       }
       if (!isValidIntegerString(extractionResult.integer)) {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'integer' property must contain only integers.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult 'integer' property must contain only integers.`
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && typeof extractionResult.decimal !== "string") {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'decimal' property must be a string if present.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult 'decimal' property must be a string if present.`
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && !isValidIntegerString(extractionResult.decimal)) {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'decimal' property must contain only integers.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult 'decimal' property must contain only integers.`
+        );
       }
       if (!("negativeInt" in extractionResult)) {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult is missing the 'negativeInt' property.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult is missing the 'negativeInt' property.`
+        );
       }
       if (typeof extractionResult.negativeInt !== "boolean") {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'negativeInt' property must be a boolean.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult 'negativeInt' property must be a boolean.`
+        );
       }
       if (!("currency" in extractionResult)) {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult is missing the 'currency' property.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult is missing the 'currency' property.`
+        );
       }
       if (typeof extractionResult.currency !== "string") {
-        throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'currency' property must be a string.`);
+        throw new Error(
+          `validateExtractionResult: For matchType '${matchType}', ExtractionResult 'currency' property must be a string.`
+        );
       }
       break;
     case "unit":
       if (!("integer" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult is missing the 'integer' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult is missing the 'integer' property."
+        );
       }
       if (typeof extractionResult.integer !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'integer' property must be a string.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'integer' property must be a string."
+        );
       }
       if (!isValidIntegerString(extractionResult.integer)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'integer' property must contain only integers.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'integer' property must contain only integers."
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && typeof extractionResult.decimal !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'decimal' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'decimal' property must be a string if present."
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && !isValidIntegerString(extractionResult.decimal)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'decimal' property must contain only integers.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'decimal' property must contain only integers."
+        );
       }
       if (!("negativeInt" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult is missing the 'negativeInt' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult is missing the 'negativeInt' property."
+        );
       }
       if (typeof extractionResult.negativeInt !== "boolean") {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'negativeInt' property must be a boolean.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'negativeInt' property must be a boolean."
+        );
       }
       if (!("unit" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult is missing the 'unit' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult is missing the 'unit' property."
+        );
       }
       if (typeof extractionResult.unit !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'unit' property must be a string.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'unit' property must be a string."
+        );
       }
       if ("exponent" in extractionResult && extractionResult.exponent !== void 0 && typeof extractionResult.exponent !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'exponent' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'exponent' property must be a string if present."
+        );
       }
       if ("exponent" in extractionResult && extractionResult.exponent !== void 0 && !isValidIntegerString(extractionResult.exponent, true)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'exponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B).");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'exponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B)."
+        );
       }
       if ("unitExponent" in extractionResult && extractionResult.unitExponent !== void 0 && typeof extractionResult.unitExponent !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'unitExponent' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'unitExponent' property must be a string if present."
+        );
       }
       if ("unitExponent" in extractionResult && extractionResult.unitExponent !== void 0 && !isValidIntegerString(extractionResult.unitExponent, true)) {
-        throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'unitExponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B).");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unit', ExtractionResult 'unitExponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B)."
+        );
       }
       break;
     case "unitOnly":
       if (!("unit" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'unitOnly', ExtractionResult is missing the 'unit' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unitOnly', ExtractionResult is missing the 'unit' property."
+        );
       }
       if (typeof extractionResult.unit !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unit' property must be a string.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unit' property must be a string."
+        );
       }
       if ("unitExponent" in extractionResult && extractionResult.unitExponent !== void 0 && typeof extractionResult.unitExponent !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unitExponent' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unitExponent' property must be a string if present."
+        );
       }
       if ("unitExponent" in extractionResult && extractionResult.unitExponent !== void 0 && !isValidIntegerString(extractionResult.unitExponent, true)) {
-        throw new Error("validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unitExponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B).");
+        throw new Error(
+          "validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unitExponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B)."
+        );
       }
       break;
     case "operator":
@@ -921,34 +941,54 @@ function validateExtractionResult(extractionResult) {
     // No specific properties to validate for operator
     case "scientific":
       if (!("integer" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult is missing the 'integer' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult is missing the 'integer' property."
+        );
       }
       if (typeof extractionResult.integer !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'integer' property must be a string.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'integer' property must be a string."
+        );
       }
       if (!isValidIntegerString(extractionResult.integer)) {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'integer' property must contain only integers.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'integer' property must contain only integers."
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && typeof extractionResult.decimal !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'decimal' property must be a string if present.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'decimal' property must be a string if present."
+        );
       }
       if ("decimal" in extractionResult && extractionResult.decimal !== void 0 && !isValidIntegerString(extractionResult.decimal)) {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'decimal' property must contain only integers.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'decimal' property must contain only integers."
+        );
       }
       if (!("negativeInt" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult is missing the 'negativeInt' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult is missing the 'negativeInt' property."
+        );
       }
       if (typeof extractionResult.negativeInt !== "boolean") {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'negativeInt' property must be a boolean.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'negativeInt' property must be a boolean."
+        );
       }
       if (!("exponent" in extractionResult)) {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult is missing the 'exponent' property.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult is missing the 'exponent' property."
+        );
       }
       if (extractionResult.exponent !== void 0 && typeof extractionResult.exponent !== "string") {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'exponent' property must be a string.");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'exponent' property must be a string."
+        );
       }
       if (extractionResult.exponent !== void 0 && !isValidIntegerString(extractionResult.exponent, true)) {
-        throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'exponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B).");
+        throw new Error(
+          "validateExtractionResult: For matchType 'scientific', ExtractionResult 'exponent' property must contain only integers or superscript integers (and their respective negative symbol - and \u207B)."
+        );
       }
       break;
     default:
@@ -972,12 +1012,6 @@ var extractQuantities = {
   allMatches: extractAllMatches
 };
 var convertQuantities = {
-  /**
-   * Translates an ExtractionResult object (number || currency || unit || operator || scientific expression) into its spoken word equivalent.
-   *
-   * @param {ExtractionResult} extractionResult - The ExtractionResult object to translate.
-   * @returns {string} The spoken word equivalent of the ExtractionResult.
-   */
   /**
    * Translates an ExtractionResult object (number || currency || unit || operator || scientific expression) into its spoken word equivalent.
    *
@@ -1008,8 +1042,6 @@ var convertQuantities = {
       case "scientific":
         result = convertScientificExpressionToSpokenWord(extractionResult);
         break;
-      default:
-        break;
     }
     return result;
   },
@@ -1049,10 +1081,9 @@ var convertQuantities = {
     return output.replace(/\s+/g, " ").trim();
   }
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  convertQuantities,
-  extractQuantities,
-  validateExtractionResult
-});
+
+exports.convertQuantities = convertQuantities;
+exports.extractQuantities = extractQuantities;
+exports.validateExtractionResult = validateExtractionResult;
+//# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map