@asaidimu/utils-strings 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Saidimu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,195 @@
+# `@asaidimu/utils-strings`
+
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)
+![npm version](https://img.shields.io/npm/v/@asaidimu/utils-strings?style=for-the-badge)
+
+A comprehensive utility library providing static methods for robust string manipulation, validation, formatting, and UI-specific transformations.
+
+## Table of Contents
+
+- [Features](#features)
+- [Technology Stack](#technology-stack)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+  - [Case Conversion](#case-conversion)
+  - [Validation & Checks](#validation--checks)
+  - [Manipulation](#manipulation)
+  - [UI & Localization Formatting](#ui--localization-formatting)
+  - [Hashing](#hashing)
+- [Configuration](#configuration)
+- [Development](#development)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
+`@asaidimu/utils-strings` is a TypeScript-first utility library designed to be a foundational toolkit for applications requiring robust string handling, from data processing to user interface rendering. It centralizes common string operations, ensuring consistency and reducing boilerplate across projects.
+
+This library provides a single, well-tested, and comprehensive `String` class with static methods to address a wide array of common string-related tasks. By offering a consistent API for these operations, it aims to improve code quality, enhance developer efficiency, and ensure predictable string behavior across applications.
+
+## Features
+
+`@asaidimu/utils-strings` offers a rich set of features, including:
+
+- **Case Conversion:** Convert strings to uppercase, lowercase, capitalize, camelCase, kebab-case, snake_case, PascalCase, sentence case, and title case.
+- **Validation & Checks:** Check for null, undefined, empty, or whitespace-only strings; verify if a string starts with, ends with, or contains a substring; and validate if a string consists purely of numeric or alphabetic characters.
+- **Manipulation:** Trim whitespace, truncate strings with an ellipsis, reverse strings, replace all occurrences of a substring, remove diacritical marks (accents), and slugify strings for URL-friendly formats.
+- **UI & Localization Formatting:** Handle basic pluralization logic, escape HTML special characters to prevent XSS, and format numbers as currency for localized display.
+- **Hashing:** Generate short, deterministic hashes for strings.
+
+## Technology Stack
+
+This library is built with:
+
+- **TypeScript**: Ensures type safety and improves developer experience.
+- **JavaScript**: The compiled output is fully compatible with JavaScript environments.
+
+## Installation
+
+You can install `@asaidimu/utils-strings` using npm or yarn:
+
+```bash
+npm install @asaidimu/utils-strings
+# or
+yarn add @asaidimu/utils-strings
+```
+
+## Quick Start
+
+Once installed, you can import and use the `String` class directly:
+
+```typescript
+import { String } from "@asaidimu/utils-strings";
+
+// Basic Usage
+console.log(String.capitalize("hello world")); // Output: "Hello world"
+console.log(String.kebabCase("HelloWorld")); // Output: "hello-world"
+console.log(String.isEmpty("")); // Output: true
+console.log(String.formatCurrency(123.45, "en-US", "USD")); // Output: "$123.45"
+
+// More examples
+const text = "  Crème Brûlée Dessert  ";
+console.log(String.slugify(text)); // Output: "creme-brulee-dessert"
+console.log(String.escapeHtml(`<script>alert('xss')</script>`)); // Output: "&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;"
+```
+
+## Usage
+
+Here are detailed examples of the various utility methods available in `String`.
+
+### Case Conversion
+
+```typescript
+import { String } from "@asaidimu/utils-strings";
+
+String.uppercase("hello"); // Returns "HELLO"
+String.lowercase("HELLO"); // Returns "hello"
+String.capitalize("hello world"); // Returns "Hello world"
+String.camelCase("foo bar baz"); // Returns "fooBarBaz"
+String.kebabCase("fooBarBaz"); // Returns "foo-bar-baz"
+String.snakeCase("fooBarBaz"); // Returns "foo_bar_baz"
+String.pascalCase("hello world"); // Returns "HelloWorld"
+String.toSentenceCase("hello WORLD"); // Returns "Hello world"
+String.toTitleCase("the quick brown fox"); // Returns "The Quick Brown Fox"
+```
+
+### Validation & Checks
+
+```typescript
+import { String } from "@asaidimu/utils-strings";
+
+String.isEmpty(null); // Returns true
+String.isWhitespace("   "); // Returns true
+String.startsWith("hello world", "hello"); // Returns true
+String.endsWith("hello world", "world"); // Returns true
+String.contains("hello world", "lo w"); // Returns true
+String.isNumeric("123"); // Returns true
+String.isAlpha("abc"); // Returns true
+```
+
+### Manipulation
+
+```typescript
+import { String } from "@asaidimu/utils-strings";
+
+String.trim("  hello  "); // Returns "hello"
+String.truncate("Long text example", 10); // Returns "Long text..."
+String.reverse("hello"); // Returns "olleh"
+String.replaceAll("banana", "a", "o"); // Returns "bonono"
+String.removeAccents("crème brûlée"); // Returns "creme brulee"
+String.slugify("Hello World! This is a test."); // Returns "hello-world-this-is-a-test"
+```
+
+### UI & Localization Formatting
+
+```typescript
+import { String } from "@asaidimu/utils-strings";
+
+String.pluralize(1, "item"); // Returns "item"
+String.pluralize(2, "item"); // Returns "items"
+String.escapeHtml(`<div>content</div>`); // Returns "&lt;div&gt;content&lt;/div&gt;"
+String.formatCurrency(1234.5, "de-DE", "EUR"); // Returns "1.234,50 €"
+```
+
+### Hashing
+
+```typescript
+import { String } from "@asaidimu/utils-strings";
+
+String.hash("my-secret-string"); // Returns a short, deterministic hash like "03a7jk"
+String.hash("another-string", 8); // Returns a hash of length 8
+```
+
+## Configuration
+
+This library currently does not require any external configuration.
+
+## Development
+
+To set up the project for local development, follow these steps:
+
+1.  **Clone the repository:**
+
+    ```bash
+    git clone https://github.com/asaidimu/erp-utils.git
+    cd erp-utils/src/strings
+    ```
+
+2.  **Install dependencies:**
+
+    ```bash
+    bun install
+    # or
+    yarn install
+    ```
+
+3.  **Build the project (if needed):**
+    _(No specific build script provided, typically handled by consumer or pre-publish)_
+
+## Testing
+
+Tests are run using [Vitest](https://vitest.dev/).
+
+- **Run all tests:**
+  ```bash
+  bun test
+  ```
+- **Run tests in watch mode:**
+  ```bash
+  bun run test:watch
+  ```
+- **Run tests in a browser environment:**
+  ```bash
+  bun run test:browser
+  ```
+
+## Contributing
+
+Contributions are welcome! Please refer to the main repository for guidelines on how to contribute:
+
+[https://github.com/asaidimu/erp-utils](https://github.com/asaidimu/erp-utils)
+
+## License
+
+This project is licensed under the MIT License - see the `LICENSE` file for details.

package/index.d.mts

@@ -0,0 +1,272 @@
+/**
+ * @class StringUtils
+ * @description A comprehensive utility class providing static methods for string manipulation, validation,
+ *   formatting, and UI-specific transformations. Designed to be a foundational toolkit for applications
+ *   requiring robust string handling, from data processing to user interface rendering.
+ */
+declare class StringUtils {
+    /**
+     * Converts a string to uppercase.
+     * @param s The input string.
+     * @returns The uppercase version of the string.
+     * @example
+     * StringUtils.uppercase("hello"); // Returns "HELLO"
+     */
+    static uppercase(s: string): string;
+    /**
+     * Converts a string to lowercase.
+     * @param s The input string.
+     * @returns The lowercase version of the string.
+     * @example
+     * StringUtils.lowercase("HELLO"); // Returns "hello"
+     */
+    static lowercase(s: string): string;
+    /**
+     * Capitalizes the first letter of a string. If a separator is provided,
+     * it splits the string by the separator, capitalizes each word, and then joins them back.
+     * @param s The input string.
+     * @param separator Optional. The string to use as a word separator for multi-word capitalization.
+     * @returns The capitalized string.
+     * @example
+     * StringUtils.capitalize("hello world"); // Returns "Hello world"
+     * StringUtils.capitalize("hello world", " "); // Returns "Hello World"
+     * StringUtils.capitalize("foo-bar", "-"); // Returns "Foo-Bar"
+     */
+    static capitalize(s: string, separator?: string): string;
+    /**
+     * Generates a short, deterministic hash of a string.
+     */
+    static hash(s: string, length?: number): string;
+    /**
+     * Checks if a string is null, undefined, or an empty string.
+     * @param s The input string, which can be null or undefined.
+     * @returns True if the string is null, undefined, or empty; otherwise, false.
+     * @example
+     * StringUtils.isEmpty(null);    // Returns true
+     * StringUtils.isEmpty("");      // Returns true
+     * StringUtils.isEmpty("abc");   // Returns false
+     */
+    static isEmpty(s: string | null | undefined): boolean;
+    /**
+     * Checks if a string is null, undefined, empty, or consists only of whitespace characters.
+     * @param s The input string, which can be null or undefined.
+     * @returns True if the string is null, undefined, empty, or only whitespace; otherwise, false.
+     * @example
+     * StringUtils.isWhitespace(null);       // Returns true
+     * StringUtils.isWhitespace("   ");      // Returns true
+     * StringUtils.isWhitespace(" abc ");    // Returns false
+     */
+    static isWhitespace(s: string | null | undefined): boolean;
+    /**
+     * Removes whitespace from both ends of a string.
+     * @param s The input string.
+     * @returns The string with leading and trailing whitespace removed.
+     * @example
+     * StringUtils.trim("  hello world  "); // Returns "hello world"
+     */
+    static trim(s: string): string;
+    /**
+     * Truncates a string to a specified maximum length. If the string exceeds the length,
+     * it appends an ellipsis (or custom string) at the end.
+     * @param s The input string.
+     * @param maxLength The maximum length of the output string (including ellipsis).
+     * @param ellipsis Optional. The string to append if truncation occurs. Defaults to "...".
+     * @returns The truncated string.
+     * @example
+     * StringUtils.truncate("Long text example", 10);      // Returns "Long text..."
+     * StringUtils.truncate("Short text", 10);             // Returns "Short text"
+     * StringUtils.truncate("Very long string", 8, "..."); // Returns "Very lo..."
+     */
+    static truncate(s: string, maxLength: number, ellipsis?: string): string;
+    /**
+     * Checks if a string begins with the specified prefix.
+     * @param s The input string.
+     * @param prefix The prefix to search for.
+     * @returns True if the string starts with the prefix; otherwise, false.
+     * @example
+     * StringUtils.startsWith("hello world", "hello"); // Returns true
+     * StringUtils.startsWith("hello world", "world"); // Returns false
+     */
+    static startsWith(s: string, prefix: string): boolean;
+    /**
+     * Checks if a string ends with the specified suffix.
+     * @param s The input string.
+     * @param suffix The suffix to search for.
+     * @returns True if the string ends with the suffix; otherwise, false.
+     * @example
+     * StringUtils.endsWith("hello world", "world"); // Returns true
+     * StringUtils.endsWith("hello world", "hello"); // Returns false
+     */
+    static endsWith(s: string, suffix: string): boolean;
+    /**
+     * Checks if a string contains the specified substring.
+     * @param s The input string.
+     * @param sub The substring to search for.
+     * @returns True if the string contains the substring; otherwise, false.
+     * @example
+     * StringUtils.contains("hello world", "lo w"); // Returns true
+     * StringUtils.contains("hello world", "xyz");  // Returns false
+     */
+    static contains(s: string, sub: string): boolean;
+    /**
+     * Checks if a string consists only of numeric digits.
+     * @param s The input string.
+     * @returns True if the string contains only digits; otherwise, false.
+     * @example
+     * StringUtils.isNumeric("123");   // Returns true
+     * StringUtils.isNumeric("123a");  // Returns false
+     * StringUtils.isNumeric("");      // Returns false
+     */
+    static isNumeric(s: string): boolean;
+    /**
+     * Checks if a string consists only of alphabetic characters (a-z, A-Z).
+     * @param s The input string.
+     * @returns True if the string contains only alphabetic characters; otherwise, false.
+     * @example
+     * StringUtils.isAlpha("abc");     // Returns true
+     * StringUtils.isAlpha("abc1");    // Returns false
+     * StringUtils.isAlpha("");        // Returns false
+     */
+    static isAlpha(s: string): boolean;
+    /**
+     * Converts a string to camelCase.
+     * Handles spaces, hyphens, and underscores.
+     * @param s The input string.
+     * @returns The camelCase version of the string.
+     * @example
+     * StringUtils.camelCase("hello world");     // Returns "helloWorld"
+     * StringUtils.camelCase("foo-bar-baz");     // Returns "fooBarBaz"
+     * StringUtils.camelCase("foo_bar_baz");     // Returns "fooBarBaz"
+     */
+    static camelCase(s: string): string;
+    /**
+     * Converts a string to kebab-case.
+     * Handles spaces, camelCase, and underscores.
+     * @param s The input string.
+     * @returns The kebab-case version of the string.
+     * @example
+     * StringUtils.kebabCase("hello world");     // Returns "hello-world"
+     * StringUtils.kebabCase("fooBarBaz");       // Returns "foo-bar-baz"
+     * StringUtils.kebabCase("Foo_Bar-Baz");     // Returns "foo-bar-baz"
+     */
+    static kebabCase(s: string): string;
+    /**
+     * Converts a string to snake_case.
+     * Handles spaces, camelCase, and hyphens.
+     * @param s The input string.
+     * @returns The snake_case version of the string.
+     * @example
+     * StringUtils.snakeCase("hello world");     // Returns "hello_world"
+     * StringUtils.snakeCase("fooBarBaz");       // Returns "foo_bar_baz"
+     * StringUtils.snakeCase("Foo-Bar_Baz");     // Returns "foo_bar_baz"
+     */
+    static snakeCase(s: string): string;
+    /**
+     * Converts a string to PascalCase.
+     * Handles spaces, hyphens, and underscores.
+     * @param s The input string.
+     * @returns The PascalCase version of the string.
+     * @example
+     * StringUtils.pascalCase("hello world");    // Returns "HelloWorld"
+     * StringUtils.pascalCase("foo-bar-baz");    // Returns "FooBarBaz"
+     * StringUtils.pascalCase("foo_bar_baz");    // Returns "FooBarBaz"
+     */
+    static pascalCase(s: string): string;
+    /**
+     * Reverses the order of characters in a string.
+     * @param s The input string.
+     * @returns The reversed string.
+     * @example
+     * StringUtils.reverse("hello"); // Returns "olleh"
+     */
+    static reverse(s: string): string;
+    /**
+     * Replaces all occurrences of a specified substring with another string.
+     * @param s The input string.
+     * @param search The substring to search for.
+     * @param replacement The string to replace with.
+     * @returns The string with all occurrences replaced.
+     * @example
+     * StringUtils.replaceAll("banana", "a", "o"); // Returns "bonono"
+     */
+    static replaceAll(s: string, search: string, replacement: string): string;
+    /**
+     * Removes diacritical marks (accents) from a string.
+     * @param s The input string.
+     * @returns The string with accents removed.
+     * @example
+     * StringUtils.removeAccents("crème brûlée"); // Returns "creme brulee"
+     */
+    static removeAccents(s: string): string;
+    /**
+     * Converts a string to a URL-friendly slug.
+     * Removes accents, converts to lowercase, trims, replaces non-alphanumeric characters with hyphens,
+     * and consolidates multiple hyphens.
+     * @param s The input string.
+     * @returns The slugified string.
+     * @example
+     * StringUtils.slugify("Hello World! This is a test."); // Returns "hello-world-this-is-a-test"
+     * StringUtils.slugify("Crème brûlée"); // Returns "creme-brulee"
+     */
+    static slugify(s: string): string;
+    /**
+     * Capitalizes only the first letter of the string and converts the rest to lowercase.
+     * Useful for UI elements like headers and labels where proper sentence casing is required.
+     * @param s The input string.
+     * @returns The string in sentence case.
+     * @example
+     * StringUtils.toSentenceCase("hello WORLD"); // Returns "Hello world"
+     * StringUtils.toSentenceCase("a quick BROWN fox"); // Returns "A quick brown fox"
+     */
+    static toSentenceCase(s: string): string;
+    /**
+     * Capitalizes every word in a string, handling camelCase and special characters gracefully.
+     * Ensures consistent capitalization for UI components like card titles, buttons, or navigation items.
+     * @param s The input string.
+     * @returns The string in title case.
+     * @example
+     * StringUtils.toTitleCase("hello world");       // Returns "Hello World"
+     * StringUtils.toTitleCase("some_variable_name"); // Returns "Some Variable Name"
+     * StringUtils.toTitleCase("yetAnotherString");  // Returns "Yet Another String"
+     * StringUtils.toTitleCase("the quick brown fox"); // Returns "The Quick Brown Fox"
+     */
+    static toTitleCase(s: string): string;
+    /**
+     * Handles basic pluralization logic for displaying counts, e.g., "1 item" vs "2 items".
+     * @param count The number of items.
+     * @param singular The singular form of the word (e.g., "item", "person").
+     * @param plural Optional. The plural form of the word. If not provided, it defaults to appending 's'.
+     * @returns The appropriate singular or plural form of the word based on the count.
+     * @example
+     * StringUtils.pluralize(1, "item");    // Returns "item"
+     * StringUtils.pluralize(2, "item");    // Returns "items"
+     * StringUtils.pluralize(0, "item");    // Returns "items"
+     * StringUtils.pluralize(1, "sheep", "sheep"); // Returns "sheep"
+     * StringUtils.pluralize(2, "sheep", "sheep"); // Returns "sheep"
+     */
+    static pluralize(count: number, singular: string, plural?: string): string;
+    /**
+     * Prevents Cross-Site Scripting (XSS) by escaping HTML special characters in a string.
+     * Converts characters like '<', '>', '&', '"', "'" into their corresponding HTML entities.
+     * Essential for safely rendering user-generated content or dynamic text directly into the DOM.
+     * @param s The input string.
+     * @returns The HTML-escaped string.
+     * @example
+     * StringUtils.escapeHtml(`"<script>alert('xss')</script>"`); // Returns "&quot;&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;&quot;`
+     */
+    static escapeHtml(s: string): string;
+    /**
+     * Formats a number as currency for localized display, using `Intl.NumberFormat`.
+     * @param amount The number to format.
+     * @param locale Optional. The locale string (e.g., "en-US", "de-DE"). Defaults to "en-US".
+     * @param currency Optional. The currency code (e.g., "USD", "EUR"). Defaults to "USD".
+     * @returns The formatted currency string.
+     * @example
+     * StringUtils.formatCurrency(1234.50, "en-US", "USD"); // Returns "$1,234.50"
+     * StringUtils.formatCurrency(1234.50, "de-DE", "EUR"); // Returns "1.234,50 €"
+     * StringUtils.formatCurrency(5678, "ja-JP", "JPY");   // Returns "￥5,678"
+     */
+    static formatCurrency(amount: number, locale?: string, currency?: string): string;
+}
+
+export { StringUtils };

package/index.d.ts

@@ -0,0 +1,272 @@
+/**
+ * @class StringUtils
+ * @description A comprehensive utility class providing static methods for string manipulation, validation,
+ *   formatting, and UI-specific transformations. Designed to be a foundational toolkit for applications
+ *   requiring robust string handling, from data processing to user interface rendering.
+ */
+declare class StringUtils {
+    /**
+     * Converts a string to uppercase.
+     * @param s The input string.
+     * @returns The uppercase version of the string.
+     * @example
+     * StringUtils.uppercase("hello"); // Returns "HELLO"
+     */
+    static uppercase(s: string): string;
+    /**
+     * Converts a string to lowercase.
+     * @param s The input string.
+     * @returns The lowercase version of the string.
+     * @example
+     * StringUtils.lowercase("HELLO"); // Returns "hello"
+     */
+    static lowercase(s: string): string;
+    /**
+     * Capitalizes the first letter of a string. If a separator is provided,
+     * it splits the string by the separator, capitalizes each word, and then joins them back.
+     * @param s The input string.
+     * @param separator Optional. The string to use as a word separator for multi-word capitalization.
+     * @returns The capitalized string.
+     * @example
+     * StringUtils.capitalize("hello world"); // Returns "Hello world"
+     * StringUtils.capitalize("hello world", " "); // Returns "Hello World"
+     * StringUtils.capitalize("foo-bar", "-"); // Returns "Foo-Bar"
+     */
+    static capitalize(s: string, separator?: string): string;
+    /**
+     * Generates a short, deterministic hash of a string.
+     */
+    static hash(s: string, length?: number): string;
+    /**
+     * Checks if a string is null, undefined, or an empty string.
+     * @param s The input string, which can be null or undefined.
+     * @returns True if the string is null, undefined, or empty; otherwise, false.
+     * @example
+     * StringUtils.isEmpty(null);    // Returns true
+     * StringUtils.isEmpty("");      // Returns true
+     * StringUtils.isEmpty("abc");   // Returns false
+     */
+    static isEmpty(s: string | null | undefined): boolean;
+    /**
+     * Checks if a string is null, undefined, empty, or consists only of whitespace characters.
+     * @param s The input string, which can be null or undefined.
+     * @returns True if the string is null, undefined, empty, or only whitespace; otherwise, false.
+     * @example
+     * StringUtils.isWhitespace(null);       // Returns true
+     * StringUtils.isWhitespace("   ");      // Returns true
+     * StringUtils.isWhitespace(" abc ");    // Returns false
+     */
+    static isWhitespace(s: string | null | undefined): boolean;
+    /**
+     * Removes whitespace from both ends of a string.
+     * @param s The input string.
+     * @returns The string with leading and trailing whitespace removed.
+     * @example
+     * StringUtils.trim("  hello world  "); // Returns "hello world"
+     */
+    static trim(s: string): string;
+    /**
+     * Truncates a string to a specified maximum length. If the string exceeds the length,
+     * it appends an ellipsis (or custom string) at the end.
+     * @param s The input string.
+     * @param maxLength The maximum length of the output string (including ellipsis).
+     * @param ellipsis Optional. The string to append if truncation occurs. Defaults to "...".
+     * @returns The truncated string.
+     * @example
+     * StringUtils.truncate("Long text example", 10);      // Returns "Long text..."
+     * StringUtils.truncate("Short text", 10);             // Returns "Short text"
+     * StringUtils.truncate("Very long string", 8, "..."); // Returns "Very lo..."
+     */
+    static truncate(s: string, maxLength: number, ellipsis?: string): string;
+    /**
+     * Checks if a string begins with the specified prefix.
+     * @param s The input string.
+     * @param prefix The prefix to search for.
+     * @returns True if the string starts with the prefix; otherwise, false.
+     * @example
+     * StringUtils.startsWith("hello world", "hello"); // Returns true
+     * StringUtils.startsWith("hello world", "world"); // Returns false
+     */
+    static startsWith(s: string, prefix: string): boolean;
+    /**
+     * Checks if a string ends with the specified suffix.
+     * @param s The input string.
+     * @param suffix The suffix to search for.
+     * @returns True if the string ends with the suffix; otherwise, false.
+     * @example
+     * StringUtils.endsWith("hello world", "world"); // Returns true
+     * StringUtils.endsWith("hello world", "hello"); // Returns false
+     */
+    static endsWith(s: string, suffix: string): boolean;
+    /**
+     * Checks if a string contains the specified substring.
+     * @param s The input string.
+     * @param sub The substring to search for.
+     * @returns True if the string contains the substring; otherwise, false.
+     * @example
+     * StringUtils.contains("hello world", "lo w"); // Returns true
+     * StringUtils.contains("hello world", "xyz");  // Returns false
+     */
+    static contains(s: string, sub: string): boolean;
+    /**
+     * Checks if a string consists only of numeric digits.
+     * @param s The input string.
+     * @returns True if the string contains only digits; otherwise, false.
+     * @example
+     * StringUtils.isNumeric("123");   // Returns true
+     * StringUtils.isNumeric("123a");  // Returns false
+     * StringUtils.isNumeric("");      // Returns false
+     */
+    static isNumeric(s: string): boolean;
+    /**
+     * Checks if a string consists only of alphabetic characters (a-z, A-Z).
+     * @param s The input string.
+     * @returns True if the string contains only alphabetic characters; otherwise, false.
+     * @example
+     * StringUtils.isAlpha("abc");     // Returns true
+     * StringUtils.isAlpha("abc1");    // Returns false
+     * StringUtils.isAlpha("");        // Returns false
+     */
+    static isAlpha(s: string): boolean;
+    /**
+     * Converts a string to camelCase.
+     * Handles spaces, hyphens, and underscores.
+     * @param s The input string.
+     * @returns The camelCase version of the string.
+     * @example
+     * StringUtils.camelCase("hello world");     // Returns "helloWorld"
+     * StringUtils.camelCase("foo-bar-baz");     // Returns "fooBarBaz"
+     * StringUtils.camelCase("foo_bar_baz");     // Returns "fooBarBaz"
+     */
+    static camelCase(s: string): string;
+    /**
+     * Converts a string to kebab-case.
+     * Handles spaces, camelCase, and underscores.
+     * @param s The input string.
+     * @returns The kebab-case version of the string.
+     * @example
+     * StringUtils.kebabCase("hello world");     // Returns "hello-world"
+     * StringUtils.kebabCase("fooBarBaz");       // Returns "foo-bar-baz"
+     * StringUtils.kebabCase("Foo_Bar-Baz");     // Returns "foo-bar-baz"
+     */
+    static kebabCase(s: string): string;
+    /**
+     * Converts a string to snake_case.
+     * Handles spaces, camelCase, and hyphens.
+     * @param s The input string.
+     * @returns The snake_case version of the string.
+     * @example
+     * StringUtils.snakeCase("hello world");     // Returns "hello_world"
+     * StringUtils.snakeCase("fooBarBaz");       // Returns "foo_bar_baz"
+     * StringUtils.snakeCase("Foo-Bar_Baz");     // Returns "foo_bar_baz"
+     */
+    static snakeCase(s: string): string;
+    /**
+     * Converts a string to PascalCase.
+     * Handles spaces, hyphens, and underscores.
+     * @param s The input string.
+     * @returns The PascalCase version of the string.
+     * @example
+     * StringUtils.pascalCase("hello world");    // Returns "HelloWorld"
+     * StringUtils.pascalCase("foo-bar-baz");    // Returns "FooBarBaz"
+     * StringUtils.pascalCase("foo_bar_baz");    // Returns "FooBarBaz"
+     */
+    static pascalCase(s: string): string;
+    /**
+     * Reverses the order of characters in a string.
+     * @param s The input string.
+     * @returns The reversed string.
+     * @example
+     * StringUtils.reverse("hello"); // Returns "olleh"
+     */
+    static reverse(s: string): string;
+    /**
+     * Replaces all occurrences of a specified substring with another string.
+     * @param s The input string.
+     * @param search The substring to search for.
+     * @param replacement The string to replace with.
+     * @returns The string with all occurrences replaced.
+     * @example
+     * StringUtils.replaceAll("banana", "a", "o"); // Returns "bonono"
+     */
+    static replaceAll(s: string, search: string, replacement: string): string;
+    /**
+     * Removes diacritical marks (accents) from a string.
+     * @param s The input string.
+     * @returns The string with accents removed.
+     * @example
+     * StringUtils.removeAccents("crème brûlée"); // Returns "creme brulee"
+     */
+    static removeAccents(s: string): string;
+    /**
+     * Converts a string to a URL-friendly slug.
+     * Removes accents, converts to lowercase, trims, replaces non-alphanumeric characters with hyphens,
+     * and consolidates multiple hyphens.
+     * @param s The input string.
+     * @returns The slugified string.
+     * @example
+     * StringUtils.slugify("Hello World! This is a test."); // Returns "hello-world-this-is-a-test"
+     * StringUtils.slugify("Crème brûlée"); // Returns "creme-brulee"
+     */
+    static slugify(s: string): string;
+    /**
+     * Capitalizes only the first letter of the string and converts the rest to lowercase.
+     * Useful for UI elements like headers and labels where proper sentence casing is required.
+     * @param s The input string.
+     * @returns The string in sentence case.
+     * @example
+     * StringUtils.toSentenceCase("hello WORLD"); // Returns "Hello world"
+     * StringUtils.toSentenceCase("a quick BROWN fox"); // Returns "A quick brown fox"
+     */
+    static toSentenceCase(s: string): string;
+    /**
+     * Capitalizes every word in a string, handling camelCase and special characters gracefully.
+     * Ensures consistent capitalization for UI components like card titles, buttons, or navigation items.
+     * @param s The input string.
+     * @returns The string in title case.
+     * @example
+     * StringUtils.toTitleCase("hello world");       // Returns "Hello World"
+     * StringUtils.toTitleCase("some_variable_name"); // Returns "Some Variable Name"
+     * StringUtils.toTitleCase("yetAnotherString");  // Returns "Yet Another String"
+     * StringUtils.toTitleCase("the quick brown fox"); // Returns "The Quick Brown Fox"
+     */
+    static toTitleCase(s: string): string;
+    /**
+     * Handles basic pluralization logic for displaying counts, e.g., "1 item" vs "2 items".
+     * @param count The number of items.
+     * @param singular The singular form of the word (e.g., "item", "person").
+     * @param plural Optional. The plural form of the word. If not provided, it defaults to appending 's'.
+     * @returns The appropriate singular or plural form of the word based on the count.
+     * @example
+     * StringUtils.pluralize(1, "item");    // Returns "item"
+     * StringUtils.pluralize(2, "item");    // Returns "items"
+     * StringUtils.pluralize(0, "item");    // Returns "items"
+     * StringUtils.pluralize(1, "sheep", "sheep"); // Returns "sheep"
+     * StringUtils.pluralize(2, "sheep", "sheep"); // Returns "sheep"
+     */
+    static pluralize(count: number, singular: string, plural?: string): string;
+    /**
+     * Prevents Cross-Site Scripting (XSS) by escaping HTML special characters in a string.
+     * Converts characters like '<', '>', '&', '"', "'" into their corresponding HTML entities.
+     * Essential for safely rendering user-generated content or dynamic text directly into the DOM.
+     * @param s The input string.
+     * @returns The HTML-escaped string.
+     * @example
+     * StringUtils.escapeHtml(`"<script>alert('xss')</script>"`); // Returns "&quot;&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;&quot;`
+     */
+    static escapeHtml(s: string): string;
+    /**
+     * Formats a number as currency for localized display, using `Intl.NumberFormat`.
+     * @param amount The number to format.
+     * @param locale Optional. The locale string (e.g., "en-US", "de-DE"). Defaults to "en-US".
+     * @param currency Optional. The currency code (e.g., "USD", "EUR"). Defaults to "USD".
+     * @returns The formatted currency string.
+     * @example
+     * StringUtils.formatCurrency(1234.50, "en-US", "USD"); // Returns "$1,234.50"
+     * StringUtils.formatCurrency(1234.50, "de-DE", "EUR"); // Returns "1.234,50 €"
+     * StringUtils.formatCurrency(5678, "ja-JP", "JPY");   // Returns "￥5,678"
+     */
+    static formatCurrency(amount: number, locale?: string, currency?: string): string;
+}
+
+export { StringUtils };

package/index.js

@@ -0,0 +1 @@
+"use strict";exports.StringUtils=class t{static uppercase(t){return t.toUpperCase()}static lowercase(t){return t.toLowerCase()}static capitalize(e,r){return e?r?e.split(r).map((e=>t.capitalize(e))).join(r):e.charAt(0).toUpperCase()+e.slice(1).toLowerCase():""}static hash(t,e=6){let r=0;for(let e=0;e<t.length;e++)r=(r<<5)-r+t.charCodeAt(e);r|=0;return((r>>>0)%Math.pow(36,e)).toString(36).padStart(e,"0")}static isEmpty(t){return null==t||0===t.length}static isWhitespace(e){return t.isEmpty(e)||0===e.trim().length}static trim(t){return t.trim()}static truncate(t,e,r="..."){return t.length<=e?t:t.substring(0,e-r.length)+r}static startsWith(t,e){return t.startsWith(e)}static endsWith(t,e){return t.endsWith(e)}static contains(t,e){return t.includes(e)}static isNumeric(t){return/^[0-9]+$/.test(t)}static isAlpha(t){return/^[a-zA-Z]+$/.test(t)}static camelCase(t){return t?t.replace(/[^a-zA-Z0-9]+(.)?/g,((t,e)=>e?e.toUpperCase():"")).replace(/^./,(t=>t.toLowerCase())):""}static kebabCase(t){return t?t.replace(/([a-z0-9]|(?=[A-Z]))([A-Z])/g,"$1-$2").toLowerCase().replace(/[^a-zA-Z0-9-]+/g,"-").replace(/^-+|-+$/g,""):""}static snakeCase(t){return t?t.replace(/([a-z0-9]|(?=[A-Z]))([A-Z])/g,"$1_$2").toLowerCase().replace(/[^a-zA-Z0-9_]+/g,"_").replace(/^_|_$/g,""):""}static pascalCase(t){return t?t.replace(/[^a-zA-Z0-9]+(.)?/g,((t,e)=>e?e.toUpperCase():"")).replace(/^./,(t=>t.toUpperCase())):""}static reverse(t){return t.split("").reverse().join("")}static replaceAll(t,e,r){return t.split(e).join(r)}static removeAccents(t){return t.normalize("NFD").replace(/[\u0300-\u036f]/g,"")}static slugify(e){return e?t.removeAccents(e).toLowerCase().trim().replace(/[^a-z0-9\s-]/g,"").replace(/\s+/g,"-").replace(/-+/g,"-"):""}static toSentenceCase(t){return t?t.charAt(0).toUpperCase()+t.slice(1).toLowerCase():""}static toTitleCase(e){return e?e.replace(/([a-z])([A-Z])/g,"$1 $2").replace(/[^a-zA-Z0-9\s]/g," ").split(/\s+/).map((e=>t.capitalize(e))).join(" "):""}static pluralize(t,e,r){return 1===t?e:void 0!==r?r:`${e}s`}static escapeHtml(t){if(!t)return"";const e={"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;"};return t.replace(/[&<>"']/g,(t=>e[t]))}static formatCurrency(t,e="en-US",r="USD"){return new Intl.NumberFormat(e,{style:"currency",currency:r}).format(t)}};

package/index.mjs

@@ -0,0 +1 @@
+var t=class t{static uppercase(t){return t.toUpperCase()}static lowercase(t){return t.toLowerCase()}static capitalize(e,r){return e?r?e.split(r).map((e=>t.capitalize(e))).join(r):e.charAt(0).toUpperCase()+e.slice(1).toLowerCase():""}static hash(t,e=6){let r=0;for(let e=0;e<t.length;e++)r=(r<<5)-r+t.charCodeAt(e);r|=0;return((r>>>0)%Math.pow(36,e)).toString(36).padStart(e,"0")}static isEmpty(t){return null==t||0===t.length}static isWhitespace(e){return t.isEmpty(e)||0===e.trim().length}static trim(t){return t.trim()}static truncate(t,e,r="..."){return t.length<=e?t:t.substring(0,e-r.length)+r}static startsWith(t,e){return t.startsWith(e)}static endsWith(t,e){return t.endsWith(e)}static contains(t,e){return t.includes(e)}static isNumeric(t){return/^[0-9]+$/.test(t)}static isAlpha(t){return/^[a-zA-Z]+$/.test(t)}static camelCase(t){return t?t.replace(/[^a-zA-Z0-9]+(.)?/g,((t,e)=>e?e.toUpperCase():"")).replace(/^./,(t=>t.toLowerCase())):""}static kebabCase(t){return t?t.replace(/([a-z0-9]|(?=[A-Z]))([A-Z])/g,"$1-$2").toLowerCase().replace(/[^a-zA-Z0-9-]+/g,"-").replace(/^-+|-+$/g,""):""}static snakeCase(t){return t?t.replace(/([a-z0-9]|(?=[A-Z]))([A-Z])/g,"$1_$2").toLowerCase().replace(/[^a-zA-Z0-9_]+/g,"_").replace(/^_|_$/g,""):""}static pascalCase(t){return t?t.replace(/[^a-zA-Z0-9]+(.)?/g,((t,e)=>e?e.toUpperCase():"")).replace(/^./,(t=>t.toUpperCase())):""}static reverse(t){return t.split("").reverse().join("")}static replaceAll(t,e,r){return t.split(e).join(r)}static removeAccents(t){return t.normalize("NFD").replace(/[\u0300-\u036f]/g,"")}static slugify(e){return e?t.removeAccents(e).toLowerCase().trim().replace(/[^a-z0-9\s-]/g,"").replace(/\s+/g,"-").replace(/-+/g,"-"):""}static toSentenceCase(t){return t?t.charAt(0).toUpperCase()+t.slice(1).toLowerCase():""}static toTitleCase(e){return e?e.replace(/([a-z])([A-Z])/g,"$1 $2").replace(/[^a-zA-Z0-9\s]/g," ").split(/\s+/).map((e=>t.capitalize(e))).join(" "):""}static pluralize(t,e,r){return 1===t?e:void 0!==r?r:`${e}s`}static escapeHtml(t){if(!t)return"";const e={"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;"};return t.replace(/[&<>"']/g,(t=>e[t]))}static formatCurrency(t,e="en-US",r="USD"){return new Intl.NumberFormat(e,{style:"currency",currency:r}).format(t)}};export{t as StringUtils};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@asaidimu/utils-strings",
+  "version": "1.0.0",
+  "description": "A collection of strings utilities.",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "keywords": [
+    "typescript",
+    "utility"
+  ],
+  "author": "Saidimu <47994458+asaidimu@users.noreply.github.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asaidimu/erp-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/asaidimu/erp-utils/issues"
+  },
+  "homepage": "https://github.com/asaidimu/erp-utils/tree/main/src/strings#readme",
+  "files": [
+    "./*"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.mjs"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      }
+    }
+  },
+  "dependencies": {},
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "tag": "latest",
+    "access": "public"
+  },
+  "release": {
+    "plugins": [
+      [
+        "@semantic-release/npm",
+        {
+          "pkgRoot": "./dist"
+        }
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md",
+            "package.json"
+          ],
+          "message": "chore(release): Release @asaidimu/utils-strings v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  }
+}