stringzy 3.0.0 → 4.1.0

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

@@ -0,0 +1,50 @@
+"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 strict_1 = __importDefault(require("node:assert/strict"));
+const isLowerCase_1 = require("../../validations/isLowerCase");
+(0, node_test_1.describe)('isLowerCase', () => {
+    (0, node_test_1.it)('returns true for all lowercase alphabetic strings', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('hello'), true);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('world'), true);
+    });
+    (0, node_test_1.it)('returns true for strings with lowercase letters, spaces, digits, or special characters', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('hello world!'), true);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('abc123'), true);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('lower_case-only!!'), true);
+    });
+    (0, node_test_1.it)('returns false if any uppercase alphabetic character is present', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('Hello'), false);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('worldWide'), false);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('123ABC'), false);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('@@Good@@'), false);
+    });
+    (0, node_test_1.it)('returns false for an empty string', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)(''), false);
+    });
+    (0, node_test_1.it)('returns true for strings with only non-alphabetic characters (digits/symbols/spaces)', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('12345'), false); // no letters
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('!@#$%^&*()'), false);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('   '), false); // spaces only
+    });
+    (0, node_test_1.it)('returns true for single lowercase letters', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('a'), true);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('z'), true);
+    });
+    (0, node_test_1.it)('returns false for single uppercase letters', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('A'), false);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('Z'), false);
+    });
+    (0, node_test_1.it)('handles mixed alphanumeric correctly', () => {
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('abc123xyz'), true);
+        strict_1.default.strictEqual((0, isLowerCase_1.isLowerCase)('abcXYZ123'), false);
+    });
+    (0, node_test_1.it)('throws an error if input is not a string', () => {
+        strict_1.default.throws(() => (0, isLowerCase_1.isLowerCase)(123), /Input must be a string/);
+        strict_1.default.throws(() => (0, isLowerCase_1.isLowerCase)(null), /Input must be a string/);
+        strict_1.default.throws(() => (0, isLowerCase_1.isLowerCase)(undefined), /Input must be a string/);
+    });
+});

package/dist/tests/validations/isMacAddress.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,72 @@
+"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 isMacAddress_1 = require("../../validations/isMacAddress");
+(0, node_test_1.describe)('isMacAddress', () => {
+    (0, node_test_1.it)('returns true for valid MAC addresses with colons', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D:5E'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('aa:bb:cc:dd:ee:ff'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('FF:FF:FF:FF:FF:FF'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('01:23:45:67:89:AB'), true);
+    });
+    (0, node_test_1.it)('returns true for valid MAC addresses with hyphens', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00-1A-2B-3C-4D-5E'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('aa-bb-cc-dd-ee-ff'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('FF-FF-FF-FF-FF-FF'), true);
+    });
+    (0, node_test_1.it)('returns false for MAC addresses with mixed separators', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A-2B:3C-4D:5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('AA-BB:CC-DD:EE-FF'), false);
+    });
+    (0, node_test_1.it)('returns false for MAC addresses with invalid hex digits', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1G:2B:3C:4D:5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('ZZ:ZZ:ZZ:ZZ:ZZ:ZZ'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('GG-GG-GG-GG-GG-GG'), false);
+    });
+    (0, node_test_1.it)('returns false for MAC addresses with wrong length', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D'), false); // only 5 pairs
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D:5E:7F'), false); // 7 pairs
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('001A:2B:3C:4D:5E'), false); // first group too long
+    });
+    (0, node_test_1.it)('returns false for MAC addresses with leading/trailing spaces', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)(' 00:1A:2B:3C:4D:5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D:5E '), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)(' 00:1A:2B:3C:4D:5E '), false);
+    });
+    (0, node_test_1.it)('returns false for MAC addresses with spaces inside', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D :5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00 :1A:2B:3C:4D:5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C: 4D:5E'), false);
+    });
+    (0, node_test_1.it)('returns false for missing separators', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('001A2B3C4D5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A2B:3C4D:5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00-1A2B-3C4D-5E'), false);
+    });
+    (0, node_test_1.it)('returns false for extra separators', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00::1A:2B:3C:4D:5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00-1A--2B-3C-4D-5E'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D:5E:'), false);
+    });
+    (0, node_test_1.it)('returns false for empty strings and malformed inputs', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)(''), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('::::::'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('--:--:--:--:--:--'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D:5E:'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)(':00:1A:2B:3C:4D:5E'), false);
+    });
+    (0, node_test_1.it)('returns false for non-hex characters and invalid formats', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('00:1A:2B:3C:4D:GH'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('hello-world-mac'), false);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('mac:address:test'), false);
+    });
+    (0, node_test_1.it)('accepts both uppercase and lowercase consistently', () => {
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('aa:bb:cc:dd:ee:ff'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('AA:BB:CC:DD:EE:FF'), true);
+        node_assert_1.default.strictEqual((0, isMacAddress_1.isMacAddress)('Aa:Bb:Cc:Dd:Ee:Ff'), true);
+    });
+});

package/dist/tests/validations/isPalindrome.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,39 @@
+"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 isPalindrome_1 = require("../../validations/isPalindrome");
+(0, node_test_1.describe)('isPalindrome', () => {
+    (0, node_test_1.it)('returns true for simple palindromes', () => {
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('racecar'), true);
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('madam'), true);
+    });
+    (0, node_test_1.it)('returns false for non-palindromes', () => {
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('hello'), false);
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('world'), false);
+    });
+    (0, node_test_1.it)('is case-insensitive', () => {
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('RaceCar'), true);
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('MadAm'), true);
+    });
+    (0, node_test_1.it)('ignores punctuation and spaces', () => {
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('A man, a plan, a canal: Panama'), true);
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('No lemon, no melon!'), true);
+    });
+    (0, node_test_1.it)('returns true for empty string and single characters', () => {
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)(''), true);
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('x'), true);
+    });
+    (0, node_test_1.it)('handles strings with only special characters', () => {
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('?!'), true); // cleans to ''
+        node_assert_1.default.strictEqual((0, isPalindrome_1.isPalindrome)('!@#$$#@!'), true); // also cleans to ''
+    });
+    (0, node_test_1.it)('throws an error if input is not a string', () => {
+        node_assert_1.default.throws(() => (0, isPalindrome_1.isPalindrome)(123), /Input must be a string/);
+        node_assert_1.default.throws(() => (0, isPalindrome_1.isPalindrome)(null), /Input must be a string/);
+        node_assert_1.default.throws(() => (0, isPalindrome_1.isPalindrome)(undefined), /Input must be a string/);
+    });
+});

package/dist/tests/validations/isPanagram.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,39 @@
+"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 isPanagram_1 = require("../../validations/isPanagram");
+(0, node_test_1.describe)('isPanagram', () => {
+    (0, node_test_1.it)('returns true for a classic pangram sentence', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('The quick brown fox jumps over the lazy dog.'), true);
+    });
+    (0, node_test_1.it)('returns true for the alphabet with hyphens or separators', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z'), true);
+    });
+    (0, node_test_1.it)('returns true for alphabet without separators', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('Abcdefghijklmnopqrstuvwxyz'), true);
+    });
+    (0, node_test_1.it)('returns true for alphabet in mixed case', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('AbCdEfGhIjKlMnOpQrStUvWxYz'), true);
+    });
+    (0, node_test_1.it)('returns false for non-pangram sentences', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('This is not a pangram.'), false);
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('Hello world'), false);
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('Quick fox'), false);
+    });
+    (0, node_test_1.it)('returns false for empty strings', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)(''), false);
+    });
+    (0, node_test_1.it)('ignores numbers and punctuation', () => {
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('The quick brown fox jumps over the lazy dog! 12345'), true);
+        node_assert_1.default.strictEqual((0, isPanagram_1.isPanagram)('1234567890 !!! ???'), false);
+    });
+    (0, node_test_1.it)('throws an error if input is not a string', () => {
+        node_assert_1.default.throws(() => (0, isPanagram_1.isPanagram)(123), /Input must be a string/);
+        node_assert_1.default.throws(() => (0, isPanagram_1.isPanagram)(null), /Input must be a string/);
+        node_assert_1.default.throws(() => (0, isPanagram_1.isPanagram)(undefined), /Input must be a string/);
+    });
+});

package/dist/tests/validations/isTypeOf.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,28 @@
+"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 isTypeOf_1 = require("../../validations/isTypeOf");
+(0, node_test_1.describe)('isType', () => {
+    (0, node_test_1.it)('returns true for valid file', () => {
+        node_assert_1.default.strictEqual((0, isTypeOf_1.isTypeOf)('photo.PNG', 'image'), true);
+    });
+    (0, node_test_1.it)('returns false for unknown extension', () => {
+        node_assert_1.default.strictEqual((0, isTypeOf_1.isTypeOf)('unknown.xyz', 'document'), false);
+    });
+    (0, node_test_1.it)('returns false for unknown type category', () => {
+        node_assert_1.default.strictEqual((0, isTypeOf_1.isTypeOf)('photo.png', 'media'), false);
+    });
+    (0, node_test_1.it)('returns false for mismatched type', () => {
+        node_assert_1.default.strictEqual((0, isTypeOf_1.isTypeOf)('video.mp4', 'document'), false);
+    });
+    (0, node_test_1.it)('returns false for missing extension', () => {
+        node_assert_1.default.strictEqual((0, isTypeOf_1.isTypeOf)('filewithoutextension', 'image'), false);
+    });
+    (0, node_test_1.it)('handles URL with query and hash fragments', () => {
+        node_assert_1.default.strictEqual((0, isTypeOf_1.isTypeOf)('https://example.com/pic.jpeg?version=2#section', 'image'), true);
+    });
+});

package/dist/tests/validations/isUpperCase.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,50 @@
+"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 strict_1 = __importDefault(require("node:assert/strict"));
+const isUpperCase_1 = require("../../validations/isUpperCase");
+(0, node_test_1.describe)('isUpperCase', () => {
+    (0, node_test_1.it)('returns true for all uppercase alphabetic strings', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('HELLO'), true);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('WORLD'), true);
+    });
+    (0, node_test_1.it)('returns true for strings with uppercase letters, spaces, digits, or special characters', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('HELLO WORLD!'), true);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('ABC123'), true);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('UPPER_CASE-ONLY!!'), true);
+    });
+    (0, node_test_1.it)('returns false if any lowercase alphabetic character is present', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('Hello'), false);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('WORLDwide'), false);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('123abc'), false);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('@@good@@'), false);
+    });
+    (0, node_test_1.it)('returns false for an empty string', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)(''), false);
+    });
+    (0, node_test_1.it)('returns false for strings with only non-alphabetic characters (digits/symbols/spaces)', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('12345'), false); // no letters
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('!@#$%^&*()'), false);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('   '), false); // spaces only
+    });
+    (0, node_test_1.it)('returns true for single uppercase letters', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('A'), true);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('Z'), true);
+    });
+    (0, node_test_1.it)('returns false for single lowercase letters', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('a'), false);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('z'), false);
+    });
+    (0, node_test_1.it)('handles mixed alphanumeric correctly', () => {
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('ABC123XYZ'), true);
+        strict_1.default.strictEqual((0, isUpperCase_1.isUpperCase)('ABCxyz123'), false);
+    });
+    (0, node_test_1.it)('throws an error if input is not a string', () => {
+        strict_1.default.throws(() => (0, isUpperCase_1.isUpperCase)(123), /Input must be a string/);
+        strict_1.default.throws(() => (0, isUpperCase_1.isUpperCase)(null), /Input must be a string/);
+        strict_1.default.throws(() => (0, isUpperCase_1.isUpperCase)(undefined), /Input must be a string/);
+    });
+});

package/dist/transformations/camelCase.d.ts

@@ -1 +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

@@ -1,6 +1,30 @@
 "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 '';

package/dist/transformations/capitalizeWords.d.ts

@@ -1 +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

@@ -1,9 +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.");
+    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

@@ -1 +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

@@ -1,6 +1,32 @@
 "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 '';

package/dist/transformations/escapeHTML.d.ts

@@ -1 +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

@@ -1,14 +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;'
+        "'": '&#39;',
     };
     return str.replace(/[&<>"']/g, (match) => htmlEscapes[match]);
 }
-;

package/dist/transformations/index.d.ts

@@ -13,6 +13,10 @@ export { toSlug } from './toSlug';
 export { truncateText } from './truncateText';
 export { escapeHtml } from './escapeHTML';
 export { maskSegment } from './maskSegment';
+export { numberToText } from './numberToText/main';
+export { reverseWordsInString } from './reverseWordsInString ';
+export { stringPermutations } from './stringPermutations';
+export { stringCombinations } from './stringCombinations';
 import { camelCase } from './camelCase';
 import { capitalizeWords } from './capitalizeWords';
 import { constantCase } from './constantCase';
@@ -29,6 +33,10 @@ import { truncateText } from './truncateText';
 import { escapeHtml } from './escapeHTML';
 import { maskSegment } from './maskSegment';
 import { deburr } from './deburr';
+import { numberToText } from './numberToText/main';
+import { reverseWordsInString } from './reverseWordsInString ';
+import { stringPermutations } from './stringPermutations';
+import { stringCombinations } from './stringCombinations';
 export declare const transformations: {
     camelCase: typeof camelCase;
     capitalizeWords: typeof capitalizeWords;
@@ -46,4 +54,8 @@ export declare const transformations: {
     escapeHtml: typeof escapeHtml;
     maskSegment: typeof maskSegment;
     deburr: typeof deburr;
+    numberToText: typeof numberToText;
+    reverseWordsInString: typeof reverseWordsInString;
+    stringPermutations: typeof stringPermutations;
+    stringCombinations: typeof stringCombinations;
 };

package/dist/transformations/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformations = 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;
+exports.transformations = exports.stringCombinations = exports.stringPermutations = exports.reverseWordsInString = 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");
@@ -31,6 +31,14 @@ 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; } });
+var reverseWordsInString_1 = require("./reverseWordsInString ");
+Object.defineProperty(exports, "reverseWordsInString", { enumerable: true, get: function () { return reverseWordsInString_1.reverseWordsInString; } });
+var stringPermutations_1 = require("./stringPermutations");
+Object.defineProperty(exports, "stringPermutations", { enumerable: true, get: function () { return stringPermutations_1.stringPermutations; } });
+var stringCombinations_1 = require("./stringCombinations");
+Object.defineProperty(exports, "stringCombinations", { enumerable: true, get: function () { return stringCombinations_1.stringCombinations; } });
 const camelCase_2 = require("./camelCase");
 const capitalizeWords_2 = require("./capitalizeWords");
 const constantCase_2 = require("./constantCase");
@@ -47,6 +55,10 @@ 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");
+const reverseWordsInString_2 = require("./reverseWordsInString ");
+const stringPermutations_2 = require("./stringPermutations");
+const stringCombinations_2 = require("./stringCombinations");
 exports.transformations = {
     camelCase: camelCase_2.camelCase,
     capitalizeWords: capitalizeWords_2.capitalizeWords,
@@ -63,5 +75,9 @@ exports.transformations = {
     truncateText: truncateText_2.truncateText,
     escapeHtml: escapeHTML_2.escapeHtml,
     maskSegment: maskSegment_2.maskSegment,
-    deburr: deburr_1.deburr
+    deburr: deburr_1.deburr,
+    numberToText: main_2.numberToText,
+    reverseWordsInString: reverseWordsInString_2.reverseWordsInString,
+    stringPermutations: stringPermutations_2.stringPermutations,
+    stringCombinations: stringCombinations_2.stringCombinations
 };