js-utils-kit 0.4.0 → 0.5.0

package/README.md

@@ -31,6 +31,14 @@ _Modular JavaScript utilities with type support for strings, objects, arrays and
 
 This package includes utilities designed for both browser and Node.js environments, clearly organized and optimized for cross-platform compatibility.
 
+## Features
+
+- Organized by category (e.g., `number`, `string`, `file`, etc.)
+- Fully typed in TypeScript
+- Thoroughly tested with Jest
+- Tree‑shakeable and supports both ESM and CJS
+- CLI-ready tools for file and system operations
+
 ## Installation
 
 ```sh
@@ -126,17 +134,9 @@ console.log(object.isEmpty({})); // true
 console.log(env.isBrowser()); // true/false
 ```
 
-## Features
-
-- Organized by category (e.g., `number`, `string`, `file`, etc.)
-- Fully typed with TypeScript
-- Thoroughly tested with Jest
-- Tree-shakable and supports both ESM and CJS
-- CLI-ready tools for file and system operations
-
 ## Documentation
 
-Full documentation available at [GitHub Pages](https://teneplaysofficial.github.io/js-utils-kit/)
+Full documentation available at [GitHub Pages](https://js-utils.js.org/modules.html)
 
 ## Requirements
 

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var e=require("./array/index.cjs"),r=require("./char/index.cjs"),s=require("./env/index.cjs"),t=require("./file/index.cjs"),i=require("./number/index.cjs"),o=require("./object/index.cjs"),a=require("./string/index.cjs"),p=require("./validate-BKQ-HFTd.js");require("fs"),require("path"),require("events"),require("constants"),require("stream"),require("util"),require("assert"),require("buffer"),require("node:url"),require("node:path"),require("node:fs"),require("node:fs/promises"),require("node:events"),require("node:stream"),require("node:string_decoder"),require("zlib"),exports.array=e.default,exports.all=r.all,exports.char=r.default,exports.digits=r.digits,exports.lowercase=r.lowercase,exports.uppercase=r.uppercase,Object.defineProperty(exports,"Environment",{enumerable:!0,get:function(){return s.Environment}}),exports.env=s.default,exports.getRunTimeEnvironment=s.getRunTimeEnvironment,exports.isBrowser=s.isBrowser,exports.isDev=s.isDev,exports.isNode=s.isNode,exports.isProd=s.isProd,exports.isTest=s.isTest,exports.createArchive=t.createArchive,exports.file=t.default,exports.clamp=i.clamp,exports.getMilliseconds=i.getMilliseconds,exports.isEven=i.isEven,exports.isOdd=i.isOdd,exports.number=i.default,exports.randomFloat=i.randomFloat,exports.randomInt=i.randomInt,exports.isEmptyObject=o.isEmptyObject,exports.isNonEmptyObject=o.isNonEmptyObject,exports.isObject=o.isObject,exports.mergeObj=o.mergeObj,exports.object=o.default,exports.capitalize=a.capitalize,exports.containsWhitespace=a.containsWhitespace,exports.endsWithPunctuation=a.endsWithPunctuation,exports.isAlphabetic=a.isAlphabetic,exports.isCamelCase=a.isCamelCase,exports.isEmail=a.isEmail,exports.isKebabCase=a.isKebabCase,exports.isLowerCase=a.isLowerCase,exports.isNonEmptyString=a.isNonEmptyString,exports.isNumericString=a.isNumericString,exports.isPascalCase=a.isPascalCase,exports.isSnakeCase=a.isSnakeCase,exports.isString=a.isString,exports.isURL=a.isURL,exports.isUpperCase=a.isUpperCase,exports.padLeft=a.padLeft,exports.padRight=a.padRight,exports.repeatString=a.repeatString,exports.startsWithUppercase=a.startsWithUppercase,exports.string=a.default,exports.trim=a.trim,exports.truncate=a.truncate,exports.isArray=p.isArray,exports.isDefined=p.isDefined,exports.isUndefinedOrNull=p.isUndefinedOrNull;
+"use strict";var e=require("./array/index.cjs"),r=require("./char/index.cjs"),s=require("./env/index.cjs"),t=require("./file/index.cjs"),i=require("./number/index.cjs"),o=require("./object/index.cjs"),n=require("./string/index.cjs"),p=require("./validate-BKQ-HFTd.js");require("fs"),require("path"),require("events"),require("constants"),require("stream"),require("util"),require("assert"),require("buffer"),require("node:url"),require("node:path"),require("node:fs"),require("node:fs/promises"),require("node:events"),require("node:stream"),require("node:string_decoder"),require("zlib"),exports.array=e.default,exports.all=r.all,exports.char=r.default,exports.digits=r.digits,exports.lowercase=r.lowercase,exports.uppercase=r.uppercase,Object.defineProperty(exports,"Environment",{enumerable:!0,get:function(){return s.Environment}}),exports.env=s.default,exports.getRunTimeEnvironment=s.getRunTimeEnvironment,exports.isBrowser=s.isBrowser,exports.isDev=s.isDev,exports.isNode=s.isNode,exports.isProd=s.isProd,exports.isTest=s.isTest,exports.createArchive=t.createArchive,exports.file=t.default,exports.clamp=i.clamp,exports.getMilliseconds=i.getMilliseconds,exports.isEven=i.isEven,exports.isOdd=i.isOdd,exports.number=i.default,exports.randomFloat=i.randomFloat,exports.randomInt=i.randomInt,exports.isEmptyObject=o.isEmptyObject,exports.isNonEmptyObject=o.isNonEmptyObject,exports.isObject=o.isObject,exports.mergeObj=o.mergeObj,exports.object=o.default,exports.capitalize=n.capitalize,exports.containsWhitespace=n.containsWhitespace,exports.countChars=n.countChars,exports.countFrequencies=n.countFrequencies,exports.countLines=n.countLines,exports.countSubstring=n.countSubstring,exports.countWords=n.countWords,exports.endsWithPunctuation=n.endsWithPunctuation,exports.isAlphabetic=n.isAlphabetic,exports.isCamelCase=n.isCamelCase,exports.isEmail=n.isEmail,exports.isKebabCase=n.isKebabCase,exports.isLowerCase=n.isLowerCase,exports.isNonEmptyString=n.isNonEmptyString,exports.isNumericString=n.isNumericString,exports.isPascalCase=n.isPascalCase,exports.isSnakeCase=n.isSnakeCase,exports.isString=n.isString,exports.isURL=n.isURL,exports.isUpperCase=n.isUpperCase,exports.longestWord=n.longestWord,exports.longestWordLength=n.longestWordLength,exports.padLeft=n.padLeft,exports.padRight=n.padRight,exports.repeatString=n.repeatString,exports.shortestWord=n.shortestWord,exports.shortestWordLength=n.shortestWordLength,exports.splitString=n.splitString,exports.startsWithUppercase=n.startsWithUppercase,exports.string=n.default,exports.stripSymbols=n.stripSymbols,exports.trim=n.trim,exports.truncate=n.truncate,exports.uniqueChars=n.uniqueChars,exports.isArray=p.isArray,exports.isDefined=p.isDefined,exports.isUndefinedOrNull=p.isUndefinedOrNull;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { Environment, default as env, getRunTimeEnvironment, isBrowser, isDev, i
 export { ArchiveFormat, CreateArchiveOptions, createArchive, default as file } from './file/index.js';
 export { Hour, MinuteOrSecond, clamp, getMilliseconds, isEven, isOdd, default as number, randomFloat, randomInt } from './number/index.js';
 export { isEmptyObject, isNonEmptyObject, isObject, mergeObj, default as object } from './object/index.js';
-export { Trim, capitalize, containsWhitespace, endsWithPunctuation, isAlphabetic, isCamelCase, isEmail, isKebabCase, isLowerCase, isNonEmptyString, isNumericString, isPascalCase, isSnakeCase, isString, isURL, isUpperCase, padLeft, padRight, repeatString, startsWithUppercase, default as string, trim, truncate } from './string/index.js';
+export { Trim, capitalize, containsWhitespace, countChars, countFrequencies, countLines, countSubstring, countWords, endsWithPunctuation, isAlphabetic, isCamelCase, isEmail, isKebabCase, isLowerCase, isNonEmptyString, isNumericString, isPascalCase, isSnakeCase, isString, isURL, isUpperCase, longestWord, longestWordLength, padLeft, padRight, repeatString, shortestWord, shortestWordLength, splitString, startsWithUppercase, default as string, stripSymbols, trim, truncate, uniqueChars } from './string/index.js';
 export { ArchiverOptions } from 'archiver';
 
 /**

package/dist/index.js

@@ -1 +1 @@
-export{default as array}from"./array/index.js";export{all,default as char,digits,lowercase,uppercase}from"./char/index.js";export{Environment,default as env,getRunTimeEnvironment,isBrowser,isDev,isNode,isProd,isTest}from"./env/index.js";export{createArchive,default as file}from"./file/index.js";export{clamp,getMilliseconds,isEven,isOdd,default as number,randomFloat,randomInt}from"./number/index.js";export{isEmptyObject,isNonEmptyObject,isObject,mergeObj,default as object}from"./object/index.js";export{capitalize,containsWhitespace,endsWithPunctuation,isAlphabetic,isCamelCase,isEmail,isKebabCase,isLowerCase,isNonEmptyString,isNumericString,isPascalCase,isSnakeCase,isString,isURL,isUpperCase,padLeft,padRight,repeatString,startsWithUppercase,default as string,trim,truncate}from"./string/index.js";export{i as isArray,a as isDefined,b as isUndefinedOrNull}from"./validate-D9J7otjc.js";import"fs";import"path";import"events";import"constants";import"stream";import"util";import"assert";import"buffer";import"node:url";import"node:path";import"node:fs";import"node:fs/promises";import"node:events";import"node:stream";import"node:string_decoder";import"zlib";
+export{default as array}from"./array/index.js";export{all,default as char,digits,lowercase,uppercase}from"./char/index.js";export{Environment,default as env,getRunTimeEnvironment,isBrowser,isDev,isNode,isProd,isTest}from"./env/index.js";export{createArchive,default as file}from"./file/index.js";export{clamp,getMilliseconds,isEven,isOdd,default as number,randomFloat,randomInt}from"./number/index.js";export{isEmptyObject,isNonEmptyObject,isObject,mergeObj,default as object}from"./object/index.js";export{capitalize,containsWhitespace,countChars,countFrequencies,countLines,countSubstring,countWords,endsWithPunctuation,isAlphabetic,isCamelCase,isEmail,isKebabCase,isLowerCase,isNonEmptyString,isNumericString,isPascalCase,isSnakeCase,isString,isURL,isUpperCase,longestWord,longestWordLength,padLeft,padRight,repeatString,shortestWord,shortestWordLength,splitString,startsWithUppercase,default as string,stripSymbols,trim,truncate,uniqueChars}from"./string/index.js";export{i as isArray,a as isDefined,b as isUndefinedOrNull}from"./validate-D9J7otjc.js";import"fs";import"path";import"events";import"constants";import"stream";import"util";import"assert";import"buffer";import"node:url";import"node:path";import"node:fs";import"node:fs/promises";import"node:events";import"node:stream";import"node:string_decoder";import"zlib";

package/dist/string/index.cjs

@@ -1 +1 @@
-"use strict";function t(t){return t.replace(/^\w/,t=>t.toUpperCase())}function e(t,e,r=" "){return t.padStart(e,r)}function r(t,e,r=" "){return t.padEnd(e,r)}function s(t,e,r="..."){return t.length>e?t.slice(0,e-r.length)+r:t}function n(t,e){return t.repeat(e)}Object.defineProperty(exports,"__esModule",{value:!0});const i={function:t=>t.trim(),start:t=>t.trimStart(),end:t=>t.trimEnd(),normalizeWhitespace:t=>t.trim().replace(/\s+/g," ")};function a(t){return null!=t&&"string"==typeof t}function o(t,e=!0){return!!a(t)&&("string"==typeof t&&(e?t.trim().length>0:t.length>0))}function p(t){try{return new URL(t),!0}catch{return!1}}function u(t){return/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(t)}function c(t){return/^[a-zA-Z]+$/.test(t)}function f(t){return!isNaN(Number(t))&&!isNaN(parseFloat(t))}function l(t){return/^[A-Z]/.test(t)}function x(t){return/[\p{P}]$/u.test(t)}function g(t){return/\s/.test(t)}function m(t){return/^[a-z][a-zA-Z0-9]*$/.test(t)}function h(t){return/^[A-Z][a-zA-Z0-9]*$/.test(t)}function C(t){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(t)}function d(t){return/^[a-z0-9]+(_[a-z0-9]+)*$/.test(t)}function z(t){return/^[A-Z]+$/.test(t)}function S(t){return/^[a-z]+$/.test(t)}var N={capitalize:t,padLeft:e,padRight:r,truncate:s,repeatString:n,trim:i,isString:a,isNonEmptyString:o,isURL:p,isEmail:u,isAlphabetic:c,isNumericString:f,startsWithUppercase:l,endsWithPunctuation:x,containsWhitespace:g,isCamelCase:m,isPascalCase:h,isKebabCase:C,isSnakeCase:d,isUpperCase:z,isLowerCase:S};exports.capitalize=t,exports.containsWhitespace=g,exports.default=N,exports.endsWithPunctuation=x,exports.isAlphabetic=c,exports.isCamelCase=m,exports.isEmail=u,exports.isKebabCase=C,exports.isLowerCase=S,exports.isNonEmptyString=o,exports.isNumericString=f,exports.isPascalCase=h,exports.isSnakeCase=d,exports.isString=a,exports.isURL=p,exports.isUpperCase=z,exports.padLeft=e,exports.padRight=r,exports.repeatString=n,exports.startsWithUppercase=l,exports.trim=i,exports.truncate=s;
+"use strict";function t(t){return t.replace(/^\w/,t=>t.toUpperCase())}function e(t,e,n=" "){return t.padStart(e,n)}function n(t,e,n=" "){return t.padEnd(e,n)}function r(t,e,n="..."){return e<=0?"":t.length<=e?t:n.length>=e?n.slice(0,e):t.trim().slice(0,e)+n}function s(t,e){return t.repeat(e)}function i(t,e=""){return t.replace(/[^\p{L}\p{N}\s]/gu,e)}function o(t,e=/\s+/){return t.split(e)}function u(t,e){return e?[...t].filter(t=>t===e).length:o(t).length}function a(t){return o(t.trim()).length}function p(t,e){return 0===e.length?0:o(t,e).length-1}function c(t){return[...t].reduce((t,e)=>(t[e]=(t[e]||0)+1,t),{})}function l(t){return t?o(t,/\r\n|\r|\n/).length:0}function h(t){return[...new Set(t)]}function f(t){const e=o(t).map(t=>i(t)).filter(Boolean);return 0===e.length?0:e.reduce((t,e)=>Math.max(t,e.length),0)}function g(t){const e=o(t.trim()).map(t=>i(t)).filter(Boolean);return 0===e.length?0:e.reduce((t,e)=>Math.min(t,e.length),1/0)}function x(t){const e=o(t.trim()).map(t=>i(t)).filter(Boolean);if(0===e.length)return"";const n=Math.max(...e.map(t=>t.length)),r=e.filter(t=>t.length===n),s=[...new Set(r)];return 1===s.length?s[0]:s}function m(t){const e=o(t.trim()).map(t=>i(t)).filter(Boolean);if(0===e.length)return"";const n=Math.min(...e.map(t=>t.length)),r=e.filter(t=>t.length===n),s=[...new Set(r)];return 1===s.length?s[0]:s}Object.defineProperty(exports,"__esModule",{value:!0});const d={function:t=>t.trim(),start:t=>t.trimStart(),end:t=>t.trimEnd(),normalizeWhitespace:t=>t.trim().replace(/\s+/g," ")};function S(t){return null!=t&&"string"==typeof t}function C(t,e=!0){return!!S(t)&&("string"==typeof t&&(e?t.trim().length>0:t.length>0))}function W(t){try{return new URL(t),!0}catch{return!1}}function L(t){return/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(t)}function b(t){return/^[a-zA-Z]+$/.test(t)}function z(t){return!isNaN(Number(t))&&!isNaN(parseFloat(t))}function N(t){return/^[A-Z]/.test(t)}function $(t){return/[\p{P}]$/u.test(t)}function y(t){return/\s/.test(t)}function A(t){return/^[a-z][a-zA-Z0-9]*$/.test(t)}function U(t){return/^[A-Z][a-zA-Z0-9]*$/.test(t)}function w(t){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(t)}function E(t){return/^[a-z0-9]+(_[a-z0-9]+)*$/.test(t)}function P(t){return/^[A-Z]+$/.test(t)}function Z(t){return/^[a-z]+$/.test(t)}var M={capitalize:t,splitString:o,countChars:u,countWords:a,countSubstring:p,countFrequencies:c,countLines:l,uniqueChars:h,longestWordLength:f,shortestWordLength:g,longestWord:x,shortestWord:m,padLeft:e,padRight:n,truncate:r,repeatString:s,stripSymbols:i,trim:d,isString:S,isNonEmptyString:C,isURL:W,isEmail:L,isAlphabetic:b,isNumericString:z,startsWithUppercase:N,endsWithPunctuation:$,containsWhitespace:y,isCamelCase:A,isPascalCase:U,isKebabCase:w,isSnakeCase:E,isUpperCase:P,isLowerCase:Z};exports.capitalize=t,exports.containsWhitespace=y,exports.countChars=u,exports.countFrequencies=c,exports.countLines=l,exports.countSubstring=p,exports.countWords=a,exports.default=M,exports.endsWithPunctuation=$,exports.isAlphabetic=b,exports.isCamelCase=A,exports.isEmail=L,exports.isKebabCase=w,exports.isLowerCase=Z,exports.isNonEmptyString=C,exports.isNumericString=z,exports.isPascalCase=U,exports.isSnakeCase=E,exports.isString=S,exports.isURL=W,exports.isUpperCase=P,exports.longestWord=x,exports.longestWordLength=f,exports.padLeft=e,exports.padRight=n,exports.repeatString=s,exports.shortestWord=m,exports.shortestWordLength=g,exports.splitString=o,exports.startsWithUppercase=N,exports.stripSymbols=i,exports.trim=d,exports.truncate=r,exports.uniqueChars=h;

package/dist/string/index.d.ts

@@ -88,6 +88,230 @@ declare const trim: Trim;
  */
 declare function capitalize(value: string): string;
 
+/**
+ * Splits a string into an array of substrings using a given delimiter.
+ *
+ * @remarks
+ * - Defaults to splitting by whitespace using `/\s+/`.
+ * - Does not trim leading/trailing spaces unless explicitly passed.
+ * - Leading/trailing delimiters may produce empty strings.
+ * - With `/\s+/` specifically, consecutive whitespace is collapsed (no interior empty tokens).
+ *
+ * @returns An array of substrings.
+ *
+ * @example
+ * ```ts
+ * splitString("a b  c");      // ["a", "b", "c"]
+ * splitString("a,b,c", ",");  // ["a", "b", "c"]
+ * splitString("a1b2c3", /\d/); // ["a", "b", "c", ""]
+ * ```
+ */
+declare function splitString(
+/** The input string to split. */
+str: string, 
+/**
+ * The delimiter (string or RegExp)
+ *
+ * @default whitespace  `/\s+/`
+ */
+val?: string | RegExp): string[];
+/**
+ * Counts characters in a string.
+ *
+ * @remarks
+ * - If `char` is provided, only that character’s occurrences are counted.
+ * - If `char` is omitted, the function counts the number of substrings returned by {@link splitString} (similar to a word count).
+ *
+ * @returns Number of characters or character occurrences.
+ *
+ * @example
+ * ```ts
+ * countChars("banana");       // 6
+ * countChars("banana", "a");  // 3
+ * countChars("banana", "n");  // 2
+ * ```
+ */
+declare function countChars(
+/** The input string. */
+str: string, 
+/** Optional character to count. */
+char?: string): number;
+/**
+ * Counts the number of words in a string.
+ *
+ * @returns Number of words in the string.
+ *
+ * @example
+ * ```ts
+ * countWords("js utils kit");         // 3
+ * countWords("   js   utils   kit");  // 3
+ * countWords("");                     // 0
+ * ```
+ */
+declare function countWords(
+/** The input string */
+str: string): number;
+/**
+ * Counts how many times a substring occurs within a string.
+ *
+ * @remarks
+ * - Overlapping substrings are not double-counted.
+ * - Returns `0` if the substring is not found.
+ *
+ * @returns Number of times `sub` occurs in `str`.
+ *
+ * @example
+ * ```ts
+ * countSubstring("lololol", "lo"); // 3
+ * countSubstring("aaaaa", "a");    // 5
+ * countSubstring("hello", "z");    // 0
+ * ```
+ */
+declare function countSubstring(
+/** The input string. */
+str: string, 
+/** The substring to count. */
+sub: string): number;
+/**
+ * Builds a frequency map of characters in a string.
+ *
+ * @remarks
+ * - Returns an object where keys are characters and values are counts.
+ * - Case-sensitive by default.
+ *
+ * @returns A mapping of each character to its frequency.
+ *
+ * @example
+ * ```ts
+ * countFrequencies("banana");
+ * // { b: 1, a: 3, n: 2 }
+ *
+ * countFrequencies("");
+ * // {}
+ * ```
+ */
+declare function countFrequencies(
+/** The input string. */
+str: string): Record<string, number>;
+/**
+ * Counts the number of lines in a string.
+ *
+ * @remarks
+ * - Handles Unix (`\n`), Windows (`\r\n`), and old Mac (`\r`) line endings.
+ *
+ * @returns Number of lines in the string.
+ *
+ * @example
+ * ```ts
+ * countLines("a\nb\nc");     // 3
+ * countLines("a\r\nb\r\nc"); // 3
+ * countLines("hello");       // 1
+ * ```
+ */
+declare function countLines(
+/** The input string. */
+str: string): number;
+/**
+ * Returns an array of unique characters from a string.
+ *
+ * @remarks
+ * - Preserves order of first appearance.
+ *
+ * @returns Array of unique characters.
+ *
+ * @example
+ * ```ts
+ * uniqueChars("banana"); // ["b", "a", "n"]
+ * uniqueChars("");       // []
+ * ```
+ */
+declare function uniqueChars(
+/** The input string. */
+str: string): string[];
+/**
+ * Finds the length of the longest word in a string.
+ *
+ * @remarks
+ * - Words are split by whitespace (`/\s+/`).
+ * - Symbols (punctuation, special chars) are removed using {@link stripSymbols}.
+ * - Returns `0` if the string is empty or contains no words.
+ *
+ * @returns Length of the longest word.
+ *
+ * @example
+ * ```ts
+ * longestWordLength("js utils kit");              // 5
+ * longestWordLength("short   longerword   mid"); // 10
+ * longestWordLength("hello");                    // 5
+ * longestWordLength("");                         // 0
+ * ```
+ */
+declare function longestWordLength(
+/** The input string. */
+str: string): number;
+/**
+ * Finds the length of the shortest word in a string.
+ *
+ * @remarks
+ * - Words are split by whitespace (`/\s+/`).
+ * - Symbols (punctuation, special chars) are removed using {@link stripSymbols}.
+ * - Returns `0` if the string is empty or contains no words.
+ *
+ * @returns Length of the shortest word.
+ *
+ * @example
+ * ```ts
+ * shortestWordLength("js utils kit"); // 2
+ * shortestWordLength("one three five"); // 3
+ * shortestWordLength(""); // 0
+ * ```
+ */
+declare function shortestWordLength(
+/** The input string. */
+str: string): number;
+/**
+ * Finds the longest word(s) in a string.
+ *
+ * @remarks
+ * - If only one longest word exists, returns it as a string.
+ * - If multiple longest words have the same length, returns them as an array.
+ * - Returns an empty string if there are no words.
+ *
+ * @returns The longest word as a string, or an array of tied words.
+ *
+ * @example
+ * ```ts
+ * longestWord("js utils kit");              // "utils"
+ * longestWord("short   longerword   mid"); // "longerword"
+ * longestWord("hello");                    // "hello"
+ * longestWord("");                         // ""
+ * ```
+ */
+declare function longestWord(
+/** The input string. */
+str: string): string | string[];
+/**
+ * Finds the shortest word(s) in a string.
+ *
+ * @remarks
+ * - If only one shortest word exists, returns it as a string.
+ * - If multiple shortest words have the same length, returns them as an array.
+ * - Returns an empty string if there are no words.
+ *
+ * @returns The shortest word as a string, or an array of tied words.
+ *
+ * @example
+ * ```ts
+ * shortestWord("js utils kit"); // "js"
+ * shortestWord("one three five"); // "one"
+ * shortestWord("a ab abc abcd"); // "a"
+ * shortestWord(""); // ""
+ * ```
+ */
+declare function shortestWord(
+/** The input string. */
+str: string): string | string[];
+
 /**
  * Pads a string on the left with a specified character until it reaches the desired length.
  * @param str - The string to pad.
@@ -120,19 +344,28 @@ declare function padLeft(str: string, length: number, char?: string): string;
 declare function padRight(str: string, length: number, char?: string): string;
 /**
  * Truncates a string to a specified length, appending a suffix if the string is too long.
- * @param str - The string to truncate.
- * @param length - The maximum length of the resulting string (including the suffix).
- * @param suffix - The suffix to append if truncation occurs (defaults to "...").
+ *
  * @returns The truncated string with the suffix if the original string exceeds the length, otherwise the original string.
+ *
  * @example
  * ```ts
  * console.log(truncate("hello world", 8)); // "hello..."
  * console.log(truncate("hi", 5)); // "hi"
- * console.log(truncate("hello", 5, "...")); // "he..."
+ * console.log(truncate("hello", 5, "...")); // "hello"
  * console.log(truncate("", 3)); // ""
  * ```
  */
-declare function truncate(str: string, length: number, suffix?: string): string;
+declare function truncate(
+/** The string to truncate */
+str: string, 
+/** The maximum length of the resulting string */
+length: number, 
+/**
+ * The suffix to append if truncation occurs
+ *
+ * @default "..."
+ */
+suffix?: string): string;
 /**
  * Repeats a string a specified number of times.
  * @param str - The string to repeat.
@@ -147,6 +380,33 @@ declare function truncate(str: string, length: number, suffix?: string): string;
  * ```
  */
 declare function repeatString(str: string, count: number): string;
+/**
+ * Removes or replaces common symbol characters from a string.
+ *
+ * @remarks
+ * - Strips symbols like `- _ @ ! $ % ^ & # * ( ) + = , . ; : ' " < > ? / \ | [ ] { }`.
+ * - Keeps letters, numbers, and spaces intact.
+ * - By default, removes symbols (replaces with `""`).
+ *
+ * @returns A new string with symbols removed or replaced.
+ *
+ * @example
+ * ```ts
+ * stripSymbols("hello-world!");              // "helloworld"
+ * stripSymbols("hello-world!", " ");         // "hello world "
+ * stripSymbols("user_name@test", "_");       // "user_nametest"
+ * stripSymbols("symbols-only!!!", "*");      // "symbols-only***"
+ * ```
+ */
+declare function stripSymbols(
+/** The input string */
+str: string, 
+/**
+ * Optional replacement string for removed symbols.
+ *
+ * @default ""
+ */
+replacement?: string): string;
 
 /**
  * Determines whether the provided value is a string.
@@ -387,10 +647,22 @@ declare function isLowerCase(value: string): boolean;
 
 declare const _default: {
     capitalize: typeof capitalize;
+    splitString: typeof splitString;
+    countChars: typeof countChars;
+    countWords: typeof countWords;
+    countSubstring: typeof countSubstring;
+    countFrequencies: typeof countFrequencies;
+    countLines: typeof countLines;
+    uniqueChars: typeof uniqueChars;
+    longestWordLength: typeof longestWordLength;
+    shortestWordLength: typeof shortestWordLength;
+    longestWord: typeof longestWord;
+    shortestWord: typeof shortestWord;
     padLeft: typeof padLeft;
     padRight: typeof padRight;
     truncate: typeof truncate;
     repeatString: typeof repeatString;
+    stripSymbols: typeof stripSymbols;
     trim: Trim;
     isString: typeof isString;
     isNonEmptyString: typeof isNonEmptyString;
@@ -409,5 +681,5 @@ declare const _default: {
     isLowerCase: typeof isLowerCase;
 };
 
-export { capitalize, containsWhitespace, _default as default, endsWithPunctuation, isAlphabetic, isCamelCase, isEmail, isKebabCase, isLowerCase, isNonEmptyString, isNumericString, isPascalCase, isSnakeCase, isString, isURL, isUpperCase, padLeft, padRight, repeatString, startsWithUppercase, trim, truncate };
+export { capitalize, containsWhitespace, countChars, countFrequencies, countLines, countSubstring, countWords, _default as default, endsWithPunctuation, isAlphabetic, isCamelCase, isEmail, isKebabCase, isLowerCase, isNonEmptyString, isNumericString, isPascalCase, isSnakeCase, isString, isURL, isUpperCase, longestWord, longestWordLength, padLeft, padRight, repeatString, shortestWord, shortestWordLength, splitString, startsWithUppercase, stripSymbols, trim, truncate, uniqueChars };
 export type { Trim };

package/dist/string/index.js

@@ -1 +1 @@
-function t(t){return t.replace(/^\w/,t=>t.toUpperCase())}function n(t,n,e=" "){return t.padStart(n,e)}function e(t,n,e=" "){return t.padEnd(n,e)}function r(t,n,e="..."){return t.length>n?t.slice(0,n-e.length)+e:t}function i(t,n){return t.repeat(n)}const a={function:t=>t.trim(),start:t=>t.trimStart(),end:t=>t.trimEnd(),normalizeWhitespace:t=>t.trim().replace(/\s+/g," ")};function s(t){return null!=t&&"string"==typeof t}function u(t,n=!0){return!!s(t)&&("string"==typeof t&&(n?t.trim().length>0:t.length>0))}function c(t){try{return new URL(t),!0}catch{return!1}}function o(t){return/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(t)}function f(t){return/^[a-zA-Z]+$/.test(t)}function p(t){return!isNaN(Number(t))&&!isNaN(parseFloat(t))}function l(t){return/^[A-Z]/.test(t)}function g(t){return/[\p{P}]$/u.test(t)}function m(t){return/\s/.test(t)}function h(t){return/^[a-z][a-zA-Z0-9]*$/.test(t)}function z(t){return/^[A-Z][a-zA-Z0-9]*$/.test(t)}function d(t){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(t)}function $(t){return/^[a-z0-9]+(_[a-z0-9]+)*$/.test(t)}function C(t){return/^[A-Z]+$/.test(t)}function A(t){return/^[a-z]+$/.test(t)}var N={capitalize:t,padLeft:n,padRight:e,truncate:r,repeatString:i,trim:a,isString:s,isNonEmptyString:u,isURL:c,isEmail:o,isAlphabetic:f,isNumericString:p,startsWithUppercase:l,endsWithPunctuation:g,containsWhitespace:m,isCamelCase:h,isPascalCase:z,isKebabCase:d,isSnakeCase:$,isUpperCase:C,isLowerCase:A};export{t as capitalize,m as containsWhitespace,N as default,g as endsWithPunctuation,f as isAlphabetic,h as isCamelCase,o as isEmail,d as isKebabCase,A as isLowerCase,u as isNonEmptyString,p as isNumericString,z as isPascalCase,$ as isSnakeCase,s as isString,c as isURL,C as isUpperCase,n as padLeft,e as padRight,i as repeatString,l as startsWithUppercase,a as trim,r as truncate};
+function t(t){return t.replace(/^\w/,t=>t.toUpperCase())}function n(t,n,e=" "){return t.padStart(n,e)}function e(t,n,e=" "){return t.padEnd(n,e)}function r(t,n,e="..."){return n<=0?"":t.length<=n?t:e.length>=n?e.slice(0,n):t.trim().slice(0,n)+e}function i(t,n){return t.repeat(n)}function u(t,n=""){return t.replace(/[^\p{L}\p{N}\s]/gu,n)}function s(t,n=/\s+/){return t.split(n)}function o(t,n){return n?[...t].filter(t=>t===n).length:s(t).length}function a(t){return s(t.trim()).length}function c(t,n){return 0===n.length?0:s(t,n).length-1}function l(t){return[...t].reduce((t,n)=>(t[n]=(t[n]||0)+1,t),{})}function f(t){return t?s(t,/\r\n|\r|\n/).length:0}function h(t){return[...new Set(t)]}function g(t){const n=s(t).map(t=>u(t)).filter(Boolean);return 0===n.length?0:n.reduce((t,n)=>Math.max(t,n.length),0)}function p(t){const n=s(t.trim()).map(t=>u(t)).filter(Boolean);return 0===n.length?0:n.reduce((t,n)=>Math.min(t,n.length),1/0)}function m(t){const n=s(t.trim()).map(t=>u(t)).filter(Boolean);if(0===n.length)return"";const e=Math.max(...n.map(t=>t.length)),r=n.filter(t=>t.length===e),i=[...new Set(r)];return 1===i.length?i[0]:i}function d(t){const n=s(t.trim()).map(t=>u(t)).filter(Boolean);if(0===n.length)return"";const e=Math.min(...n.map(t=>t.length)),r=n.filter(t=>t.length===e),i=[...new Set(r)];return 1===i.length?i[0]:i}const S={function:t=>t.trim(),start:t=>t.trimStart(),end:t=>t.trimEnd(),normalizeWhitespace:t=>t.trim().replace(/\s+/g," ")};function z(t){return null!=t&&"string"==typeof t}function C(t,n=!0){return!!z(t)&&("string"==typeof t&&(n?t.trim().length>0:t.length>0))}function W(t){try{return new URL(t),!0}catch{return!1}}function $(t){return/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(t)}function L(t){return/^[a-zA-Z]+$/.test(t)}function N(t){return!isNaN(Number(t))&&!isNaN(parseFloat(t))}function A(t){return/^[A-Z]/.test(t)}function b(t){return/[\p{P}]$/u.test(t)}function w(t){return/\s/.test(t)}function Z(t){return/^[a-z][a-zA-Z0-9]*$/.test(t)}function y(t){return/^[A-Z][a-zA-Z0-9]*$/.test(t)}function U(t){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(t)}function B(t){return/^[a-z0-9]+(_[a-z0-9]+)*$/.test(t)}function E(t){return/^[A-Z]+$/.test(t)}function M(t){return/^[a-z]+$/.test(t)}var x={capitalize:t,splitString:s,countChars:o,countWords:a,countSubstring:c,countFrequencies:l,countLines:f,uniqueChars:h,longestWordLength:g,shortestWordLength:p,longestWord:m,shortestWord:d,padLeft:n,padRight:e,truncate:r,repeatString:i,stripSymbols:u,trim:S,isString:z,isNonEmptyString:C,isURL:W,isEmail:$,isAlphabetic:L,isNumericString:N,startsWithUppercase:A,endsWithPunctuation:b,containsWhitespace:w,isCamelCase:Z,isPascalCase:y,isKebabCase:U,isSnakeCase:B,isUpperCase:E,isLowerCase:M};export{t as capitalize,w as containsWhitespace,o as countChars,l as countFrequencies,f as countLines,c as countSubstring,a as countWords,x as default,b as endsWithPunctuation,L as isAlphabetic,Z as isCamelCase,$ as isEmail,U as isKebabCase,M as isLowerCase,C as isNonEmptyString,N as isNumericString,y as isPascalCase,B as isSnakeCase,z as isString,W as isURL,E as isUpperCase,m as longestWord,g as longestWordLength,n as padLeft,e as padRight,i as repeatString,d as shortestWord,p as shortestWordLength,s as splitString,A as startsWithUppercase,u as stripSymbols,S as trim,r as truncate,h as uniqueChars};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "js-utils-kit",
   "displayName": "JS Utils Kit",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Essential JavaScript helpers",
   "license": "MIT",
   "private": false,