toolbox-x 2.2.5 → 2.3.0

package/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to **toolbox-x** will be documented in this file.
 
 > Auto-generated from git history using [changelog-maker](https://github.com/nodejs/changelog-maker).
 
+## [v2.3.0](https://github.com/nazmul-nhb/toolbox-x/releases/tag/v2.3.0) — 2026-06-16
+
+[Compare changes](https://github.com/nazmul-nhb/toolbox-x/compare/v2.2.5...v2.3.0)
+
+* \[[`70ffd18605`](https://github.com/nazmul-nhb/toolbox-x/commit/70ffd18605)] - ✨ feat(hash): added 3 new utils: `randomBytes`, `randomNumeric`, `randomAlphaNumeric` (Nazmul Hassan)
+* \[[`278c9392f0`](https://github.com/nazmul-nhb/toolbox-x/commit/278c9392f0)] - 🧼 refactor(src): moved package subpaths in the respective directories (Nazmul Hassan)
+* \[[`a67db2ae2d`](https://github.com/nazmul-nhb/toolbox-x/commit/a67db2ae2d)] - 🛠️ chore(scripts): updated config file for nhb-scripts (Nazmul Hassan)
+* \[[`f8478c1085`](https://github.com/nazmul-nhb/toolbox-x/commit/f8478c1085)] - 🧪 test(commit): testing commit (Nazmul Hassan)
+* \[[`4e8b29c382`](https://github.com/nazmul-nhb/toolbox-x/commit/4e8b29c382)] - 📚 docs: updated CHANGELOG.md for v2.2.5 (github-actions\[bot])
+
 ## [v2.2.5](https://github.com/nazmul-nhb/toolbox-x/releases/tag/v2.2.5) — 2026-06-16
 
 [Compare changes](https://github.com/nazmul-nhb/toolbox-x/compare/v2.2.4...v2.2.5)

package/dist/{guards-Dc9MB9on.mjs → basics-B7Sqf33u.mjs}

@@ -15,10 +15,240 @@
  */
 
 import { d as isString, m as isUndefined } from "./primitives-Djsevc69.mjs";
+import { $ as trimString, m as stableStringify } from "./utils-BO5CcsjK.mjs";
 import { b as isFunction, w as isNotEmptyObject } from "./specials-krf7zsqI.mjs";
-import { a as normalizeNumber } from "./utilities-BSv8VbnM.mjs";
-import { G as stableStringify, n as trimString } from "./basics-20lm69yy.mjs";
+import { a as normalizeNumber } from "./utilities-CmPwOkdy.mjs";
 
+//#region src/string/convert.ts
+/**
+* * Replaces all occurrences of a string or pattern in the given input string.
+*
+* - If `find` is a string, it is converted into a global regular expression (`/find/g`).
+* - If `find` is a `RegExp`, the global (`g`) flag is ensured.
+* - Trims the input before performing replacements.
+*
+* @param input - The string in which replacements should be performed.
+* @param find - The substring or regex pattern to search for.
+* @param replace - The string to replace matches with.
+* @returns The modified/refined string with replacements applied.
+*/
+const replaceAllInString = (input, find, replace) => {
+	const trimmedString = trimString(input);
+	const regex = isString(find) ? new RegExp(find, "g") : new RegExp(find, find?.flags.includes("g") ? find?.flags : find?.flags + "g");
+	return trimmedString?.replace(regex, replace);
+};
+/**
+* * Converts a string into a URL-friendly slug.
+* @param input - The string to be converted.
+* @returns The slugified string.
+*/
+const slugifyString = (input) => {
+	return trimString(normalizeString(input))?.toLowerCase()?.replace(/[^a-z0-9]+/g, "-")?.replace(/^-+|-+$/g, "");
+};
+/**
+* * Masks part of a string for privacy.
+* @param input - The string to mask.
+* @param options - Options for masking a string.
+* @returns The masked string.
+*/
+const maskString = (input, options) => {
+	const { start = 1, end = 1, maskCharacter: maskChar = "*" } = options || {};
+	const trimmedString = trimString(input);
+	if (trimmedString?.length <= start + end) return maskChar?.repeat(trimmedString?.length);
+	return trimmedString.slice(0, start) + maskChar?.repeat(trimmedString?.length - start - end) + (end > 0 ? trimmedString.slice(-end) : "");
+};
+/**
+* * Reverses a given string.
+* @param input - The string to reverse.
+* @returns The reversed string.
+*
+* @remarks It {@link trimString trims} the whitespace of the input string before reversing it.
+*/
+const reverseString = (input) => {
+	return trimString(input)?.split("")?.reverse()?.join("");
+};
+/**
+* * Normalizes a string by removing diacritics (accents).
+* @param str The input string.
+* @returns The normalized string.
+*/
+function normalizeString(str) {
+	return str?.normalize("NFD")?.replace(/[\u0300-\u036f]/g, "");
+}
+/**
+* * Extracts all email addresses from a string.
+* @param str The input string.
+* @returns An array of extracted email addresses.
+*/
+function extractEmails(str) {
+	return str?.match(/[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g) || [];
+}
+/**
+* * Extracts all URLs from a string.
+* @param str The input string.
+* @returns An array of extracted URLs.
+*/
+function extractURLs(str) {
+	return str?.match(/https?:\/\/[^\s/$.?#].[^\s]*/g) || [];
+}
+/**
+* * Returns a grammatically correct unit string, optionally prefixed with the number.
+*
+* @remarks For complex and versatile pluralization, please refer to {@link https://toolbox-x.nazmul-nhb.dev/docs/utils/string/pluralizer pluralizer} or {@link https://toolbox-x.nazmul-nhb.dev/docs/classes/pluralizer Pluralizer Class} instead.
+*
+* @param count The numeric value to determine singular or plural.
+* @param unit The unit name (e.g., "day", "hour").
+* @param withNumber Whether to prefix the count before the unit. Defaults to `true`.
+* @returns Formatted unit string like `"1 day"`, `"2 months"`, or `"hour"`.
+*/
+function formatUnitWithPlural(count, unit, withNumber = true) {
+	const pluralized = Math.abs(count) === 1 ? unit : `${unit}s`;
+	return withNumber ? `${count} ${pluralized}` : pluralized;
+}
+
+//#endregion
+//#region src/number/guards.ts
+/**
+* * Check if a number is even or not.
+*
+* @param input The number or numeric string to check.
+* @returns Boolean: `true` if even and `false` if not even.
+*/
+const isEven = (input) => {
+	const parsed = normalizeNumber(input);
+	if (isUndefined(parsed)) return false;
+	return parsed % 2 === 0;
+};
+/**
+* * Checks if a number is odd or not.
+*
+* @param input The number or numeric string to check.
+* @returns Boolean: `true` if odd and `false` if not odd.
+*/
+const isOdd = (input) => {
+	const parsed = normalizeNumber(input);
+	if (isUndefined(parsed)) return false;
+	return parsed % 2 !== 0;
+};
+/**
+* * Checks if a number is a multiple of another number.
+*
+* @param input - The number to check.
+* @param multipleOf - The number to check against.
+* @returns `true` if `input` is a multiple of `multipleOf`, otherwise `false`.
+*/
+const isMultiple = (input, multipleOf) => {
+	return input % multipleOf === 0;
+};
+/**
+* * Checks if a number is a perfect square.
+*
+* @param num The number to check.
+* @returns `true` if the number is a perfect square, otherwise `false`.
+*/
+function isPerfectSquare(num) {
+	return Number.isInteger(Math.sqrt(num));
+}
+/**
+* * Checks if a number is part of the Fibonacci sequence.
+*
+* @param num The number to check.
+* @returns `true` if the number is a Fibonacci number, otherwise `false`.
+*/
+function isFibonacci(num) {
+	return isPerfectSquare(5 * num * num + 4) || isPerfectSquare(5 * num * num - 4);
+}
+/**
+* * Checks whether any input is not a finite number.
+*
+* @param numbers - The list of numbers to validate.
+* @returns `true` if any input is not finite.
+*/
+function areInvalidNumbers(...numbers) {
+	return numbers?.some((n) => !Number.isFinite(n));
+}
+
+//#endregion
+//#region src/number/prime.ts
+/**
+* * Checks if a number is prime.
+*
+* @param number The number to check.
+* @returns Boolean: `true` if the number is prime, otherwise `false`.
+*/
+const isPrime = (number) => {
+	if (number < 2) return false;
+	if (number === 2 || number === 3) return true;
+	if (number % 2 === 0 || number % 3 === 0) return false;
+	for (let i = 5; i * i <= number; i += 6) if (number % i === 0 || number % (i + 2) === 0) return false;
+	return true;
+};
+/**
+* * Find prime numbers in a given range.
+*
+* @param start The starting number of the range. Default is `1`.
+* @param end The ending number of the range. Default is `1000`.
+* @returns An array of prime numbers within the range (inclusive).
+*/
+const findPrimeNumbers = (start = 1, end = 1e3) => {
+	let startNumber = start, endNumber = end;
+	if (start > end) [startNumber, endNumber] = [end, start];
+	return Array.from({ length: endNumber - startNumber + 1 }, (_, i) => startNumber + i).filter(isPrime);
+};
+
+//#endregion
+//#region src/string/guards.ts
+/**
+* * Checks if a string is a palindrome.
+* @param input - The string to check.
+* @returns True if the string is a palindrome, otherwise false.
+*/
+const isPalindrome = (input) => {
+	const normalized = input.toLowerCase().replace(/[^a-z0-9]/g, "");
+	return normalized === reverseString(normalized);
+};
+/**
+* * Checks if a string is in camelCase format.
+* @param str The string to check.
+* @returns `true` if the string is in camelCase, otherwise `false`.
+*/
+function isCamelCase(str) {
+	return /^[a-z]+([A-Z][a-z]*)*$/.test(str);
+}
+/**
+* * Checks if a string is in PascalCase format.
+* @param str The string to check.
+* @returns `true` if the string is in PascalCase, otherwise `false`.
+*/
+function isPascalCase(str) {
+	return /^[A-Z][a-zA-Z]*$/.test(str);
+}
+/**
+* * Checks if a string is in snake_case format.
+* @param str The string to check.
+* @returns `true` if the string is in snake_case, otherwise `false`.
+*/
+function isSnakeCase(str) {
+	return /^[a-z]+(_[a-z]+)*$/.test(str);
+}
+/**
+* * Checks if a string is in kebab-case format.
+* @param str The string to check.
+* @returns `true` if the string is in kebab-case, otherwise `false`.
+*/
+function isKebabCase(str) {
+	return /^[a-z]+(-[a-z]+)*$/.test(str);
+}
+/**
+* * Checks if a string contains only emojis.
+* @param str The string to check.
+* @returns `true` if the string contains only emojis, otherwise `false`.
+*/
+function isEmojiOnly(str) {
+	return /^[\p{Emoji}]+$/u.test(str);
+}
+
+//#endregion
 //#region src/object/basics.ts
 /**
 * * Deep clone an object using `structuredClone` or deterministic *JSON serialization*.
@@ -192,234 +422,4 @@ const getLastArrayElement = (array) => {
 };
 
 //#endregion
-//#region src/number/guards.ts
-/**
-* * Check if a number is even or not.
-*
-* @param input The number or numeric string to check.
-* @returns Boolean: `true` if even and `false` if not even.
-*/
-const isEven = (input) => {
-	const parsed = normalizeNumber(input);
-	if (isUndefined(parsed)) return false;
-	return parsed % 2 === 0;
-};
-/**
-* * Checks if a number is odd or not.
-*
-* @param input The number or numeric string to check.
-* @returns Boolean: `true` if odd and `false` if not odd.
-*/
-const isOdd = (input) => {
-	const parsed = normalizeNumber(input);
-	if (isUndefined(parsed)) return false;
-	return parsed % 2 !== 0;
-};
-/**
-* * Checks if a number is a multiple of another number.
-*
-* @param input - The number to check.
-* @param multipleOf - The number to check against.
-* @returns `true` if `input` is a multiple of `multipleOf`, otherwise `false`.
-*/
-const isMultiple = (input, multipleOf) => {
-	return input % multipleOf === 0;
-};
-/**
-* * Checks if a number is a perfect square.
-*
-* @param num The number to check.
-* @returns `true` if the number is a perfect square, otherwise `false`.
-*/
-function isPerfectSquare(num) {
-	return Number.isInteger(Math.sqrt(num));
-}
-/**
-* * Checks if a number is part of the Fibonacci sequence.
-*
-* @param num The number to check.
-* @returns `true` if the number is a Fibonacci number, otherwise `false`.
-*/
-function isFibonacci(num) {
-	return isPerfectSquare(5 * num * num + 4) || isPerfectSquare(5 * num * num - 4);
-}
-/**
-* * Checks whether any input is not a finite number.
-*
-* @param numbers - The list of numbers to validate.
-* @returns `true` if any input is not finite.
-*/
-function areInvalidNumbers(...numbers) {
-	return numbers?.some((n) => !Number.isFinite(n));
-}
-
-//#endregion
-//#region src/number/prime.ts
-/**
-* * Checks if a number is prime.
-*
-* @param number The number to check.
-* @returns Boolean: `true` if the number is prime, otherwise `false`.
-*/
-const isPrime = (number) => {
-	if (number < 2) return false;
-	if (number === 2 || number === 3) return true;
-	if (number % 2 === 0 || number % 3 === 0) return false;
-	for (let i = 5; i * i <= number; i += 6) if (number % i === 0 || number % (i + 2) === 0) return false;
-	return true;
-};
-/**
-* * Find prime numbers in a given range.
-*
-* @param start The starting number of the range. Default is `1`.
-* @param end The ending number of the range. Default is `1000`.
-* @returns An array of prime numbers within the range (inclusive).
-*/
-const findPrimeNumbers = (start = 1, end = 1e3) => {
-	let startNumber = start, endNumber = end;
-	if (start > end) [startNumber, endNumber] = [end, start];
-	return Array.from({ length: endNumber - startNumber + 1 }, (_, i) => startNumber + i).filter(isPrime);
-};
-
-//#endregion
-//#region src/string/convert.ts
-/**
-* * Replaces all occurrences of a string or pattern in the given input string.
-*
-* - If `find` is a string, it is converted into a global regular expression (`/find/g`).
-* - If `find` is a `RegExp`, the global (`g`) flag is ensured.
-* - Trims the input before performing replacements.
-*
-* @param input - The string in which replacements should be performed.
-* @param find - The substring or regex pattern to search for.
-* @param replace - The string to replace matches with.
-* @returns The modified/refined string with replacements applied.
-*/
-const replaceAllInString = (input, find, replace) => {
-	const trimmedString = trimString(input);
-	const regex = isString(find) ? new RegExp(find, "g") : new RegExp(find, find?.flags.includes("g") ? find?.flags : find?.flags + "g");
-	return trimmedString?.replace(regex, replace);
-};
-/**
-* * Converts a string into a URL-friendly slug.
-* @param input - The string to be converted.
-* @returns The slugified string.
-*/
-const slugifyString = (input) => {
-	return trimString(normalizeString(input))?.toLowerCase()?.replace(/[^a-z0-9]+/g, "-")?.replace(/^-+|-+$/g, "");
-};
-/**
-* * Masks part of a string for privacy.
-* @param input - The string to mask.
-* @param options - Options for masking a string.
-* @returns The masked string.
-*/
-const maskString = (input, options) => {
-	const { start = 1, end = 1, maskCharacter: maskChar = "*" } = options || {};
-	const trimmedString = trimString(input);
-	if (trimmedString?.length <= start + end) return maskChar?.repeat(trimmedString?.length);
-	return trimmedString.slice(0, start) + maskChar?.repeat(trimmedString?.length - start - end) + (end > 0 ? trimmedString.slice(-end) : "");
-};
-/**
-* * Reverses a given string.
-* @param input - The string to reverse.
-* @returns The reversed string.
-*
-* @remarks It {@link trimString trims} the whitespace of the input string before reversing it.
-*/
-const reverseString = (input) => {
-	return trimString(input)?.split("")?.reverse()?.join("");
-};
-/**
-* * Normalizes a string by removing diacritics (accents).
-* @param str The input string.
-* @returns The normalized string.
-*/
-function normalizeString(str) {
-	return str?.normalize("NFD")?.replace(/[\u0300-\u036f]/g, "");
-}
-/**
-* * Extracts all email addresses from a string.
-* @param str The input string.
-* @returns An array of extracted email addresses.
-*/
-function extractEmails(str) {
-	return str?.match(/[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g) || [];
-}
-/**
-* * Extracts all URLs from a string.
-* @param str The input string.
-* @returns An array of extracted URLs.
-*/
-function extractURLs(str) {
-	return str?.match(/https?:\/\/[^\s/$.?#].[^\s]*/g) || [];
-}
-/**
-* * Returns a grammatically correct unit string, optionally prefixed with the number.
-*
-* @remarks For complex and versatile pluralization, please refer to {@link https://toolbox-x.nazmul-nhb.dev/docs/utils/string/pluralizer pluralizer} or {@link https://toolbox-x.nazmul-nhb.dev/docs/classes/pluralizer Pluralizer Class} instead.
-*
-* @param count The numeric value to determine singular or plural.
-* @param unit The unit name (e.g., "day", "hour").
-* @param withNumber Whether to prefix the count before the unit. Defaults to `true`.
-* @returns Formatted unit string like `"1 day"`, `"2 months"`, or `"hour"`.
-*/
-function formatUnitWithPlural(count, unit, withNumber = true) {
-	const pluralized = Math.abs(count) === 1 ? unit : `${unit}s`;
-	return withNumber ? `${count} ${pluralized}` : pluralized;
-}
-
-//#endregion
-//#region src/string/guards.ts
-/**
-* * Checks if a string is a palindrome.
-* @param input - The string to check.
-* @returns True if the string is a palindrome, otherwise false.
-*/
-const isPalindrome = (input) => {
-	const normalized = input.toLowerCase().replace(/[^a-z0-9]/g, "");
-	return normalized === reverseString(normalized);
-};
-/**
-* * Checks if a string is in camelCase format.
-* @param str The string to check.
-* @returns `true` if the string is in camelCase, otherwise `false`.
-*/
-function isCamelCase(str) {
-	return /^[a-z]+([A-Z][a-z]*)*$/.test(str);
-}
-/**
-* * Checks if a string is in PascalCase format.
-* @param str The string to check.
-* @returns `true` if the string is in PascalCase, otherwise `false`.
-*/
-function isPascalCase(str) {
-	return /^[A-Z][a-zA-Z]*$/.test(str);
-}
-/**
-* * Checks if a string is in snake_case format.
-* @param str The string to check.
-* @returns `true` if the string is in snake_case, otherwise `false`.
-*/
-function isSnakeCase(str) {
-	return /^[a-z]+(_[a-z]+)*$/.test(str);
-}
-/**
-* * Checks if a string is in kebab-case format.
-* @param str The string to check.
-* @returns `true` if the string is in kebab-case, otherwise `false`.
-*/
-function isKebabCase(str) {
-	return /^[a-z]+(-[a-z]+)*$/.test(str);
-}
-/**
-* * Checks if a string contains only emojis.
-* @param str The string to check.
-* @returns `true` if the string contains only emojis, otherwise `false`.
-*/
-function isEmojiOnly(str) {
-	return /^[\p{Emoji}]+$/u.test(str);
-}
-
-//#endregion
-export { extractObjectEntries as A, filterArrayOfObjects as C, shuffleArray as D, isInvalidOrEmptyArray as E, extractObjectKeysDeep as M, cloneObject as O, isPerfectSquare as S, getLastArrayElement as T, areInvalidNumbers as _, isPascalCase as a, isMultiple as b, extractURLs as c, normalizeString as d, replaceAllInString as f, isPrime as g, findPrimeNumbers as h, isPalindrome as i, extractObjectKeys as j, countObjectFields as k, formatUnitWithPlural as l, slugifyString as m, isEmojiOnly as n, isSnakeCase as o, reverseString as p, isKebabCase as r, extractEmails as s, isCamelCase as t, maskString as u, isEven as v, flattenArray as w, isOdd as x, isFibonacci as y };
+export { replaceAllInString as A, isOdd as C, formatUnitWithPlural as D, extractURLs as E, slugifyString as M, maskString as O, isMultiple as S, extractEmails as T, findPrimeNumbers as _, shuffleArray as a, isEven as b, extractObjectEntries as c, isCamelCase as d, isEmojiOnly as f, isSnakeCase as g, isPascalCase as h, isInvalidOrEmptyArray as i, reverseString as j, normalizeString as k, extractObjectKeys as l, isPalindrome as m, flattenArray as n, cloneObject as o, isKebabCase as p, getLastArrayElement as r, countObjectFields as s, filterArrayOfObjects as t, extractObjectKeysDeep as u, isPrime as v, isPerfectSquare as w, isFibonacci as x, areInvalidNumbers as y };