quantible 0.1.0-alpha

package/dist/esm/utils/stringBuilding/perDigit.js

@@ -0,0 +1,15 @@
+import { positiveInteger } from "./positiveInteger";
+/**
+ * Converts each digit in a number to words, and returns them as a joined string.
+ * @param num The number to convert, as a string.
+ * @returns A string of space-separated words, where each word is a digit in the original number.
+ * @example convertPerDigit("123") => "one two three"
+ */
+export function perDigit(num) {
+    const words = [];
+    for (let i = 0; i < num.length; i++) {
+        words.push(positiveInteger(parseInt(num[i])));
+    }
+    return words.join(" ");
+}
+//# sourceMappingURL=perDigit.js.map

package/dist/esm/utils/stringBuilding/perDigit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perDigit.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/perDigit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;GAKG;AAEH,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC"}

package/dist/esm/utils/stringBuilding/positiveInteger.js

@@ -0,0 +1,28 @@
+import { numbers } from "../../config/default";
+import { zeroTo999 } from "./zeroTo999";
+/**
+ * Converts a non-negative integer into its full English word representation.
+ * @param num The integer to convert.
+ * @returns The word representation of the number, or an error message for invalid input.
+ */
+export function positiveInteger(num) {
+    if (typeof num !== "number" || !Number.isInteger(num) || num < 0) {
+        return "Invalid input: Please provide a non-negative integer.";
+    }
+    if (num === 0) {
+        return "zero";
+    }
+    let words = "";
+    let scaleIndex = 0;
+    while (num > 0) {
+        if (num % 1000 !== 0) {
+            const upToHundreds = zeroTo999(num % 1000);
+            const magnitudeScale = numbers.scales[scaleIndex] ? " " + numbers.scales[scaleIndex] : "";
+            words = upToHundreds + magnitudeScale + (words ? " " + words : "");
+        }
+        num = Math.floor(num / 1000);
+        scaleIndex++;
+    }
+    return words.trim().replace(/\s+/g, " ");
+}
+//# sourceMappingURL=positiveInteger.js.map

package/dist/esm/utils/stringBuilding/positiveInteger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"positiveInteger.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/positiveInteger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AAEH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACjE,OAAO,uDAAuD,CAAC;IACjE,CAAC;IAED,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACd,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC;QACf,IAAI,GAAG,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;YAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1F,KAAK,GAAG,YAAY,GAAG,cAAc,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;QAC7B,UAAU,EAAE,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC"}

package/dist/esm/utils/stringBuilding/twoDigits.js

@@ -0,0 +1,15 @@
+import { positiveInteger } from "./positiveInteger";
+/**
+ * Converts a given number of cents to words, provided it is a valid number between 0 and 99.
+ * @param num The number of cents to convert, as a string.
+ * @returns The word representation of the number of cents, or an empty string if the conversion failed.
+ */
+export function twoDigit(num) {
+    if (num.trim().length !== 2)
+        return "";
+    let parsed = parseInt(num);
+    if (parsed < 100 && parsed >= 0)
+        return positiveInteger(parsed);
+    return "";
+}
+//# sourceMappingURL=twoDigits.js.map

package/dist/esm/utils/stringBuilding/twoDigits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"twoDigits.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/twoDigits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;GAIG;AAEH,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACvC,IAAI,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE3B,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,IAAI,CAAC;QAAE,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;IAChE,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/dist/esm/utils/stringBuilding/zeroTo999.js

@@ -0,0 +1,34 @@
+import { numbers } from "../../config/default";
+/**
+ * Converts a number less than 1000 into words.
+ * @param num The number to convert (0-999).
+ * @returns The word representation of the number.
+ */
+export function zeroTo999(num) {
+    if (num === 0) {
+        return "";
+    }
+    let words = "";
+    if (num >= 100) {
+        words += numbers.ones[Math.floor(num / 100)] + " hundred";
+        num %= 100;
+        if (num > 0) {
+            words += " ";
+        }
+    }
+    if (num >= 20) {
+        words += numbers.tens[Math.floor(num / 10)];
+        num %= 10;
+        if (num > 0) {
+            words += " " + numbers.ones[num];
+        }
+    }
+    else if (num >= 10) {
+        words += numbers.teens[num - 10];
+    }
+    else if (num > 0) {
+        words += numbers.ones[num];
+    }
+    return words;
+}
+//# sourceMappingURL=zeroTo999.js.map

package/dist/esm/utils/stringBuilding/zeroTo999.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zeroTo999.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/zeroTo999.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C;;;;GAIG;AAEH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACd,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,KAAK,GAAG,EAAE,CAAC;IAEf,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC;QAC1D,GAAG,IAAI,GAAG,CAAC;QACX,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACZ,KAAK,IAAI,GAAG,CAAC;QACf,CAAC;IACH,CAAC;IAED,IAAI,GAAG,IAAI,EAAE,EAAE,CAAC;QACd,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5C,GAAG,IAAI,EAAE,CAAC;QACV,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACZ,KAAK,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;SAAM,IAAI,GAAG,IAAI,EAAE,EAAE,CAAC;QACrB,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;IACnC,CAAC;SAAM,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACnB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/esm/utils/validateExtractionResultObject.js

@@ -0,0 +1,203 @@
+function isValidIntegerString(str, allowNegative = false) {
+    if (str === undefined) {
+        return true;
+    }
+    let regex;
+    if (allowNegative) {
+        regex = /^(?:[\u207B\u002D]?[\d\u2070-\u2079]+)$/;
+    }
+    else {
+        regex = /^[\d\u2070-\u2079]+$/;
+    }
+    return regex.test(str);
+}
+/**
+ * Validates an ExtractionResult object.
+ *
+ * Checks that the object is present, contains the required properties, and that
+ * the values of those properties are of the correct type.
+ *
+ * If the object is invalid, throws an Error with a description of the problem.
+ *
+ * @param {ExtractionResult} extractionResult - The object to validate.
+ */
+export function validateExtractionResult(extractionResult) {
+    if (!extractionResult) {
+        throw new Error("validateExtractionResult: ExtractionResult cannot be null or undefined.");
+    }
+    if (typeof extractionResult !== "object") {
+        throw new Error("validateExtractionResult: ExtractionResult must be an object.");
+    }
+    if (!("input" in extractionResult)) {
+        throw new Error("validateExtractionResult: ExtractionResult is missing the 'input' property.");
+    }
+    if (typeof extractionResult.input !== "string") {
+        throw new Error("validateExtractionResult: ExtractionResult 'input' property must be a string.");
+    }
+    if (!("matchType" in extractionResult)) {
+        throw new Error("validateExtractionResult: ExtractionResult is missing the 'matchType' property.");
+    }
+    if (typeof extractionResult.matchType !== "string") {
+        throw new Error("validateExtractionResult: ExtractionResult 'matchType' property must be a string.");
+    }
+    if (!("index" in extractionResult)) {
+        throw new Error("validateExtractionResult: ExtractionResult is missing the 'index' property.");
+    }
+    if (typeof extractionResult.index !== "number") {
+        throw new Error("validateExtractionResult: ExtractionResult 'index' property must be a number.");
+    }
+    const { matchType } = extractionResult;
+    switch (matchType) {
+        case "number":
+            if (!("integer" in extractionResult)) {
+                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.");
+            }
+            if (!isValidIntegerString(extractionResult.integer)) {
+                throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'integer' property must contain only integers.");
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && typeof extractionResult.decimal !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'decimal' property must be a string if present.");
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && !isValidIntegerString(extractionResult.decimal)) {
+                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.");
+            }
+            if (typeof extractionResult.negativeInt !== "boolean") {
+                throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'negativeInt' property must be a boolean.");
+            }
+            if ("exponent" in extractionResult && extractionResult.exponent !== undefined && typeof extractionResult.exponent !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'number', ExtractionResult 'exponent' property must be a string if present.");
+            }
+            if ("exponent" in extractionResult && extractionResult.exponent !== undefined && !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 ⁻).");
+            }
+            break;
+        case "symbolCurrency":
+        case "codeCurrency":
+            if (!("integer" in extractionResult)) {
+                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.`);
+            }
+            if (!isValidIntegerString(extractionResult.integer)) {
+                throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'integer' property must contain only integers.`);
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && typeof extractionResult.decimal !== "string") {
+                throw new Error(`validateExtractionResult: For matchType '${matchType}', ExtractionResult 'decimal' property must be a string if present.`);
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && !isValidIntegerString(extractionResult.decimal)) {
+                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.`);
+            }
+            if (typeof extractionResult.negativeInt !== "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.`);
+            }
+            if (typeof extractionResult.currency !== "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.");
+            }
+            if (typeof extractionResult.integer !== "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.");
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && typeof extractionResult.decimal !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'decimal' property must be a string if present.");
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && !isValidIntegerString(extractionResult.decimal)) {
+                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.");
+            }
+            if (typeof extractionResult.negativeInt !== "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.");
+            }
+            if (typeof extractionResult.unit !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'unit' property must be a string.");
+            }
+            if ("exponent" in extractionResult && extractionResult.exponent !== undefined && typeof extractionResult.exponent !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'exponent' property must be a string if present.");
+            }
+            if ("exponent" in extractionResult && extractionResult.exponent !== undefined && !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 ⁻).");
+            }
+            if ("unitExponent" in extractionResult && extractionResult.unitExponent !== undefined && typeof extractionResult.unitExponent !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'unit', ExtractionResult 'unitExponent' property must be a string if present.");
+            }
+            if ("unitExponent" in extractionResult && extractionResult.unitExponent !== undefined && !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 ⁻).");
+            }
+            break;
+        case "unitOnly":
+            if (!("unit" in extractionResult)) {
+                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.");
+            }
+            if ("unitExponent" in extractionResult && extractionResult.unitExponent !== undefined && typeof extractionResult.unitExponent !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'unitOnly', ExtractionResult 'unitExponent' property must be a string if present.");
+            }
+            if ("unitExponent" in extractionResult && extractionResult.unitExponent !== undefined && !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 ⁻).");
+            }
+            break;
+        case "operator":
+            break; // 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.");
+            }
+            if (typeof extractionResult.integer !== "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.");
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && typeof extractionResult.decimal !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'decimal' property must be a string if present.");
+            }
+            if ("decimal" in extractionResult && extractionResult.decimal !== undefined && !isValidIntegerString(extractionResult.decimal)) {
+                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.");
+            }
+            if (typeof extractionResult.negativeInt !== "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.");
+            }
+            if (extractionResult.exponent !== undefined && typeof extractionResult.exponent !== "string") {
+                throw new Error("validateExtractionResult: For matchType 'scientific', ExtractionResult 'exponent' property must be a string.");
+            }
+            if (extractionResult.exponent !== undefined && !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 ⁻).");
+            }
+            break;
+        default:
+            throw new Error(`validateExtractionResult: Unknown matchType: ${matchType}`);
+    }
+}
+//# sourceMappingURL=validateExtractionResultObject.js.map

package/dist/esm/utils/validateExtractionResultObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateExtractionResultObject.js","sourceRoot":"","sources":["../../../src/utils/validateExtractionResultObject.ts"],"names":[],"mappings":"AAEA,SAAS,oBAAoB,CAAC,GAAuB,EAAE,gBAAyB,KAAK;IACnF,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,KAAK,CAAC;IACV,IAAI,aAAa,EAAE,CAAC;QAClB,KAAK,GAAG,yCAAyC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,sBAAsB,CAAC;IACjC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,wBAAwB,CAAC,gBAAkC;IACzE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC7F,CAAC;IAED,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAED,IAAI,CAAC,CAAC,OAAO,IAAI,gBAAgB,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAC;IACjG,CAAC;IACD,IAAI,OAAO,gBAAgB,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;IACnG,CAAC;IAED,IAAI,CAAC,CAAC,WAAW,IAAI,gBAAgB,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;IACrG,CAAC;IACD,IAAI,OAAO,gBAAgB,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;IACvG,CAAC;IAED,IAAI,CAAC,CAAC,OAAO,IAAI,gBAAgB,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAC;IACjG,CAAC;IACD,IAAI,OAAO,gBAAgB,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;IACnG,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC;IAEvC,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,IAAI,CAAC,CAAC,SAAS,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAC3H,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,yGAAyG,CAAC,CAAC;YAC7H,CAAC;YACD,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,mHAAmH,CAAC,CAAC;YACvI,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5H,MAAM,IAAI,KAAK,CAAC,oHAAoH,CAAC,CAAC;YACxI,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/H,MAAM,IAAI,KAAK,CAAC,mHAAmH,CAAC,CAAC;YACvI,CAAC;YACD,IAAI,CAAC,CAAC,aAAa,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,2GAA2G,CAAC,CAAC;YAC/H,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACtD,MAAM,IAAI,KAAK,CAAC,8GAA8G,CAAC,CAAC;YAClI,CAAC;YACD,IAAI,UAAU,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC/H,MAAM,IAAI,KAAK,CAAC,qHAAqH,CAAC,CAAC;YACzI,CAAC;YACD,IAAI,UAAU,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxI,MAAM,IAAI,KAAK,CAAC,2LAA2L,CAAC,CAAC;YAC/M,CAAC;YACD,MAAM;QAER,KAAK,gBAAgB,CAAC;QACtB,KAAK,cAAc;YACjB,IAAI,CAAC,CAAC,SAAS,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,wDAAwD,CAAC,CAAC;YACjI,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,0DAA0D,CAAC,CAAC;YACnI,CAAC;YACD,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,oEAAoE,CAAC,CAAC;YAC7I,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5H,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,qEAAqE,CAAC,CAAC;YAC9I,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/H,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,oEAAoE,CAAC,CAAC;YAC7I,CAAC;YACD,IAAI,CAAC,CAAC,aAAa,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,4DAA4D,CAAC,CAAC;YACrI,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACtD,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,+DAA+D,CAAC,CAAC;YACxI,CAAC;YACD,IAAI,CAAC,CAAC,UAAU,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,yDAAyD,CAAC,CAAC;YAClI,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAClD,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,2DAA2D,CAAC,CAAC;YACpI,CAAC;YACD,MAAM;QAER,KAAK,MAAM;YACT,IAAI,CAAC,CAAC,SAAS,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,qGAAqG,CAAC,CAAC;YACzH,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAC3H,CAAC;YACD,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,iHAAiH,CAAC,CAAC;YACrI,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5H,MAAM,IAAI,KAAK,CAAC,kHAAkH,CAAC,CAAC;YACtI,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/H,MAAM,IAAI,KAAK,CAAC,iHAAiH,CAAC,CAAC;YACrI,CAAC;YACD,IAAI,CAAC,CAAC,aAAa,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,yGAAyG,CAAC,CAAC;YAC7H,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACtD,MAAM,IAAI,KAAK,CAAC,4GAA4G,CAAC,CAAC;YAChI,CAAC;YACD,IAAI,CAAC,CAAC,MAAM,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAC;YACtH,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC9C,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC,CAAC;YACxH,CAAC;YACD,IAAI,UAAU,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC/H,MAAM,IAAI,KAAK,CAAC,mHAAmH,CAAC,CAAC;YACvI,CAAC;YACD,IAAI,UAAU,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxI,MAAM,IAAI,KAAK,CAAC,yLAAyL,CAAC,CAAC;YAC7M,CAAC;YACD,IAAI,cAAc,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAC3I,MAAM,IAAI,KAAK,CAAC,uHAAuH,CAAC,CAAC;YAC3I,CAAC;YACD,IAAI,cAAc,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC;gBACpJ,MAAM,IAAI,KAAK,CAAC,6LAA6L,CAAC,CAAC;YACjN,CAAC;YACD,MAAM;QAER,KAAK,UAAU;YACb,IAAI,CAAC,CAAC,MAAM,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,KAAK,CAAC,sGAAsG,CAAC,CAAC;YAC1H,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC9C,MAAM,IAAI,KAAK,CAAC,wGAAwG,CAAC,CAAC;YAC5H,CAAC;YACD,IAAI,cAAc,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAC3I,MAAM,IAAI,KAAK,CAAC,2HAA2H,CAAC,CAAC;YAC/I,CAAC;YACD,IAAI,cAAc,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC;gBACpJ,MAAM,IAAI,KAAK,CAAC,iMAAiM,CAAC,CAAC;YACrN,CAAC;YACD,MAAM;QAER,KAAK,UAAU;YACb,MAAM,CAAC,kDAAkD;QAE3D,KAAK,YAAY;YACf,IAAI,CAAC,CAAC,SAAS,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,2GAA2G,CAAC,CAAC;YAC/H,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAC;YACjI,CAAC;YACD,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,uHAAuH,CAAC,CAAC;YAC3I,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5H,MAAM,IAAI,KAAK,CAAC,wHAAwH,CAAC,CAAC;YAC5I,CAAC;YACD,IAAI,SAAS,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/H,MAAM,IAAI,KAAK,CAAC,uHAAuH,CAAC,CAAC;YAC3I,CAAC;YACD,IAAI,CAAC,CAAC,aAAa,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,+GAA+G,CAAC,CAAC;YACnI,CAAC;YACD,IAAI,OAAO,gBAAgB,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACtD,MAAM,IAAI,KAAK,CAAC,kHAAkH,CAAC,CAAC;YACtI,CAAC;YACD,IAAI,CAAC,CAAC,UAAU,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,KAAK,CAAC,4GAA4G,CAAC,CAAC;YAChI,CAAC;YACD,IAAI,gBAAgB,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,gBAAgB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC7F,MAAM,IAAI,KAAK,CAAC,8GAA8G,CAAC,CAAC;YAClI,CAAC;YACD,IAAI,gBAAgB,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;gBACtG,MAAM,IAAI,KAAK,CAAC,+LAA+L,CAAC,CAAC;YACnN,CAAC;YACD,MAAM;QAER;YACE,MAAM,IAAI,KAAK,CAAC,gDAAgD,SAAS,EAAE,CAAC,CAAC;IACjF,CAAC;AACH,CAAC"}

package/dist/types/config/default.d.ts

@@ -0,0 +1,39 @@
+import { Currency, Unit } from "../interfaces/configurations/default";
+export declare const units: {
+    [key: string]: Unit;
+};
+export declare const numbers: {
+    ones: string[];
+    teens: string[];
+    tens: string[];
+    scales: string[];
+    ordinals: {
+        one: string;
+        two: string;
+        three: string;
+        five: string;
+        eight: string;
+        nine: string;
+        twelve: string;
+    };
+};
+export declare const currencySymbols: {
+    [key: string]: Currency;
+};
+export declare const currencyCodes: {
+    [key: string]: Currency;
+};
+export declare const currencies: {
+    [x: string]: Currency;
+};
+export declare const math: {
+    "+": string;
+    "-": string;
+    "*": string;
+    "\u00D7": string;
+    "\u00B7": string;
+    "/": string;
+    "\u00F7": string;
+    ":": string;
+    "^": string;
+};

package/dist/types/converters/convertCurrencyToSpokenWord.d.ts

@@ -0,0 +1,7 @@
+import { baseCurrency } from "../interfaces/definitions";
+/**
+ * Converts a currency object into its spoken word representation.
+ * @param {baseCurrency} amount - The currency object to convert.
+ * @returns {string} The spoken word representation of the currency.
+ */
+export declare function convertCurrencyToSpokenWord(amount: baseCurrency): string;

package/dist/types/converters/convertNumberToSpokenWord.d.ts

@@ -0,0 +1,7 @@
+import { baseNumber } from "../interfaces/definitions";
+/**
+ * Converts a number object into its spoken word representation.
+ * @param {baseNumber} num - The number object to convert.
+ * @returns {string} The spoken word representation of the number.
+ */
+export declare function convertNumberToSpokenWord(num: baseNumber): string;

package/dist/types/converters/convertNumericUnitToSpokenWord.d.ts

@@ -0,0 +1,7 @@
+import { baseNumberUnit } from "../interfaces/definitions";
+/**
+ * Converts a numeric unit object into its spoken word representation.
+ * @param {baseNumberUnit} numericUnit - The numeric unit object to convert.
+ * @returns {string} The spoken word representation of the numeric unit.
+ */
+export declare function convertNumericUnitToSpokenWord(numericUnit: baseNumberUnit): string;

package/dist/types/converters/convertOperatorToSpokenWord.d.ts

@@ -0,0 +1,7 @@
+import { baseOperator } from "../interfaces/definitions";
+/**
+ * Converts an operator object into its spoken word representation.
+ * @param {baseOperator} operatorObject - The operator object to convert.
+ * @returns {string} The spoken word representation of the operator.
+ */
+export declare function convertOperatorToSpokenWord(operatorObject: baseOperator): string;

package/dist/types/converters/convertScientificExpressionToSpokenWord.d.ts

@@ -0,0 +1,7 @@
+import { baseScientific } from "../interfaces/definitions";
+/**
+ * Converts a scientific expression object into its spoken word representation.
+ * @param {baseScientific} expression - The scientific expression object to convert.
+ * @returns {string} The spoken word representation of the scientific expression.
+ */
+export declare function convertScientificExpressionToSpokenWord(expression: baseScientific): string;

package/dist/types/converters/convertUnitOnlyToSpokenWord.d.ts

@@ -0,0 +1,7 @@
+import { baseUnitOnly } from "../interfaces/definitions";
+/**
+ * Converts a unit-only object into its spoken word representation.
+ * @param {baseUnitOnly} unitOnlyObject - The unit-only object to convert.
+ * @returns {string} The spoken word representation of the unit.
+ */
+export declare function convertUnitOnlyToSpokenWord(unitOnlyObject: baseUnitOnly): string;

package/dist/types/index.d.ts

@@ -0,0 +1,58 @@
+import { extractFirstMatch, extractAllMatches } from "./utils/extraction/patternExtractor";
+import { ExtractionResult } from "./interfaces/definitions";
+import { validateExtractionResult } from "./utils/validateExtractionResultObject";
+/**
+ * @namespace extractQuantities
+ * @description Contains functions for extracting numeric data from a string.
+ */
+declare const extractQuantities: {
+    /**
+     * Extracts the first match (number || currency || unit || operator || scientific expression) from the input string.
+     * @param {string} input - The string to extract from.
+     * @returns {ExtractionResult | null} The extracted data or null if no match is found.
+     */
+    firstMatch: typeof extractFirstMatch;
+    /**
+     * Extracts all matches (number || currency || unit || operator || scientific expression) from the input string.
+     * @param {string} input - The string to extract from.
+     * @returns {ExtractionResult[]} The extracted data.
+     */
+    allMatches: typeof extractAllMatches;
+};
+/**
+ * @namespace convertQuantities
+ * @description Contains functions for converting (number || currency || unit || operator || scientific expression) data from a string or object to spoken word.
+ */
+declare const 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.
+     *
+     * @param {ExtractionResult} extractionResult - The ExtractionResult object to translate.
+     * @returns {string} The spoken word equivalent of the ExtractionResult.
+     */
+    translateMatch: (extractionResult: ExtractionResult) => string;
+    /**
+     * Extracts the first match (number || currency || unit || operator || scientific expression) from the input string
+     * and translates it to its spoken word equivalent.
+     *
+     * @param {string} input - The string to extract and translate from.
+     * @returns {string} The input string with the first match replaced by its spoken word equivalent,
+     * or an empty string if no match is found.
+     */
+    autoReplaceFirstMatch: (input: string) => string;
+    /**
+     * Extracts all matches (number || currency || unit || operator || scientific expression) from the input string
+     * and translates them to their spoken word equivalents.
+     *
+     * @param {string} input - The string to extract and translate from.
+     * @returns {string} The input string with all matches replaced by their spoken word equivalents. Returns the original string if no matches are found.
+     */
+    autoReplaceAllMatches: (input: string) => string;
+};
+export { convertQuantities, extractQuantities, validateExtractionResult };

package/dist/types/interfaces/configurations/default.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Configuration for currency fraction (e.g., cents).
+ */
+export interface CurrencyFractionConfig {
+    singular: string;
+    plural: string;
+}
+/**
+ * Configuration for currency (e.g., USD).
+ */
+export interface Currency {
+    singular: string;
+    plural: string;
+    fraction: CurrencyFractionConfig | null;
+}
+/**
+ * Configuration for a unit (e.g., meter).
+ */
+export interface Unit {
+    singular: string;
+    plural: string;
+}

package/dist/types/interfaces/definitions.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Represents the base structure for all extraction results,
+ * containing the input string, match type, index, and length of the extracted value.
+ */
+interface baseExtraction {
+    input: string;
+    matchType: string;
+    index: number;
+}
+/**
+ * @interface numericBaseExtraction
+ * @extends {baseExtraction}
+ * @description Represents the base structure for numeric extraction results,
+ * extending the baseExtraction with properties for integer, decimal, and negative integer indication.
+ */
+interface numericBaseExtraction extends baseExtraction {
+    integer: string;
+    decimal?: string;
+    negativeInt: boolean;
+}
+/**
+ * @interface baseCurrency
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for currency extraction results,
+ * extending the numericBaseExtraction with properties for match type (symbol or code) and currency symbol or code.
+ */
+export interface baseCurrency extends numericBaseExtraction {
+    matchType: "symbolCurrency" | "codeCurrency";
+    currency: string;
+}
+/**
+ * @interface baseScientific
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for scientific notation extraction results,
+ * extending the numericBaseExtraction with properties for match type (scientific) and a mandatory exponent value.
+ */
+export interface baseScientific extends numericBaseExtraction {
+    matchType: "scientific";
+    exponent: string;
+}
+/**
+ * @interface baseNumberUnit
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for quantitative unit extraction results,
+ * extending the numericBaseExtraction with properties for match type (unit), unit name, optional exponent, and optional unit exponent.
+ */
+export interface baseNumberUnit extends numericBaseExtraction {
+    matchType: "unit";
+    unit: string;
+    exponent?: string;
+    unitExponent?: string;
+}
+/**
+ * @interface baseUnitOnly
+ * @extends {baseExtraction}
+ * @description Represents the structure for unit-only extraction results,
+ * extending the baseExtraction with properties for match type (unitOnly), unit name, and optional unit exponent.
+ */
+export interface baseUnitOnly extends baseExtraction {
+    matchType: "unitOnly";
+    unit: string;
+    unitExponent?: string;
+}
+/**
+ * @interface baseOperator
+ * @extends {baseExtraction}
+ * @description Represents the structure for mathematical operator extraction results,
+ * extending the baseExtraction with a property for match type (operator).
+ */
+export interface baseOperator extends baseExtraction {
+    matchType: "operator";
+}
+/**
+ * @interface baseNumber
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for number extraction results,
+ * extending the numericBaseExtraction with properties for match type (number) and an optional exponent.
+ */
+export interface baseNumber extends numericBaseExtraction {
+    matchType: "number";
+    exponent?: string;
+}
+/**
+ * @interface ExtractionResult
+ * @description Represents all possible extraction results
+ * and contains all properties that can be extracted from a given input string.
+ */
+export interface ExtractionResult {
+    input: string;
+    matchType: string;
+    index: number;
+    integer?: string;
+    decimal?: string;
+    negativeInt?: boolean;
+    currency?: string;
+    exponent?: string;
+    unit?: string;
+    unitExponent?: string;
+}
+export {};

package/dist/types/utils/extraction/patternExtractor.d.ts

@@ -0,0 +1,21 @@
+import { ExtractionResult } from "../../interfaces/definitions";
+/**
+ * Returns the first match of a number, currency, unit, or exponent in the given string.
+ * The returned object contains the extracted groups and additional information such as
+ * the type of match and the index of the match in the string.
+ *
+ * @param {string} input - The string to search for matches
+ * @returns {patternExtraction | null} - The extracted groups and additional information, or null if no match is found
+ */
+export declare function extractFirstMatch(input: string): ExtractionResult | null;
+/**
+ * Extracts all matches of a number, currency, unit, or exponent in the given string
+ * and returns an array of the extracted groups and additional information such as
+ * the type of match and the index of the match in the string.
+ *
+ * If the input string contains no matches, an empty array is returned.
+ *
+ * @param {string} input - The string to search for matches
+ * @returns {patternExtraction[]} - The extracted groups and additional information, or an empty array if no match is found
+ */
+export declare function extractAllMatches(input: string): ExtractionResult[];

package/dist/types/utils/extraction/regexPatterns.d.ts

@@ -0,0 +1,2 @@
+declare const regexMatches: RegExp;
+export { regexMatches };