stringzy 2.2.1 → 4.0.0

package/dist/tests/validations/isURL.test.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const node_assert_1 = __importDefault(require("node:assert"));
+const isURL_1 = require("../../validations/isURL");
+(0, node_test_1.describe)('isURL', () => {
+    (0, node_test_1.it)('returns true for valid URLs', () => {
+        node_assert_1.default.strictEqual((0, isURL_1.isURL)('https://example.com'), true);
+        node_assert_1.default.strictEqual((0, isURL_1.isURL)('http://localhost:3000'), true);
+    });
+    (0, node_test_1.it)('returns false for invalid URLs', () => {
+        node_assert_1.default.strictEqual((0, isURL_1.isURL)('not a url'), false);
+        node_assert_1.default.strictEqual((0, isURL_1.isURL)(''), false);
+    });
+});

package/dist/transformations/camelCase.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Converts a given string into camelCase format.
+ *
+ * This function normalizes the input by:
+ * - Converting it to lowercase
+ * - Removing special characters (except alphanumeric and underscores)
+ * - Replacing underscores and multiple spaces with single spaces
+ * - Capitalizing each word except the first
+ * - Removing all spaces to form a camelCased result
+ *
+ * If the input is `null` or `undefined`, an empty string is returned.
+ *
+ * @param {string} text - The input string to convert.
+ * @returns {string} The camelCased version of the input string.
+ *
+ * @example
+ * camelCase("Hello world"); // "helloWorld"
+ *
+ * @example
+ * camelCase("  convert_to-camel case!! "); // "convertToCamelCase"
+ *
+ * @example
+ * camelCase(""); // ""
+ */
+export declare function camelCase(text: string): string;

package/dist/transformations/camelCase.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.camelCase = camelCase;
+/**
+ * Converts a given string into camelCase format.
+ *
+ * This function normalizes the input by:
+ * - Converting it to lowercase
+ * - Removing special characters (except alphanumeric and underscores)
+ * - Replacing underscores and multiple spaces with single spaces
+ * - Capitalizing each word except the first
+ * - Removing all spaces to form a camelCased result
+ *
+ * If the input is `null` or `undefined`, an empty string is returned.
+ *
+ * @param {string} text - The input string to convert.
+ * @returns {string} The camelCased version of the input string.
+ *
+ * @example
+ * camelCase("Hello world"); // "helloWorld"
+ *
+ * @example
+ * camelCase("  convert_to-camel case!! "); // "convertToCamelCase"
+ *
+ * @example
+ * camelCase(""); // ""
+ */
+function camelCase(text) {
+    if (text == null)
+        return '';
+    return text
+        .trim()
+        .toLowerCase()
+        .replace(/[^\w\s]/g, ' ')
+        .replace(/_/g, ' ')
+        .replace(/\s+/g, ' ')
+        .replace(/\s(.)/g, (_, character) => character.toUpperCase())
+        .replace(/^(.)/, (_, character) => character.toLowerCase());
+}

package/dist/transformations/capitalizeWords.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Capitalizes the first letter of every word in a given string.
+ *
+ * A word is identified by word boundaries (`\b`), and only the first character
+ * of each word is converted to uppercase. The rest of the characters remain unchanged.
+ *
+ * Throws an error if the input is not a string.
+ *
+ * @param {string} text - The input string whose words will be capitalized.
+ * @returns {string} A new string with each word's first character in uppercase.
+ * @throws {Error} If the input is not a string.
+ *
+ * @example
+ * capitalizeWords("hello world"); // "Hello World"
+ *
+ * @example
+ * capitalizeWords("javaScript is fun!"); // "JavaScript Is Fun!"
+ *
+ * @example
+ * capitalizeWords(""); // ""
+ */
+export declare function capitalizeWords(text: string): string;

package/dist/transformations/capitalizeWords.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalizeWords = capitalizeWords;
+/**
+ * Capitalizes the first letter of every word in a given string.
+ *
+ * A word is identified by word boundaries (`\b`), and only the first character
+ * of each word is converted to uppercase. The rest of the characters remain unchanged.
+ *
+ * Throws an error if the input is not a string.
+ *
+ * @param {string} text - The input string whose words will be capitalized.
+ * @returns {string} A new string with each word's first character in uppercase.
+ * @throws {Error} If the input is not a string.
+ *
+ * @example
+ * capitalizeWords("hello world"); // "Hello World"
+ *
+ * @example
+ * capitalizeWords("javaScript is fun!"); // "JavaScript Is Fun!"
+ *
+ * @example
+ * capitalizeWords(""); // ""
+ */
+function capitalizeWords(text) {
+    if (typeof text !== 'string') {
+        throw new Error('Invalid argument. Expected a string.');
+    }
+    return text.replace(/\b\w/g, (char) => char.toUpperCase());
+}

package/dist/transformations/constantCase.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Converts a given string to CONSTANT_CASE format.
+ *
+ * The transformation includes:
+ * - Trimming whitespace from both ends
+ * - Replacing spaces and hyphens with underscores
+ * - Inserting underscores between lowercase and uppercase letter boundaries (e.g., `fooBar` → `FOO_BAR`)
+ * - Replacing all non-word characters with underscores
+ * - Converting the entire string to uppercase
+ * - Collapsing multiple underscores into one
+ * - Removing leading and trailing underscores
+ *
+ * If the input is `null` or `undefined`, it returns an empty string.
+ *
+ * @param {string} text - The input string to convert.
+ * @returns {string} The transformed CONSTANT_CASE string.
+ *
+ * @example
+ * constantCase("hello world"); // "HELLO_WORLD"
+ *
+ * @example
+ * constantCase("camelCaseText"); // "CAMEL_CASE_TEXT"
+ *
+ * @example
+ * constantCase("  convert-to_CONSTANT.case!  "); // "CONVERT_TO_CONSTANT_CASE"
+ */
+export declare function constantCase(text: string): string;

package/dist/transformations/constantCase.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constantCase = constantCase;
+/**
+ * Converts a given string to CONSTANT_CASE format.
+ *
+ * The transformation includes:
+ * - Trimming whitespace from both ends
+ * - Replacing spaces and hyphens with underscores
+ * - Inserting underscores between lowercase and uppercase letter boundaries (e.g., `fooBar` → `FOO_BAR`)
+ * - Replacing all non-word characters with underscores
+ * - Converting the entire string to uppercase
+ * - Collapsing multiple underscores into one
+ * - Removing leading and trailing underscores
+ *
+ * If the input is `null` or `undefined`, it returns an empty string.
+ *
+ * @param {string} text - The input string to convert.
+ * @returns {string} The transformed CONSTANT_CASE string.
+ *
+ * @example
+ * constantCase("hello world"); // "HELLO_WORLD"
+ *
+ * @example
+ * constantCase("camelCaseText"); // "CAMEL_CASE_TEXT"
+ *
+ * @example
+ * constantCase("  convert-to_CONSTANT.case!  "); // "CONVERT_TO_CONSTANT_CASE"
+ */
+function constantCase(text) {
+    if (text == null)
+        return '';
+    return text
+        .trim()
+        .replace(/[\s-]+/g, '_')
+        .replace(/([a-z])([A-Z])/g, '$1_$2')
+        .replace(/[^\w_]/g, '_')
+        .toUpperCase()
+        .replace(/_+/g, '_')
+        .replace(/^_+|_+$/g, '');
+}

package/dist/transformations/deburr.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes accents and diacritics from letters in a string.
+ * @param str - Input string
+ * @returns A deburred string without accented characters.
+ * @throws Error if input is not a string
+ */
+export declare function deburr(str: string): string;

package/dist/transformations/deburr.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deburr = deburr;
+/**
+ * Removes accents and diacritics from letters in a string.
+ * @param str - Input string
+ * @returns A deburred string without accented characters.
+ * @throws Error if input is not a string
+ */
+function deburr(str) {
+    if (typeof str !== 'string') {
+        throw new Error('Input must be a string');
+    }
+    // Normalize and strip combining marks (diacritics)
+    return str.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
+}

package/dist/transformations/escapeHTML.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Escapes special HTML characters in a string to their corresponding HTML entities.
+ *
+ * This function replaces the following characters:
+ * - `&` with `&`
+ * - `<` with `&lt;`
+ * - `>` with `&gt;`
+ * - `"` with `&quot;`
+ * - `'` with `&#39;`
+ *
+ * This is useful to prevent HTML injection or XSS attacks when inserting user input into HTML.
+ *
+ * @param {string} str - The string to escape.
+ * @returns {string} The escaped string with HTML entities.
+ *
+ * @example
+ * escapeHtml('<div class="test">Hello & Welcome</div>');
+ * // "&lt;div class=&quot;test&quot;&gt;Hello &amp; Welcome&lt;/div&gt;"
+ *
+ * @example
+ * escapeHtml("It's a test!");
+ * // "It&#39;s a test!"
+ */
+export declare function escapeHtml(str: string): string;

package/dist/transformations/escapeHTML.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeHtml = escapeHtml;
+/**
+ * Escapes special HTML characters in a string to their corresponding HTML entities.
+ *
+ * This function replaces the following characters:
+ * - `&` with `&`
+ * - `<` with `&lt;`
+ * - `>` with `&gt;`
+ * - `"` with `&quot;`
+ * - `'` with `&#39;`
+ *
+ * This is useful to prevent HTML injection or XSS attacks when inserting user input into HTML.
+ *
+ * @param {string} str - The string to escape.
+ * @returns {string} The escaped string with HTML entities.
+ *
+ * @example
+ * escapeHtml('<div class="test">Hello & Welcome</div>');
+ * // "&lt;div class=&quot;test&quot;&gt;Hello &amp; Welcome&lt;/div&gt;"
+ *
+ * @example
+ * escapeHtml("It's a test!");
+ * // "It&#39;s a test!"
+ */
+function escapeHtml(str) {
+    const htmlEscapes = {
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+        '"': '&quot;',
+        "'": '&#39;',
+    };
+    return str.replace(/[&<>"']/g, (match) => htmlEscapes[match]);
+}

package/dist/transformations/index.d.ts

@@ -0,0 +1,52 @@
+export { camelCase } from './camelCase';
+export { capitalizeWords } from './capitalizeWords';
+export { constantCase } from './constantCase';
+export { initials } from './initials';
+export { kebabCase } from './kebabCase';
+export { pascalCase } from './pascalCase';
+export { removeDuplicates } from './removeDuplicates';
+export { removeSpecialChars } from './removeSpecialChars';
+export { removeWords } from './removeWords';
+export { snakeCase } from './snakeCase';
+export { titleCase } from './titleCase';
+export { toSlug } from './toSlug';
+export { truncateText } from './truncateText';
+export { escapeHtml } from './escapeHTML';
+export { maskSegment } from './maskSegment';
+export { numberToText } from './numberToText/main';
+import { camelCase } from './camelCase';
+import { capitalizeWords } from './capitalizeWords';
+import { constantCase } from './constantCase';
+import { initials } from './initials';
+import { kebabCase } from './kebabCase';
+import { pascalCase } from './pascalCase';
+import { removeDuplicates } from './removeDuplicates';
+import { removeSpecialChars } from './removeSpecialChars';
+import { removeWords } from './removeWords';
+import { snakeCase } from './snakeCase';
+import { titleCase } from './titleCase';
+import { toSlug } from './toSlug';
+import { truncateText } from './truncateText';
+import { escapeHtml } from './escapeHTML';
+import { maskSegment } from './maskSegment';
+import { deburr } from './deburr';
+import { numberToText } from './numberToText/main';
+export declare const transformations: {
+    camelCase: typeof camelCase;
+    capitalizeWords: typeof capitalizeWords;
+    constantCase: typeof constantCase;
+    initials: typeof initials;
+    kebabCase: typeof kebabCase;
+    pascalCase: typeof pascalCase;
+    removeDuplicates: typeof removeDuplicates;
+    removeSpecialChars: typeof removeSpecialChars;
+    removeWords: typeof removeWords;
+    snakeCase: typeof snakeCase;
+    titleCase: typeof titleCase;
+    toSlug: typeof toSlug;
+    truncateText: typeof truncateText;
+    escapeHtml: typeof escapeHtml;
+    maskSegment: typeof maskSegment;
+    deburr: typeof deburr;
+    numberToText: typeof numberToText;
+};

package/dist/transformations/index.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformations = exports.numberToText = exports.maskSegment = exports.escapeHtml = exports.truncateText = exports.toSlug = exports.titleCase = exports.snakeCase = exports.removeWords = exports.removeSpecialChars = exports.removeDuplicates = exports.pascalCase = exports.kebabCase = exports.initials = exports.constantCase = exports.capitalizeWords = exports.camelCase = void 0;
+var camelCase_1 = require("./camelCase");
+Object.defineProperty(exports, "camelCase", { enumerable: true, get: function () { return camelCase_1.camelCase; } });
+var capitalizeWords_1 = require("./capitalizeWords");
+Object.defineProperty(exports, "capitalizeWords", { enumerable: true, get: function () { return capitalizeWords_1.capitalizeWords; } });
+var constantCase_1 = require("./constantCase");
+Object.defineProperty(exports, "constantCase", { enumerable: true, get: function () { return constantCase_1.constantCase; } });
+var initials_1 = require("./initials");
+Object.defineProperty(exports, "initials", { enumerable: true, get: function () { return initials_1.initials; } });
+var kebabCase_1 = require("./kebabCase");
+Object.defineProperty(exports, "kebabCase", { enumerable: true, get: function () { return kebabCase_1.kebabCase; } });
+var pascalCase_1 = require("./pascalCase");
+Object.defineProperty(exports, "pascalCase", { enumerable: true, get: function () { return pascalCase_1.pascalCase; } });
+var removeDuplicates_1 = require("./removeDuplicates");
+Object.defineProperty(exports, "removeDuplicates", { enumerable: true, get: function () { return removeDuplicates_1.removeDuplicates; } });
+var removeSpecialChars_1 = require("./removeSpecialChars");
+Object.defineProperty(exports, "removeSpecialChars", { enumerable: true, get: function () { return removeSpecialChars_1.removeSpecialChars; } });
+var removeWords_1 = require("./removeWords");
+Object.defineProperty(exports, "removeWords", { enumerable: true, get: function () { return removeWords_1.removeWords; } });
+var snakeCase_1 = require("./snakeCase");
+Object.defineProperty(exports, "snakeCase", { enumerable: true, get: function () { return snakeCase_1.snakeCase; } });
+var titleCase_1 = require("./titleCase");
+Object.defineProperty(exports, "titleCase", { enumerable: true, get: function () { return titleCase_1.titleCase; } });
+var toSlug_1 = require("./toSlug");
+Object.defineProperty(exports, "toSlug", { enumerable: true, get: function () { return toSlug_1.toSlug; } });
+var truncateText_1 = require("./truncateText");
+Object.defineProperty(exports, "truncateText", { enumerable: true, get: function () { return truncateText_1.truncateText; } });
+var escapeHTML_1 = require("./escapeHTML");
+Object.defineProperty(exports, "escapeHtml", { enumerable: true, get: function () { return escapeHTML_1.escapeHtml; } });
+var maskSegment_1 = require("./maskSegment");
+Object.defineProperty(exports, "maskSegment", { enumerable: true, get: function () { return maskSegment_1.maskSegment; } });
+var main_1 = require("./numberToText/main");
+Object.defineProperty(exports, "numberToText", { enumerable: true, get: function () { return main_1.numberToText; } });
+const camelCase_2 = require("./camelCase");
+const capitalizeWords_2 = require("./capitalizeWords");
+const constantCase_2 = require("./constantCase");
+const initials_2 = require("./initials");
+const kebabCase_2 = require("./kebabCase");
+const pascalCase_2 = require("./pascalCase");
+const removeDuplicates_2 = require("./removeDuplicates");
+const removeSpecialChars_2 = require("./removeSpecialChars");
+const removeWords_2 = require("./removeWords");
+const snakeCase_2 = require("./snakeCase");
+const titleCase_2 = require("./titleCase");
+const toSlug_2 = require("./toSlug");
+const truncateText_2 = require("./truncateText");
+const escapeHTML_2 = require("./escapeHTML");
+const maskSegment_2 = require("./maskSegment");
+const deburr_1 = require("./deburr");
+const main_2 = require("./numberToText/main");
+exports.transformations = {
+    camelCase: camelCase_2.camelCase,
+    capitalizeWords: capitalizeWords_2.capitalizeWords,
+    constantCase: constantCase_2.constantCase,
+    initials: initials_2.initials,
+    kebabCase: kebabCase_2.kebabCase,
+    pascalCase: pascalCase_2.pascalCase,
+    removeDuplicates: removeDuplicates_2.removeDuplicates,
+    removeSpecialChars: removeSpecialChars_2.removeSpecialChars,
+    removeWords: removeWords_2.removeWords,
+    snakeCase: snakeCase_2.snakeCase,
+    titleCase: titleCase_2.titleCase,
+    toSlug: toSlug_2.toSlug,
+    truncateText: truncateText_2.truncateText,
+    escapeHtml: escapeHTML_2.escapeHtml,
+    maskSegment: maskSegment_2.maskSegment,
+    deburr: deburr_1.deburr,
+    numberToText: main_2.numberToText
+};

package/dist/transformations/initials.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Extracts the initials from a given string.
+ *
+ * Splits the input text by whitespace, takes the first character of each word,
+ * and joins them together. Optionally limits the number of initials returned.
+ *
+ * Throws an error if the input is not a string or if the `limit` parameter
+ * is provided but not a non-negative number.
+ *
+ * @param {string} text - The input string from which to extract initials.
+ * @param {number} [limit] - Optional maximum number of initials to return.
+ * @returns {string} A string containing the initials.
+ * @throws {TypeError} If `text` is not a string.
+ * @throws {Error} If `limit` is provided and is not a non-negative number.
+ *
+ * @example
+ * initials("John Doe"); // "JD"
+ *
+ * @example
+ * initials("John Ronald Reuel Tolkien", 2); // "JR"
+ *
+ * @example
+ * initials(" singleWord "); // "s"
+ *
+ * @example
+ * initials(""); // ""
+ */
+export declare function initials(text: string, limit?: number): string;

package/dist/transformations/initials.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initials = initials;
+/**
+ * Extracts the initials from a given string.
+ *
+ * Splits the input text by whitespace, takes the first character of each word,
+ * and joins them together. Optionally limits the number of initials returned.
+ *
+ * Throws an error if the input is not a string or if the `limit` parameter
+ * is provided but not a non-negative number.
+ *
+ * @param {string} text - The input string from which to extract initials.
+ * @param {number} [limit] - Optional maximum number of initials to return.
+ * @returns {string} A string containing the initials.
+ * @throws {TypeError} If `text` is not a string.
+ * @throws {Error} If `limit` is provided and is not a non-negative number.
+ *
+ * @example
+ * initials("John Doe"); // "JD"
+ *
+ * @example
+ * initials("John Ronald Reuel Tolkien", 2); // "JR"
+ *
+ * @example
+ * initials(" singleWord "); // "s"
+ *
+ * @example
+ * initials(""); // ""
+ */
+function initials(text, limit) {
+    if (typeof text !== 'string') {
+        throw new TypeError('Input must be a string');
+    }
+    if (limit !== undefined && (typeof limit !== 'number' || isNaN(limit))) {
+        throw new Error('Limit must be a valid number');
+    }
+    if (limit !== undefined && limit < 0) {
+        throw new Error('Limit must be a non-negative number');
+    }
+    const words = text
+        .trim()
+        .split(/\s+/)
+        .filter((word) => word.length > 0);
+    if (words.length === 0)
+        return '';
+    const initialsArray = words.map((word) => word.charAt(0)).slice(0, limit !== null && limit !== void 0 ? limit : words.length);
+    return initialsArray.join('');
+}

package/dist/transformations/kebabCase.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Converts a given string to kebab-case format.
+ *
+ * The conversion process includes:
+ * - Trimming whitespace from both ends.
+ * - Replacing spaces and underscores with hyphens.
+ * - Inserting hyphens between lowercase and uppercase letter boundaries (e.g., `fooBar` → `foo-bar`).
+ * - Replacing all non-word characters (except hyphens) with hyphens.
+ * - Converting the entire string to lowercase.
+ * - Collapsing multiple consecutive hyphens into a single one.
+ * - Removing leading and trailing hyphens.
+ *
+ * If the input is `null` or `undefined`, an empty string is returned.
+ *
+ * @param {string} text - The input string to convert.
+ * @returns {string} The kebab-case formatted string.
+ *
+ * @example
+ * kebabCase("Hello World"); // "hello-world"
+ *
+ * @example
+ * kebabCase("camelCaseText"); // "camel-case-text"
+ *
+ * @example
+ * kebabCase("  convert_to--kebab.case!  "); // "convert-to-kebab-case"
+ */
+export declare function kebabCase(text: string): string;

package/dist/transformations/kebabCase.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kebabCase = kebabCase;
+/**
+ * Converts a given string to kebab-case format.
+ *
+ * The conversion process includes:
+ * - Trimming whitespace from both ends.
+ * - Replacing spaces and underscores with hyphens.
+ * - Inserting hyphens between lowercase and uppercase letter boundaries (e.g., `fooBar` → `foo-bar`).
+ * - Replacing all non-word characters (except hyphens) with hyphens.
+ * - Converting the entire string to lowercase.
+ * - Collapsing multiple consecutive hyphens into a single one.
+ * - Removing leading and trailing hyphens.
+ *
+ * If the input is `null` or `undefined`, an empty string is returned.
+ *
+ * @param {string} text - The input string to convert.
+ * @returns {string} The kebab-case formatted string.
+ *
+ * @example
+ * kebabCase("Hello World"); // "hello-world"
+ *
+ * @example
+ * kebabCase("camelCaseText"); // "camel-case-text"
+ *
+ * @example
+ * kebabCase("  convert_to--kebab.case!  "); // "convert-to-kebab-case"
+ */
+function kebabCase(text) {
+    if (text == null)
+        return '';
+    return text
+        .trim()
+        .replace(/[\s_]+/g, '-')
+        .replace(/([a-z])([A-Z])/g, '$1-$2')
+        .replace(/[^\w-]/g, '-')
+        .toLowerCase()
+        .replace(/-+/g, '-')
+        .replace(/^-+|-+$/g, '');
+}

package/dist/transformations/maskSegment.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hides a segment of a string by replacing it with a specified character.
+ * @param text The input string.
+ * @param maskStart The start index of the segment to mask (inclusive). Defaults to 0.
+ * @param maskEnd The end index of the segment to mask (exclusive). Defaults to text.length.
+ * @param maskChar The character to use for masking. Defaults to '*'.
+ * @returns The string with the specified segment masked.
+ */
+export declare function maskSegment(text: string, maskStart?: number, maskEnd?: number, maskChar?: string): string;

package/dist/transformations/maskSegment.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Hides a segment of a string by replacing it with a specified character.
+ * @param text The input string.
+ * @param maskStart The start index of the segment to mask (inclusive). Defaults to 0.
+ * @param maskEnd The end index of the segment to mask (exclusive). Defaults to text.length.
+ * @param maskChar The character to use for masking. Defaults to '*'.
+ * @returns The string with the specified segment masked.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maskSegment = maskSegment;
+function maskSegment(text, maskStart = 0, maskEnd = text.length, maskChar = '*') {
+    if (maskStart < 0 || maskEnd > text.length || maskStart >= maskEnd) {
+        throw new Error('Invalid mask segment range');
+    }
+    if (maskChar.length !== 1) {
+        throw new Error('Mask character must be a single character');
+    }
+    if (maskStart === 0 && maskEnd === text.length) {
+        return maskChar.repeat(text.length);
+    }
+    return text.slice(0, maskStart) + maskChar.repeat(maskEnd - maskStart) + text.slice(maskEnd);
+}

package/dist/transformations/numberToText/helpers.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Checks if a number is negative
+ */
+export declare function isNegative(num: number): boolean;
+/**
+ * Gets the highest order of magnitude for a number
+ * @example getOrderOfMagnitude(1234) returns 1000
+ * @example getOrderOfMagnitude(567) returns 100
+ */
+export declare function getOrderOfMagnitude(num: number): number;

package/dist/transformations/numberToText/helpers.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNegative = isNegative;
+exports.getOrderOfMagnitude = getOrderOfMagnitude;
+/**
+ * Checks if a number is negative
+ */
+function isNegative(num) {
+    return num < 0;
+}
+/**
+ * Gets the highest order of magnitude for a number
+ * @example getOrderOfMagnitude(1234) returns 1000
+ * @example getOrderOfMagnitude(567) returns 100
+ */
+function getOrderOfMagnitude(num) {
+    const absNum = Math.abs(num);
+    if (absNum >= 1000000000000)
+        return 1000000000000;
+    if (absNum >= 1000000000)
+        return 1000000000;
+    if (absNum >= 1000000)
+        return 1000000;
+    if (absNum >= 1000)
+        return 1000;
+    if (absNum >= 100)
+        return 100;
+    if (absNum >= 10)
+        return 10;
+    return 1;
+}

package/dist/transformations/numberToText/implementation_EN.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Converts a number to its English textual representation.
+ *
+ * Handles negative numbers, numbers from 0 to 20, tens, hundreds, thousands, and larger magnitudes.
+ *
+ * @param num The number to convert.
+ * @returns The textual representation of the number in English.
+ */
+declare function numberToTextEn(num: number): string;
+export default numberToTextEn;