quantible 0.1.0-alpha

package/dist/cjs/converters/convertOperatorToSpokenWord.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertOperatorToSpokenWord = convertOperatorToSpokenWord;
+const default_1 = require("../config/default");
+/**
+ * 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.
+ */
+function convertOperatorToSpokenWord(operatorObject) {
+    const { input } = operatorObject;
+    if (input === undefined) {
+        return "";
+    }
+    return default_1.math[input];
+}
+//# sourceMappingURL=convertOperatorToSpokenWord.js.map

package/dist/cjs/converters/convertOperatorToSpokenWord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertOperatorToSpokenWord.js","sourceRoot":"","sources":["../../../src/converters/convertOperatorToSpokenWord.ts"],"names":[],"mappings":";;AAQA,kEAMC;AAdD,+CAAyC;AAGzC;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,cAA4B;IACtE,MAAM,EAAE,KAAK,EAAE,GAAG,cAAc,CAAC;IACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,cAAI,CAAC,KAA0B,CAAC,CAAC;AAC1C,CAAC"}

package/dist/cjs/converters/convertScientificExpressionToSpokenWord.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertScientificExpressionToSpokenWord = convertScientificExpressionToSpokenWord;
+const convertNumberToSpokenWord_1 = require("./convertNumberToSpokenWord");
+const parseSuperscript_1 = require("../utils/parseSuperscript");
+/**
+ * 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.
+ */
+function convertScientificExpressionToSpokenWord(expression) {
+    const { integer, decimal, exponent, negativeInt } = expression;
+    const isNegativeExponent = exponent.startsWith("-") || exponent.startsWith("⁻");
+    let E = "times ten to the power of ";
+    let sentence = (0, convertNumberToSpokenWord_1.convertNumberToSpokenWord)({
+        integer,
+        decimal,
+        negativeInt,
+        matchType: "number",
+        input: "",
+        index: 0,
+    }) +
+        " " +
+        E +
+        (0, convertNumberToSpokenWord_1.convertNumberToSpokenWord)({
+            decimal: undefined,
+            negativeInt: isNegativeExponent,
+            integer: (0, parseSuperscript_1.toRegularInteger)(isNegativeExponent ? exponent.slice(1) : exponent),
+            matchType: "number",
+            input: "",
+            index: 0,
+        });
+    return sentence.trim();
+}
+//# sourceMappingURL=convertScientificExpressionToSpokenWord.js.map

package/dist/cjs/converters/convertScientificExpressionToSpokenWord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertScientificExpressionToSpokenWord.js","sourceRoot":"","sources":["../../../src/converters/convertScientificExpressionToSpokenWord.ts"],"names":[],"mappings":";;AASA,0FA8BC;AAvCD,2EAAwE;AACxE,gEAA6D;AAG7D;;;;GAIG;AACH,SAAgB,uCAAuC,CAAC,UAA0B;IAChF,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;IAE/D,MAAM,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAEhF,IAAI,CAAC,GAAG,4BAA4B,CAAC;IAErC,IAAI,QAAQ,GACV,IAAA,qDAAyB,EAAC;QACxB,OAAO;QACP,OAAO;QACP,WAAW;QACX,SAAS,EAAE,QAAQ;QACnB,KAAK,EAAE,EAAE;QACT,KAAK,EAAE,CAAC;KAET,CAAC;QACF,GAAG;QACH,CAAC;QACD,IAAA,qDAAyB,EAAC;YACxB,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,IAAA,mCAAgB,EAAC,kBAAkB,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YAC5E,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC;SAET,CAAC,CAAC;IAEL,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC"}

package/dist/cjs/converters/convertUnitOnlyToSpokenWord.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertUnitOnlyToSpokenWord = convertUnitOnlyToSpokenWord;
+const default_1 = require("../config/default");
+const exponent_1 = require("../utils/stringBuilding/exponent");
+/**
+ * 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.
+ */
+function convertUnitOnlyToSpokenWord(unitOnlyObject) {
+    const { unit, unitExponent } = unitOnlyObject;
+    let spokenUnit;
+    spokenUnit = default_1.units[unit];
+    let result = "";
+    if (spokenUnit === undefined) {
+        return "";
+    }
+    if (unitExponent !== undefined) {
+        result = spokenUnit.singular + " " + (0, exponent_1.exponentSpokenWord)(unitExponent);
+    }
+    else {
+        result = spokenUnit.singular;
+    }
+    return result;
+}
+//# sourceMappingURL=convertUnitOnlyToSpokenWord.js.map

package/dist/cjs/converters/convertUnitOnlyToSpokenWord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertUnitOnlyToSpokenWord.js","sourceRoot":"","sources":["../../../src/converters/convertUnitOnlyToSpokenWord.ts"],"names":[],"mappings":";;AAUA,kEAkBC;AA5BD,+CAA0C;AAE1C,+DAAsE;AAGtE;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,cAA4B;IACtE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,cAAc,CAAC;IAE9C,IAAI,UAAgB,CAAC;IAErB,UAAU,GAAG,eAAK,CAAC,IAAI,CAAC,CAAC;IAEzB,IAAI,MAAM,GAAW,EAAE,CAAC;IACxB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,GAAG,UAAU,CAAC,QAAQ,GAAG,GAAG,GAAG,IAAA,6BAAkB,EAAC,YAAY,CAAC,CAAC;IACxE,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC;IAC/B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateExtractionResult = exports.extractQuantities = exports.convertQuantities = void 0;
+const patternExtractor_1 = require("./utils/extraction/patternExtractor");
+const convertCurrencyToSpokenWord_1 = require("./converters/convertCurrencyToSpokenWord");
+const convertNumberToSpokenWord_1 = require("./converters/convertNumberToSpokenWord");
+const convertNumericUnitToSpokenWord_1 = require("./converters/convertNumericUnitToSpokenWord");
+const convertOperatorToSpokenWord_1 = require("./converters/convertOperatorToSpokenWord");
+const convertScientificExpressionToSpokenWord_1 = require("./converters/convertScientificExpressionToSpokenWord");
+const convertUnitOnlyToSpokenWord_1 = require("./converters/convertUnitOnlyToSpokenWord");
+const validateExtractionResultObject_1 = require("./utils/validateExtractionResultObject");
+Object.defineProperty(exports, "validateExtractionResult", { enumerable: true, get: function () { return validateExtractionResultObject_1.validateExtractionResult; } });
+/**
+ * @namespace extractQuantities
+ * @description Contains functions for extracting numeric data from a string.
+ */
+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: patternExtractor_1.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: patternExtractor_1.extractAllMatches,
+};
+exports.extractQuantities = extractQuantities;
+/**
+ * @namespace convertQuantities
+ * @description Contains functions for converting (number || currency || unit || operator || scientific expression) data from a string or object to spoken word.
+ */
+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) => {
+        let result = "";
+        switch (extractionResult.matchType) {
+            case "number":
+                result = (0, convertNumberToSpokenWord_1.convertNumberToSpokenWord)(extractionResult);
+                break;
+            case "symbolCurrency":
+                result = (0, convertCurrencyToSpokenWord_1.convertCurrencyToSpokenWord)(extractionResult);
+                break;
+            case "codeCurrency":
+                result = (0, convertCurrencyToSpokenWord_1.convertCurrencyToSpokenWord)(extractionResult);
+                break;
+            case "unit":
+                result = (0, convertNumericUnitToSpokenWord_1.convertNumericUnitToSpokenWord)(extractionResult);
+                break;
+            case "unitOnly":
+                result = (0, convertUnitOnlyToSpokenWord_1.convertUnitOnlyToSpokenWord)(extractionResult);
+                break;
+            case "operator":
+                result = (0, convertOperatorToSpokenWord_1.convertOperatorToSpokenWord)(extractionResult);
+                break;
+            case "scientific":
+                result = (0, convertScientificExpressionToSpokenWord_1.convertScientificExpressionToSpokenWord)(extractionResult);
+                break;
+            default:
+                break;
+        }
+        return result;
+    },
+    /**
+     * 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) => {
+        const match = (0, patternExtractor_1.extractFirstMatch)(input);
+        if (!match)
+            return "";
+        return input.replace(match.input, convertQuantities.translateMatch(match));
+    },
+    /**
+     * 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) => {
+        const matches = (0, patternExtractor_1.extractAllMatches)(input);
+        if (matches.length === 0) {
+            return input;
+        }
+        let output = "";
+        let lastIndex = 0;
+        for (const match of matches) {
+            output += input.substring(lastIndex, match.index);
+            output += convertQuantities.translateMatch(match);
+            lastIndex = match.index + match.input.length;
+        }
+        output += input.substring(lastIndex);
+        return output.replace(/\s+/g, " ").trim();
+    },
+};
+exports.convertQuantities = convertQuantities;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,0EAA2F;AAC3F,0FAAuF;AACvF,sFAAmF;AACnF,gGAA6F;AAC7F,0FAAuF;AACvF,kHAA+G;AAC/G,0FAAuF;AAYvF,2FAAkF;AAiHlC,yGAjHvC,yDAAwB,OAiHuC;AA/GxE;;;GAGG;AACH,MAAM,iBAAiB,GAAG;IACxB;;;;OAIG;IACH,UAAU,EAAE,oCAAiB;IAC7B;;;;OAIG;IACH,UAAU,EAAE,oCAAiB;CAC9B,CAAC;AA8F2B,8CAAiB;AA5F9C;;;GAGG;AACH,MAAM,iBAAiB,GAAG;IACxB;;;;;OAKG;IACH;;;;;OAKG;IACH,cAAc,EAAE,CAAC,gBAAkC,EAAU,EAAE;QAC7D,IAAI,MAAM,GAAW,EAAE,CAAC;QAExB,QAAQ,gBAAgB,CAAC,SAAS,EAAE,CAAC;YACnC,KAAK,QAAQ;gBACX,MAAM,GAAG,IAAA,qDAAyB,EAAC,gBAA8B,CAAC,CAAC;gBACnE,MAAM;YAER,KAAK,gBAAgB;gBACnB,MAAM,GAAG,IAAA,yDAA2B,EAAC,gBAAgC,CAAC,CAAC;gBACvE,MAAM;YACR,KAAK,cAAc;gBACjB,MAAM,GAAG,IAAA,yDAA2B,EAAC,gBAAgC,CAAC,CAAC;gBACvE,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,GAAG,IAAA,+DAA8B,EAAC,gBAAkC,CAAC,CAAC;gBAC5E,MAAM;YACR,KAAK,UAAU;gBACb,MAAM,GAAG,IAAA,yDAA2B,EAAC,gBAAgC,CAAC,CAAC;gBACvE,MAAM;YACR,KAAK,UAAU;gBACb,MAAM,GAAG,IAAA,yDAA2B,EAAC,gBAAgC,CAAC,CAAC;gBACvE,MAAM;YACR,KAAK,YAAY;gBACf,MAAM,GAAG,IAAA,iFAAuC,EAAC,gBAAkC,CAAC,CAAC;gBACrF,MAAM;YAER;gBACE,MAAM;QACV,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,qBAAqB,EAAE,CAAC,KAAa,EAAU,EAAE;QAC/C,MAAM,KAAK,GAAG,IAAA,oCAAiB,EAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,qBAAqB,EAAE,CAAC,KAAa,EAAU,EAAE;QAC/C,MAAM,OAAO,GAAG,IAAA,oCAAiB,EAAC,KAAK,CAAC,CAAC;QAEzC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YAClD,MAAM,IAAI,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAClD,SAAS,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;QAC/C,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5C,CAAC;CACF,CAAC;AAEO,8CAAiB"}

package/dist/cjs/interfaces/configurations/default.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=default.js.map

package/dist/cjs/interfaces/configurations/default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default.js","sourceRoot":"","sources":["../../../../src/interfaces/configurations/default.ts"],"names":[],"mappings":""}

package/dist/cjs/interfaces/definitions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=definitions.js.map

package/dist/cjs/interfaces/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../../src/interfaces/definitions.ts"],"names":[],"mappings":""}

package/dist/cjs/utils/extraction/patternExtractor.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractFirstMatch = extractFirstMatch;
+exports.extractAllMatches = extractAllMatches;
+const regexPatterns_1 = require("./regexPatterns");
+/**
+ * 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
+ */
+function extractFirstMatch(input) {
+    const match = input.match(regexPatterns_1.regexMatches);
+    if (match && match.groups && match.index !== undefined) {
+        const matchedGroup = Object.fromEntries(Object.entries(match.groups).filter(([_, value]) => value !== undefined));
+        let matchType = Object.keys(matchedGroup)[0];
+        const extractedGroup = {};
+        switch (matchType) {
+            case "symbolCurrency":
+                extractedGroup.integer = matchedGroup["symbolInt"];
+                extractedGroup.decimal = matchedGroup["symbolDec"];
+                extractedGroup.negativeInt = matchedGroup["negativeSignSymbol"] !== undefined;
+                extractedGroup.currency = matchedGroup["currencySymbol"];
+                break;
+            case "codeCurrency":
+                extractedGroup.integer = matchedGroup["codeInt"];
+                extractedGroup.decimal = matchedGroup["codeDec"];
+                extractedGroup.negativeInt = matchedGroup["negativeSignCode"] !== undefined;
+                extractedGroup.currency = matchedGroup["currencyCode"];
+                break;
+            case "scientific":
+                extractedGroup.integer = matchedGroup["scientificInt"];
+                extractedGroup.decimal = matchedGroup["scientificDec"];
+                extractedGroup.negativeInt = matchedGroup["negativeSignScientific"] !== undefined;
+                extractedGroup.exponent = matchedGroup["scientificExponent"];
+                break;
+            case "unit":
+                extractedGroup.integer = matchedGroup["unitInt"];
+                extractedGroup.decimal = matchedGroup["unitDec"];
+                extractedGroup.negativeInt = matchedGroup["negativeSignUnit"] !== undefined;
+                extractedGroup.unit = matchedGroup["unitName"];
+                extractedGroup.exponent = matchedGroup["unitCaretExponentPre"] || matchedGroup["unitSuperExponentPre"];
+                extractedGroup.unitExponent = matchedGroup["unitCaretExponentPost"] || matchedGroup["unitSuperExponentPost"];
+                break;
+            case "unitOnly":
+                extractedGroup.unit = matchedGroup["unitNameOnly"];
+                extractedGroup.unitExponent = matchedGroup["unitOnlyCaretExponent"] || matchedGroup["unitOnlySuperExponent"];
+                break;
+            case "operator":
+                break;
+            case "number":
+                extractedGroup.integer = matchedGroup["integerInt"];
+                extractedGroup.decimal = matchedGroup["integerDec"];
+                extractedGroup.exponent = matchedGroup["integerSuperExponent"] || matchedGroup["integerCaretExponent"];
+                extractedGroup.negativeInt = matchedGroup["negativeSignInteger"] !== undefined;
+                break;
+            default:
+                break;
+        }
+        extractedGroup.matchType = matchType;
+        extractedGroup.input = matchedGroup[matchType];
+        extractedGroup.index = match.index;
+        if (matchType !== "operator" && matchType !== "scientific" && matchType !== "unitOnly")
+            extractedGroup.integer = extractedGroup.integer !== undefined ? extractedGroup.integer.replace(/,/g, "") : "0";
+        return extractedGroup;
+    }
+    return 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
+ */
+function extractAllMatches(input) {
+    const results = [];
+    let remainingInput = input;
+    let currentExtraction = extractFirstMatch(remainingInput);
+    while (currentExtraction !== null && currentExtraction.input) {
+        const remainingLength = input.length - remainingInput.length;
+        if (results.length > 0) {
+            currentExtraction.index = remainingInput.indexOf(currentExtraction.input) + remainingLength;
+        }
+        results.push(currentExtraction);
+        remainingInput = remainingInput.substring(remainingInput.indexOf(currentExtraction.input) + currentExtraction.input.length);
+        currentExtraction = extractFirstMatch(remainingInput);
+    }
+    return results;
+}
+//# sourceMappingURL=patternExtractor.js.map

package/dist/cjs/utils/extraction/patternExtractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patternExtractor.js","sourceRoot":"","sources":["../../../../src/utils/extraction/patternExtractor.ts"],"names":[],"mappings":";;AAYA,8CA+DC;AAYD,8CAsBC;AA7GD,mDAA+C;AAG/C;;;;;;;GAOG;AAEH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,4BAAY,CAAC,CAAC;IAExC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACvD,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC;QAClH,IAAI,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7C,MAAM,cAAc,GAAG,EAAsB,CAAC;QAE9C,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,gBAAgB;gBACnB,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;gBACnD,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;gBACnD,cAAc,CAAC,WAAW,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,SAAS,CAAC;gBAC9E,cAAc,CAAC,QAAQ,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;gBACzD,MAAM;YACR,KAAK,cAAc;gBACjB,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;gBACjD,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;gBACjD,cAAc,CAAC,WAAW,GAAG,YAAY,CAAC,kBAAkB,CAAC,KAAK,SAAS,CAAC;gBAC5E,cAAc,CAAC,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;gBACvD,MAAM;YACR,KAAK,YAAY;gBACf,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;gBACvD,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;gBACvD,cAAc,CAAC,WAAW,GAAG,YAAY,CAAC,wBAAwB,CAAC,KAAK,SAAS,CAAC;gBAClF,cAAc,CAAC,QAAQ,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;gBAC7D,MAAM;YACR,KAAK,MAAM;gBACT,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;gBACjD,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;gBACjD,cAAc,CAAC,WAAW,GAAG,YAAY,CAAC,kBAAkB,CAAC,KAAK,SAAS,CAAC;gBAC5E,cAAc,CAAC,IAAI,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;gBAC/C,cAAc,CAAC,QAAQ,GAAG,YAAY,CAAC,sBAAsB,CAAC,IAAI,YAAY,CAAC,sBAAsB,CAAC,CAAC;gBACvG,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC,uBAAuB,CAAC,IAAI,YAAY,CAAC,uBAAuB,CAAC,CAAC;gBAC7G,MAAM;YACR,KAAK,UAAU;gBACb,cAAc,CAAC,IAAI,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;gBACnD,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC,uBAAuB,CAAC,IAAI,YAAY,CAAC,uBAAuB,CAAC,CAAC;gBAC7G,MAAM;YACR,KAAK,UAAU;gBACb,MAAM;YACR,KAAK,QAAQ;gBACX,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;gBACpD,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;gBACpD,cAAc,CAAC,QAAQ,GAAG,YAAY,CAAC,sBAAsB,CAAC,IAAI,YAAY,CAAC,sBAAsB,CAAC,CAAC;gBACvG,cAAc,CAAC,WAAW,GAAG,YAAY,CAAC,qBAAqB,CAAC,KAAK,SAAS,CAAC;gBAC/E,MAAM;YACR;gBACE,MAAM;QACV,CAAC;QAED,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;QACrC,cAAc,CAAC,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;QAC/C,cAAc,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAEnC,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,YAAY,IAAI,SAAS,KAAK,UAAU;YACpF,cAAc,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAEjH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,MAAM,OAAO,GAAuB,EAAE,CAAC;IACvC,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,iBAAiB,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAE1D,OAAO,iBAAiB,KAAK,IAAI,IAAI,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC7D,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;QAE7D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,iBAAiB,CAAC,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC;QAC9F,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAEhC,cAAc,GAAG,cAAc,CAAC,SAAS,CACvC,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,MAAM,CACjF,CAAC;QAEF,iBAAiB,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/cjs/utils/extraction/regexPatterns.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.regexMatches = void 0;
+const default_1 = require("../../config/default");
+const sanitizeString = (str) => {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+};
+// Dynamic pattern generation from config
+const currencySymbolsSanitized = Object.keys(default_1.currencySymbols)
+    .map((key) => sanitizeString(key)) // Escape special regex characters
+    .join("|");
+const currencyCodesSanitized = Object.keys(default_1.currencyCodes).join("|");
+const allUnits = Object.keys(default_1.units)
+    .map((key) => sanitizeString(key))
+    .sort((a, b) => b.length - a.length)
+    .join("|");
+const operatorSymbols = Object.keys(default_1.math)
+    .map((operator) => sanitizeString(operator))
+    .join("|");
+const regexMatches = new RegExp([
+    // Currency Matching (Highest Priority)
+    `(?<=^|\\s)(?:` + // Ensures the match is at the beginning of the string or preceded by whitespace
+        `(?<symbolCurrency>(?<negativeSignSymbol>-)?(?<currencySymbol>${currencySymbolsSanitized})\\s*(?<symbolInt>(?:\\d{1,3}(?:,\\d{3})*|\\d+))(?:\\.(?<symbolDec>\\d+))?)` + // Matches currency with symbols
+        `|` + // OR
+        `(?<codeCurrency>(?<negativeSignCode>-)?(?<codeInt>(?:\\d{1,3}(?:,\\d{3})*|\\d+))(?:\\.(?<codeDec>\\d+))?[ \\t]*(?<currencyCode>${currencyCodesSanitized}))` + // Matches currency with codes
+        `)` + // End of currency matching group
+        `(?=(?:\\s|$|(?:\\.(?!\\d))|[^\\d.]))`, // Ensures the match is followed by whitespace, end of string, or non-numeric characters
+    // Scientific Notation 5e-10, 5e10, 5.5e10, 5.5e-10
+    `|(?<scientific>` + // Group for scientific notation
+        `(?<negativeSignScientific>-)?(?<scientificInt>\\d+)(?:\\.(?<scientificDec>\\d+))?(?:[eE])(?<scientificExponent>[+-]?\\d+)` + // Matches scientific notation format
+        `)(?=(?:\\s|$|(?:\\.(?!\\d))|[^\\d.]))`, // Ensures the match is followed by whitespace, end of string, or non-numeric characters
+    // Numeric Units 5km, 10m/s, 10m/s^2, 10m/s², 10m²/s, 10m²/s²
+    `|(?<unit>` + // Group for units
+        `(?<negativeSignUnit>-)?(?<unitInt>(?:\\d{1,3}(?:,\\d{3})*|\\d+))(?:\\.(?<unitDec>\\d+))?` + // Matches the number part of the unit
+        `\\s*` + // Matches optional whitespace
+        `(?:` + // Group for handling exponents (caret or superscript)
+        `\\^(?<unitCaretExponentPre>-?\\d+)|` + // Matches caret exponent
+        `(?<unitSuperExponentPre>⁻?[¹²³⁴⁵⁶⁷⁸⁹])` + // Matches superscript exponent
+        `)?` + // End of exponent group
+        `\\s*(?<unitName>(?:${allUnits}))` + // Matches the unit name
+        `(?:` + // Group for handling exponents (caret or superscript)
+        `\\^(?<unitCaretExponentPost>-?\\d+)|` + // Matches caret exponent
+        `(?<unitSuperExponentPost>⁻?[¹²³⁴⁵⁶⁷⁸⁹])` + // Matches superscript exponent
+        `)?` + // End of exponent group
+        `)(?=(?:\\s|$|(?:\\.(?!\\d))|[^\\d.]))`, // Ensures the match is followed by whitespace, end of string, or non-numeric characters
+    // Number with optional exponent
+    `|(?<!\\w)(?<number>` + // Group for number
+        `(?<negativeSignInteger>-)?` + // Matches an optional negative sign
+        `(?<integerInt>(?:\\d{1,3}(?:,\\d{3})*|\\d+))` + // Matches the integer part of the number
+        `(?:\\.(?<integerDec>\\d+))?` + // Matches the decimal part of the number
+        `(?:(?:\\^(?<integerCaretExponent>-?\\d+))|` + // Matches exponent with caret
+        `(?<integerSuperExponent>⁻?[¹²³⁴⁵⁶⁷⁸⁹]))?` + // Matches exponent with superscript
+        `)(?=(?:\\s|$|(?:\\.(?!\\d))|[^\\d.]))`, // Ensures the match is followed by whitespace, end of string, or non-numeric characters
+    // Unit Only (e.g., m, kg, m², kg³)
+    `|(?<unitOnly>` + // Group for unit only
+        `(?<![\\w.])` + // Negative lookbehind to prevent matching units within words
+        `(?<unitNameOnly>(?:${allUnits})\\b)` + // Matches the unit name
+        `(?:\\^(?<unitOnlyCaretExponent>-?\\d+)|(?<unitOnlySuperExponent>⁻?[¹²³⁴⁵⁶⁷⁸⁹]))?` + // Matches optional exponent
+        `(?!\\w)` + // Negative lookahead to prevent matching units within words
+        `)(?=(?:\\s|$|(?:\\.(?!\\d))|[^\\d.]))`, // Ensures the match is followed by whitespace, end of string, or non-numeric characters
+    // Mathematical Operators
+    `|(?<operator>(?:(?<=^)|(?<=\\s))(${operatorSymbols})(?=\\s|$|(?:\\.(?!\\d))))`, // Matches mathematical operators
+].join(""), "u");
+exports.regexMatches = regexMatches;
+//# sourceMappingURL=regexPatterns.js.map

package/dist/cjs/utils/extraction/regexPatterns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexPatterns.js","sourceRoot":"","sources":["../../../../src/utils/extraction/regexPatterns.ts"],"names":[],"mappings":";;;AAAA,kDAK8B;AAE9B,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE;IAC7C,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF,yCAAyC;AACzC,MAAM,wBAAwB,GAAG,MAAM,CAAC,IAAI,CAAC,yBAAe,CAAC;KAC1D,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,kCAAkC;KACpE,IAAI,CAAC,GAAG,CAAC,CAAC;AACb,MAAM,sBAAsB,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEpE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,eAAK,CAAC;KAChC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;KACjC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;KACnC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEb,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,cAAI,CAAC;KACtC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;KAC3C,IAAI,CAAC,GAAG,CAAC,CAAC;AAEb,MAAM,YAAY,GAAG,IAAI,MAAM,CAC7B;IACE,uCAAuC;IACvC,eAAe,GAAG,gFAAgF;QAChG,gEAAgE,wBAAwB,6EAA6E,GAAG,gCAAgC;QACxM,GAAG,GAAG,KAAK;QACX,kIAAkI,sBAAsB,IAAI,GAAG,8BAA8B;QAC7L,GAAG,GAAG,iCAAiC;QACvC,sCAAsC,EAAE,wFAAwF;IAElI,mDAAmD;IACnD,iBAAiB,GAAG,gCAAgC;QAClD,2HAA2H,GAAG,qCAAqC;QACnK,uCAAuC,EAAE,wFAAwF;IAEnI,6DAA6D;IAC7D,WAAW,GAAG,kBAAkB;QAC9B,0FAA0F,GAAG,sCAAsC;QACnI,MAAM,GAAG,8BAA8B;QACvC,KAAK,GAAG,sDAAsD;QAC9D,qCAAqC,GAAG,yBAAyB;QACjE,wCAAwC,GAAG,+BAA+B;QAC1E,IAAI,GAAG,wBAAwB;QAC/B,sBAAsB,QAAQ,IAAI,GAAG,wBAAwB;QAC7D,KAAK,GAAG,sDAAsD;QAC9D,sCAAsC,GAAG,yBAAyB;QAClE,yCAAyC,GAAG,+BAA+B;QAC3E,IAAI,GAAG,wBAAwB;QAC/B,uCAAuC,EAAE,wFAAwF;IAEnI,gCAAgC;IAChC,qBAAqB,GAAG,mBAAmB;QACzC,4BAA4B,GAAG,oCAAoC;QACnE,8CAA8C,GAAG,yCAAyC;QAC1F,6BAA6B,GAAG,yCAAyC;QACzE,4CAA4C,GAAG,8BAA8B;QAC7E,0CAA0C,GAAG,oCAAoC;QACjF,uCAAuC,EAAE,wFAAwF;IAEnI,mCAAmC;IACnC,eAAe,GAAG,sBAAsB;QACtC,aAAa,GAAG,6DAA6D;QAC7E,sBAAsB,QAAQ,OAAO,GAAG,wBAAwB;QAChE,kFAAkF,GAAG,4BAA4B;QACjH,SAAS,GAAG,4DAA4D;QACxE,uCAAuC,EAAE,wFAAwF;IACnI,yBAAyB;IACzB,oCAAoC,eAAe,4BAA4B,EAAE,iCAAiC;CACnH,CAAC,IAAI,CAAC,EAAE,CAAC,EACV,GAAG,CACJ,CAAC;AAEO,oCAAY"}

package/dist/cjs/utils/parseSuperscript.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toRegularInteger = toRegularInteger;
+/**
+ * Converts a string of superscript digits to regular integer string.
+ * @param {string} superscriptString - String containing superscript digits.
+ * @returns {string} - String of regular digits.
+ */
+function toRegularInteger(superscriptString) {
+    const superscriptMap = {
+        "⁰": "0",
+        "¹": "1",
+        "²": "2",
+        "³": "3",
+        "⁴": "4",
+        "⁵": "5",
+        "⁶": "6",
+        "⁷": "7",
+        "⁸": "8",
+        "⁹": "9",
+    };
+    let standardDigitString = "";
+    for (let char of superscriptString) {
+        if (superscriptMap[char]) {
+            standardDigitString += superscriptMap[char];
+        }
+        else {
+            standardDigitString += char;
+        }
+    }
+    return standardDigitString;
+}
+//# sourceMappingURL=parseSuperscript.js.map

package/dist/cjs/utils/parseSuperscript.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseSuperscript.js","sourceRoot":"","sources":["../../../src/utils/parseSuperscript.ts"],"names":[],"mappings":";;AAKA,4CAwBC;AA7BD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,iBAAyB;IACxD,MAAM,cAAc,GAA8B;QAChD,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;KACT,CAAC;IAEF,IAAI,mBAAmB,GAAG,EAAE,CAAC;IAC7B,KAAK,IAAI,IAAI,IAAI,iBAAiB,EAAE,CAAC;QACnC,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,mBAAmB,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,mBAAmB,IAAI,IAAI,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,OAAO,mBAAmB,CAAC;AAC7B,CAAC"}

package/dist/cjs/utils/stringBuilding/exponent.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exponentSpokenWord = exponentSpokenWord;
+const parseSuperscript_1 = require("../parseSuperscript");
+const positiveInteger_1 = require("./positiveInteger");
+/** * Converts an exponent integer to its spoken word representation, * optionally using "squared" and "cubed" for exponents 2 and 3. * @param exponent The exponent value as an integer. * @param onlyUsePowerOf A boolean flag. If false, uses "squared" for 2 and "cubed" for 3. * If true, uses "to the power of two", "to the power of three", etc. * @returns The spoken word representation of the exponent. */
+function exponentSpokenWord(exponent, onlyUsePowerOf = false) {
+    const isNegative = exponent.startsWith("-") || exponent.startsWith("⁻");
+    let newExponentString = (0, parseSuperscript_1.toRegularInteger)(isNegative ? exponent.slice(1) : exponent);
+    if (!onlyUsePowerOf && !isNegative) {
+        if (newExponentString === "2") {
+            return "squared";
+        }
+        if (newExponentString === "3") {
+            return "cubed";
+        }
+    }
+    let res = "to the power of " + (isNegative ? "negative " : "") + (0, positiveInteger_1.positiveInteger)(parseInt(newExponentString));
+    return res;
+}
+//# sourceMappingURL=exponent.js.map

package/dist/cjs/utils/stringBuilding/exponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exponent.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/exponent.ts"],"names":[],"mappings":";;AAKA,gDAaC;AAlBD,0DAAuD;AACvD,uDAAoD;AAEpD,sZAAsZ;AAEtZ,SAAgB,kBAAkB,CAAC,QAAgB,EAAE,iBAA0B,KAAK;IAClF,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACxE,IAAI,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACpF,IAAI,CAAC,cAAc,IAAI,CAAC,UAAU,EAAE,CAAC;QACnC,IAAI,iBAAiB,KAAK,GAAG,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,iBAAiB,KAAK,GAAG,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IACD,IAAI,GAAG,GAAG,kBAAkB,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAA,iCAAe,EAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC9G,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/cjs/utils/stringBuilding/negative.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.negative = void 0;
+const negative = (bool) => {
+    return bool ? "negative " : "";
+};
+exports.negative = negative;
+//# sourceMappingURL=negative.js.map

package/dist/cjs/utils/stringBuilding/negative.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"negative.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/negative.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CAAC,IAAa,EAAU,EAAE;IAChD,OAAO,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AACjC,CAAC,CAAC;AAFW,QAAA,QAAQ,YAEnB"}

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.perDigit = perDigit;
+const positiveInteger_1 = require("./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"
+ */
+function perDigit(num) {
+    const words = [];
+    for (let i = 0; i < num.length; i++) {
+        words.push((0, positiveInteger_1.positiveInteger)(parseInt(num[i])));
+    }
+    return words.join(" ");
+}
+//# sourceMappingURL=perDigit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perDigit.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/perDigit.ts"],"names":[],"mappings":";;AASA,4BAMC;AAfD,uDAAoD;AAEpD;;;;;GAKG;AAEH,SAAgB,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,IAAA,iCAAe,EAAC,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/cjs/utils/stringBuilding/positiveInteger.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.positiveInteger = positiveInteger;
+const default_1 = require("../../config/default");
+const zeroTo999_1 = require("./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.
+ */
+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 = (0, zeroTo999_1.zeroTo999)(num % 1000);
+            const magnitudeScale = default_1.numbers.scales[scaleIndex] ? " " + default_1.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/cjs/utils/stringBuilding/positiveInteger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"positiveInteger.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/positiveInteger.ts"],"names":[],"mappings":";;AASA,0CAuBC;AAhCD,kDAA+C;AAC/C,2CAAwC;AAExC;;;;GAIG;AAEH,SAAgB,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,IAAA,qBAAS,EAAC,GAAG,GAAG,IAAI,CAAC,CAAC;YAC3C,MAAM,cAAc,GAAG,iBAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,iBAAO,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/cjs/utils/stringBuilding/twoDigits.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.twoDigit = twoDigit;
+const positiveInteger_1 = require("./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.
+ */
+function twoDigit(num) {
+    if (num.trim().length !== 2)
+        return "";
+    let parsed = parseInt(num);
+    if (parsed < 100 && parsed >= 0)
+        return (0, positiveInteger_1.positiveInteger)(parsed);
+    return "";
+}
+//# sourceMappingURL=twoDigits.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"twoDigits.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/twoDigits.ts"],"names":[],"mappings":";;AAQA,4BAMC;AAdD,uDAAoD;AAEpD;;;;GAIG;AAEH,SAAgB,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,IAAA,iCAAe,EAAC,MAAM,CAAC,CAAC;IAChE,OAAO,EAAE,CAAC;AACZ,CAAC"}

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zeroTo999 = zeroTo999;
+const default_1 = require("../../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.
+ */
+function zeroTo999(num) {
+    if (num === 0) {
+        return "";
+    }
+    let words = "";
+    if (num >= 100) {
+        words += default_1.numbers.ones[Math.floor(num / 100)] + " hundred";
+        num %= 100;
+        if (num > 0) {
+            words += " ";
+        }
+    }
+    if (num >= 20) {
+        words += default_1.numbers.tens[Math.floor(num / 10)];
+        num %= 10;
+        if (num > 0) {
+            words += " " + default_1.numbers.ones[num];
+        }
+    }
+    else if (num >= 10) {
+        words += default_1.numbers.teens[num - 10];
+    }
+    else if (num > 0) {
+        words += default_1.numbers.ones[num];
+    }
+    return words;
+}
+//# sourceMappingURL=zeroTo999.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"zeroTo999.js","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/zeroTo999.ts"],"names":[],"mappings":";;AAQA,8BA4BC;AApCD,kDAA+C;AAE/C;;;;GAIG;AAEH,SAAgB,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,iBAAO,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,iBAAO,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,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;SAAM,IAAI,GAAG,IAAI,EAAE,EAAE,CAAC;QACrB,KAAK,IAAI,iBAAO,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;IACnC,CAAC;SAAM,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACnB,KAAK,IAAI,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}