@akadenia/helpers 1.9.1 → 1.9.2

package/README.MD

@@ -1,28 +1,17 @@
 <div align="center">
   <img src="https://cdn.akadenia.com/images/akadenia-webp/logo/horizontal-logo.svg" alt="Akadenia" width="200" />
 
-  ## @akadenia/helpers
+  <h2><code>@akadenia/helpers</code></h2>
 
   <img src="https://cdn.akadenia.com/images/badges/npm-version-helpers.svg" alt="npm version" />
   <img src="https://cdn.akadenia.com/images/badges/license-mit.svg" alt="License: MIT" />
   <img src="https://cdn.akadenia.com/images/badges/typescript.svg" alt="TypeScript" />
 
-  A comprehensive collection of utility functions for common JavaScript/TypeScript operations including date manipulation, text processing, object handling, map calculations, and more.
+  A zero-dependency TypeScript utility library covering the common ground every project needs — dates, strings, objects, geography, files, and more. Modular by design, so you only import what you use.
 
-  [Documentation](https://akadenia.com/packages/akadenia-helpers) • [GitHub](https://github.com/akadenia/AkadeniaHelpers) • [Issues](https://github.com/akadenia/AkadeniaHelpers/issues)
+  [Documentation](https://akadenia.com/packages/akadenia-helpers) · [GitHub](https://github.com/akadenia/AkadeniaHelpers) · [Issues](https://github.com/akadenia/AkadeniaHelpers/issues)
 </div>
 
-## Features
-
-- **Date Helpers**: Comprehensive date manipulation and formatting utilities
-- **Text Helpers**: String processing, validation, and transformation functions
-- **Object Helpers**: Object manipulation, filtering, and utility functions
-- **Map Helpers**: Geographical calculations and coordinate operations
-- **Generic Helpers**: General utility functions for common operations
-- **File Helpers**: File validation and processing utilities
-- **TypeScript Support**: Full type definitions included
-- **Zero Dependencies**: Lightweight with no external dependencies
-
 ## Installation
 
 ```bash
@@ -37,8 +26,6 @@ import { DateHelpers, TextHelpers, ObjectHelpers, MapHelpers, GenericHelpers, Fi
 
 ## Table of Contents
 
-- [Installation](#installation)
-- [Usage](#usage)
 - [DateHelpers](#datehelpers)
 - [TextHelpers](#texthelpers)
 - [ObjectHelpers](#objecthelpers)
@@ -46,913 +33,715 @@ import { DateHelpers, TextHelpers, ObjectHelpers, MapHelpers, GenericHelpers, Fi
 - [GenericHelpers](#generichelpers)
 - [FileHelpers](#filehelpers)
 - [Contributing](#contributing)
-  - [License](#license)
 
-## DateHelpers
+---
 
-Utility functions for date and time operations.
+## DateHelpers
 
 ### `getReadableDateTime(datetime?)`
 
 Returns the date in `yyyy-mm-dd hh:mm:ss` format.
 
 **Parameters:**
-- `datetime` (optional): `Date` - The date to convert. Defaults to current date.
+- `datetime` (optional): `Date` — The date to convert. Defaults to current date.
 
 **Example:**
 ```typescript
 import { DateHelpers } from '@akadenia/helpers'
 
-// Using current date
-const now = DateHelpers.getReadableDateTime()
-console.log(now) // "2024-01-15 14:30:25"
+DateHelpers.getReadableDateTime()
+// "2026-02-27 15:30:25"
 
-// Using specific date
-const specificDate = DateHelpers.getReadableDateTime(new Date('2024-01-15T10:30:00Z'))
-console.log(specificDate) // "2024-01-15 10:30:00"
+DateHelpers.getReadableDateTime(new Date('2024-01-15T10:30:00Z'))
+// "2024-01-15 10:30:00"
 ```
 
+---
+
 ### `getReadableDate(datetime?)`
 
 Returns the date in `yyyy-mm-dd` format.
 
 **Parameters:**
-- `datetime` (optional): `Date` - The date to convert. Defaults to current date.
+- `datetime` (optional): `Date` — The date to convert. Defaults to current date.
 
 **Example:**
 ```typescript
-const date = DateHelpers.getReadableDate()
-console.log(date) // "2024-01-15"
+DateHelpers.getReadableDate()
+// "2026-02-27"
 
-const specificDate = DateHelpers.getReadableDate(new Date('2024-01-15T10:30:00Z'))
-console.log(specificDate) // "2024-01-15"
+DateHelpers.getReadableDate(new Date('2024-01-15T10:30:00Z'))
+// "2024-01-15"
 ```
 
+---
+
 ### `getDateString(date)`
 
-Returns a string representing the date in the user's local timezone.
+Returns a locale-formatted date string.
 
 **Parameters:**
-- `date`: `string | Date` - The date to convert.
+- `date`: `string | Date` — The date to convert.
 
 **Example:**
 ```typescript
-const dateString = DateHelpers.getDateString('2024-01-15')
-console.log(dateString) // "1/15/2024" (format depends on locale)
-
-const dateString2 = DateHelpers.getDateString(new Date('2024-01-15T10:30:00Z'))
-console.log(dateString2) // "1/15/2024"
+DateHelpers.getDateString('2024-01-15')
+// "1/15/2024" (locale-dependent)
 ```
 
+---
+
 ### `formatDateTime(date, options, localTimezone?)`
 
-Returns a formatted date string using Intl.DateTimeFormat options.
+Returns a formatted date string using `Intl.DateTimeFormat` options.
 
 **Parameters:**
-- `date`: `string | Date` - The date to format.
-- `options`: `Intl.DateTimeFormatOptions` - Formatting options.
-- `localTimezone` (optional): `string | Intl.Locale` - Locale for formatting. Defaults to "en-US".
+- `date`: `string | Date` — The date to format.
+- `options`: `Intl.DateTimeFormatOptions` — Formatting options.
+- `localTimezone` (optional): `string | Intl.Locale` — Locale. Defaults to `"en-US"`.
 
 **Example:**
 ```typescript
-const formatted = DateHelpers.formatDateTime(
+DateHelpers.formatDateTime(
   new Date('2024-01-15T10:30:00Z'),
-  {
-    year: 'numeric',
-    month: 'long',
-    day: 'numeric',
-    hour: '2-digit',
-    minute: '2-digit'
-  },
+  { year: 'numeric', month: 'long', day: 'numeric', hour: '2-digit', minute: '2-digit' },
   'en-US'
 )
-console.log(formatted) // "January 15, 2024 at 10:30 AM"
+// "January 15, 2024 at 10:30 AM"
 ```
 
+---
+
 ### `parseDate(date)`
 
-Returns a Date object from a string or Date input. Throws an error for invalid dates.
+Parses a string or Date into a `Date` object. Throws on invalid input.
 
 **Parameters:**
-- `date`: `string | Date` - The date to parse.
+- `date`: `string | Date` — The date to parse.
 
 **Example:**
 ```typescript
-const parsedDate = DateHelpers.parseDate('2024-01-15')
-console.log(parsedDate) // Date object for 2024-01-15
+DateHelpers.parseDate('2024-01-15')
+// Date object
 
-const parsedDate2 = DateHelpers.parseDate('invalid-date')
-// Throws: Error: Cannot parse date: "invalid-date"
+DateHelpers.parseDate('invalid-date')
+// throws Error: Cannot parse date: "invalid-date"
 ```
 
+---
+
 ### `getShortOrdinalDate(date, appendTime?)`
 
-Returns a string representing the date in short ordinal format.
+Returns a date in short ordinal format, e.g. `"Feb 27th 2026"`.
 
 **Parameters:**
-- `date`: `string | Date` - The date to format.
-- `appendTime` (optional): `boolean` - Whether to include time. Defaults to false.
+- `date`: `string | Date` — The date to format.
+- `appendTime` (optional): `boolean` — Whether to include time. Defaults to `false`.
 
 **Example:**
 ```typescript
-const ordinalDate = DateHelpers.getShortOrdinalDate('2024-01-15')
-console.log(ordinalDate) // "Jan 15th 2024"
+DateHelpers.getShortOrdinalDate('2024-01-15')
+// "Jan 15th 2024"
 
-const ordinalDateTime = DateHelpers.getShortOrdinalDate('2024-01-15T10:30:00Z', true)
-console.log(ordinalDateTime) // "Jan 15th 2024 10:30:00"
+DateHelpers.getShortOrdinalDate('2024-01-15T10:30:00Z', true)
+// "Jan 15th 2024 10:30:00"
 ```
 
-## MapHelpers
-
-Utility functions for geographical calculations and map operations.
+---
 
-### `getDistanceBetweenPoints(point1, point2)`
+## TextHelpers
 
-Calculates the distance between two geographical points using the Haversine formula.
+### `uuidv4()`
 
-**Parameters:**
-- `point1`: `number[] | undefined` - First point coordinates [longitude, latitude].
-- `point2`: `number[] | undefined` - Second point coordinates [longitude, latitude].
+Generates a random UUID v4 string.
 
 **Example:**
 ```typescript
-// Distance between New York and Los Angeles
-const nyc = [-74.006, 40.7128] // [lng, lat]
-const la = [-118.2437, 34.0522] // [lng, lat]
-
-const distance = MapHelpers.getDistanceBetweenPoints(nyc, la)
-console.log(distance) // 3944419.5 (meters, approximately 3944 km)
-
-// Returns null for invalid points
-const invalid = MapHelpers.getDistanceBetweenPoints(nyc, undefined)
-console.log(invalid) // null
+TextHelpers.uuidv4()
+// "f47ac10b-58cc-4372-a567-0e02b2c3d479"
 ```
 
-### `compareLocations(location1, location2, precision?)`
+---
 
-Compares two locations to see if they are the same within a specified precision.
+### `formatPosition(position)`
+
+Returns a position number with the appropriate ordinal suffix.
 
 **Parameters:**
-- `location1`: `number[] | undefined` - First location coordinates [longitude, latitude].
-- `location2`: `number[] | undefined` - Second location coordinates [longitude, latitude].
-- `precision` (optional): `number` - Decimal precision for comparison. Defaults to 6.
+- `position`: `number` — The position.
 
 **Example:**
 ```typescript
-const loc1 = [-74.006, 40.7128]
-const loc2 = [-74.006001, 40.712801] // Very close to loc1
-const loc3 = [-74.01, 40.72] // Further from loc1
-
-console.log(MapHelpers.compareLocations(loc1, loc2)) // true (within 6 decimal precision)
-console.log(MapHelpers.compareLocations(loc1, loc3)) // false
-console.log(MapHelpers.compareLocations(loc1, loc2, 3)) // true (within 3 decimal precision)
-
-// Throws error for undefined locations
-MapHelpers.compareLocations(loc1, undefined) // Error: location1 and location2 are required
+TextHelpers.formatPosition(1)  // "1st"
+TextHelpers.formatPosition(2)  // "2nd"
+TextHelpers.formatPosition(3)  // "3rd"
+TextHelpers.formatPosition(4)  // "4th"
+TextHelpers.formatPosition(21) // "21st"
 ```
 
-### `getBearingToCoordinate({startCoordinate, endCoordinate})`
+---
 
-Calculates the bearing (direction) from one coordinate to another in degrees.
+### `truncateText(text, characterLimit)`
+
+Truncates text to the character limit, appending `"..."`.
 
 **Parameters:**
-- `startCoordinate`: `number[] | undefined` - Starting point [longitude, latitude].
-- `endCoordinate`: `number[] | undefined` - Ending point [longitude, latitude].
+- `text`: `string` — Text to truncate.
+- `characterLimit`: `number` — Maximum number of characters.
 
 **Example:**
 ```typescript
-const start = [-74.006, 40.7128] // New York
-const end = [-118.2437, 34.0522] // Los Angeles
-
-const bearing = MapHelpers.getBearingToCoordinate({ startCoordinate: start, endCoordinate: end })
-console.log(bearing) // 277.5 (degrees, approximately west)
-
-// Throws error for undefined coordinates
-MapHelpers.getBearingToCoordinate({ startCoordinate: start, endCoordinate: undefined })
-// Error: startCoordinate and endCoordinate are required
+TextHelpers.truncateText("Hello World", 5)  // "He..."
+TextHelpers.truncateText("Hello World", 20) // "Hello World"
 ```
 
-## TextHelpers
+---
 
-Utility functions for text manipulation and processing.
+### `fileNameFromPath(path)`
 
-### `uuidv4()`
+Extracts the filename from a file path.
 
-Returns a randomly generated UUID v4 string.
+**Parameters:**
+- `path`: `string` — The file path.
 
 **Example:**
 ```typescript
-const id = TextHelpers.uuidv4()
-console.log(id) // "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+TextHelpers.fileNameFromPath('/uploads/documents/file.pdf') // "file.pdf"
 ```
 
-### `formatPosition(position)`
+---
 
-Returns a string position with appropriate suffix (st, nd, rd, th).
+### `replaceSpacesWithUnderscore(s?)`
 
-**Parameters:**
-- `position`: `number` - The position number.
+Replaces spaces with underscores.
 
 **Example:**
 ```typescript
-console.log(TextHelpers.formatPosition(1))  // "1st"
-console.log(TextHelpers.formatPosition(2))  // "2nd"
-console.log(TextHelpers.formatPosition(3))  // "3rd"
-console.log(TextHelpers.formatPosition(4))  // "4th"
-console.log(TextHelpers.formatPosition(21)) // "21st"
+TextHelpers.replaceSpacesWithUnderscore("hello world") // "hello_world"
 ```
 
-### `truncateText(text, characterLimit)`
+---
 
-Returns truncated text with ellipsis if it exceeds the character limit.
+### `replaceUnderscoreWithSpaces(s?)`
 
-**Parameters:**
-- `text`: `string` - The text to truncate.
-- `characterLimit`: `number` - Maximum number of characters.
+Replaces underscores with spaces.
 
 **Example:**
 ```typescript
-const short = TextHelpers.truncateText("Hello World", 5)
-console.log(short) // "He..."
-
-const long = TextHelpers.truncateText("Hello World", 20)
-console.log(long) // "Hello World"
+TextHelpers.replaceUnderscoreWithSpaces("hello_world") // "hello world"
 ```
 
-### `fileNameFromPath(path)`
+---
 
-Extracts the filename from a file path.
+### `pluralizeOnCondition(word, condition)`
+
+Pluralizes a word when the condition is `true`. Handles common English rules (`-y → -ies`, `-s/-sh/-ch/-x → -es`).
 
 **Parameters:**
-- `path`: `string` - The file path.
+- `word`: `string` — The word to pluralize.
+- `condition`: `boolean` — Whether to pluralize.
 
 **Example:**
 ```typescript
-const filename = TextHelpers.fileNameFromPath('/path/to/file.txt')
-console.log(filename) // "file.txt"
-
-const filename2 = TextHelpers.fileNameFromPath('C:\\Users\\file.pdf')
-console.log(filename2) // "file.pdf"
+TextHelpers.pluralizeOnCondition("item", true)    // "items"
+TextHelpers.pluralizeOnCondition("address", true) // "addresses"
+TextHelpers.pluralizeOnCondition("library", true) // "libraries"
+TextHelpers.pluralizeOnCondition("item", false)   // "item"
 ```
 
-### `replaceSpacesWithUnderscore(s?)`
+---
 
-Replaces spaces with underscores in a string.
+### `convertSnakeToCamelCase(data)`
 
-**Parameters:**
-- `s` (optional): `string` - The string to process.
+Converts `snake_case` to `camelCase` for strings, objects, or arrays of objects (deep).
 
 **Example:**
 ```typescript
-const result = TextHelpers.replaceSpacesWithUnderscore("hello world test")
-console.log(result) // "hello_world_test"
+TextHelpers.convertSnakeToCamelCase("hello_world")
+// "helloWorld"
 
-const result2 = TextHelpers.replaceSpacesWithUnderscore()
-console.log(result2) // ""
+TextHelpers.convertSnakeToCamelCase({ first_name: "John", user_info: { phone_number: "123" } })
+// { firstName: "John", userInfo: { phoneNumber: "123" } }
 ```
 
-### `replaceUnderscoreWithSpaces(s?)`
+---
 
-Replaces underscores with spaces in a string.
+### `convertCamelToSnakeCase(data)`
 
-**Parameters:**
-- `s` (optional): `string` - The string to process.
+Converts `camelCase` to `snake_case` for strings, objects, or arrays of objects (deep).
 
 **Example:**
 ```typescript
-const result = TextHelpers.replaceUnderscoreWithSpaces("hello_world_test")
-console.log(result) // "hello world test"
+TextHelpers.convertCamelToSnakeCase("helloWorld")
+// "hello_world"
+
+TextHelpers.convertCamelToSnakeCase({ firstName: "John", userInfo: { phoneNumber: "123" } })
+// { first_name: "John", user_info: { phone_number: "123" } }
 ```
 
-### `pluralizeOnCondition(word, condition)`
+---
 
-Returns pluralized version of the word if condition is true.
+### `convertCamelToKebabCase(word)`
 
-**Parameters:**
-- `word`: `string` - The word to pluralize.
-- `condition`: `boolean` - Whether to pluralize.
+Converts `camelCase` to `kebab-case`.
 
 **Example:**
 ```typescript
-const plural = TextHelpers.pluralizeOnCondition("item", true)
-console.log(plural) // "items"
-
-const plural2 = TextHelpers.pluralizeOnCondition("address", true)
-console.log(plural2) // "addresses"
-
-const plural3 = TextHelpers.pluralizeOnCondition("library", true)
-console.log(plural3) // "libraries"
-
-const singular = TextHelpers.pluralizeOnCondition("item", false)
-console.log(singular) // "item"
+TextHelpers.convertCamelToKebabCase("helloWorld")     // "hello-world"
+TextHelpers.convertCamelToKebabCase("XMLHttpRequest") // "xml-http-request"
 ```
 
-### `convertSnakeToCamelCase(data)`
+---
 
-Converts snake_case to camelCase for strings, objects, or arrays of objects.
+### `convertKebabToCamelCase(word)`
 
-**Parameters:**
-- `data`: `string | Object | Array<Object>` - The data to convert.
+Converts `kebab-case` to `CamelCase`.
 
 **Example:**
 ```typescript
-// String conversion
-const camelString = TextHelpers.convertSnakeToCamelCase("hello_world")
-console.log(camelString) // "helloWorld"
-
-// Object conversion
-const camelObject = TextHelpers.convertSnakeToCamelCase({
-  first_name: "John",
-  last_name: "Doe",
-  user_info: {
-    phone_number: "123-456-7890"
-  }
-})
-console.log(camelObject)
-// {
-//   firstName: "John",
-//   lastName: "Doe",
-//   userInfo: {
-//     phoneNumber: "123-456-7890"
-//   }
-// }
+TextHelpers.convertKebabToCamelCase("hello-world")     // "HelloWorld"
+TextHelpers.convertKebabToCamelCase("xml-http-request") // "XmlHttpRequest"
 ```
 
-### `convertCamelToSnakeCase(data)`
+---
 
-Converts camelCase to snake_case for strings, objects, or arrays of objects.
+### `convertCamelCaseToReadableText(name)`
 
-**Parameters:**
-- `data`: `string | Object | Array<Object>` - The data to convert.
+Converts `camelCase` to a space-separated readable string.
 
 **Example:**
 ```typescript
-// String conversion
-const snakeString = TextHelpers.convertCamelToSnakeCase("helloWorld")
-console.log(snakeString) // "hello_world"
-
-// Object conversion
-const snakeObject = TextHelpers.convertCamelToSnakeCase({
-  firstName: "John",
-  lastName: "Doe",
-  userInfo: {
-    phoneNumber: "123-456-7890"
-  }
-})
-console.log(snakeObject)
-// {
-//   first_name: "John",
-//   last_name: "Doe",
-//   user_info: {
-//     phone_number: "123-456-7890"
-//   }
-// }
+TextHelpers.convertCamelCaseToReadableText("helloWorld")     // "Hello World"
+TextHelpers.convertCamelCaseToReadableText("XMLHttpRequest") // "XML Http Request"
 ```
 
-### `convertCamelToKebabCase(word)`
+---
 
-Converts camelCase to kebab-case.
+### `generateAcronym(term)`
 
-**Parameters:**
-- `word`: `string` - The word to convert.
+Generates an acronym from the first letter of each word.
 
 **Example:**
 ```typescript
-const kebab = TextHelpers.convertCamelToKebabCase("helloWorld")
-console.log(kebab) // "hello-world"
-
-const kebab2 = TextHelpers.convertCamelToKebabCase("XMLHttpRequest")
-console.log(kebab2) // "xml-http-request"
+TextHelpers.generateAcronym("Hyper Text Markup Language") // "HTML"
+TextHelpers.generateAcronym("Application Programming Interface") // "API"
 ```
 
-### `convertKebabToCamelCase(word)`
+---
 
-Converts kebab-case to camelCase.
+### `isAcronym(word)`
 
-**Parameters:**
-- `word`: `string` - The word to convert.
+Returns `true` if the word is all uppercase (i.e. an acronym).
 
 **Example:**
 ```typescript
-const camel = TextHelpers.convertKebabToCamelCase("hello-world")
-console.log(camel) // "HelloWorld"
-
-const camel2 = TextHelpers.convertKebabToCamelCase("xml-http-request")
-console.log(camel2) // "XmlHttpRequest"
+TextHelpers.isAcronym("HTML")       // true
+TextHelpers.isAcronym("JavaScript") // false
 ```
 
-### `convertCamelCaseToReadableText(name)`
-
-Converts camelCase to readable text format with proper capitalization.
+---
 
-**Parameters:**
+### `acronymToKebabCase(word)`
 
-- `name`: `string` - The camelCase string to convert.
+Converts an acronym to kebab-case. Throws if input is not an acronym.
 
 **Example:**
-
 ```typescript
-const readable = TextHelpers.convertCamelCaseToReadableText("helloWorld")
-console.log(readable) // "Hello World"
-
-const readable2 = TextHelpers.convertCamelCaseToReadableText("XMLHttpRequest")
-console.log(readable2) // "XML Http Request"
-
-const readable3 = TextHelpers.convertCamelCaseToReadableText("userName")
-console.log(readable3) // "User Name"
+TextHelpers.acronymToKebabCase("HTML") // "h-t-m-l"
+TextHelpers.acronymToKebabCase("API")  // "a-p-i"
+TextHelpers.acronymToKebabCase("html") // throws Error
 ```
 
-### `generateAcronym(term)`
+---
 
-Generates an acronym from a term.
+### `handleNullDisplay(value, defaultValue?)`
+
+Returns the value, or a default string if `null` or `undefined`.
 
 **Parameters:**
-- `term`: `string` - The term to convert to acronym.
+- `value`: `string | null | undefined`
+- `defaultValue` (optional): `string` — Defaults to `"N/A"`.
 
 **Example:**
 ```typescript
-const acronym = TextHelpers.generateAcronym("Hyper Text Markup Language")
-console.log(acronym) // "HTML"
-
-const acronym2 = TextHelpers.generateAcronym("JavaScript Object Notation")
-console.log(acronym2) // "JSON"
+TextHelpers.handleNullDisplay("Hello")       // "Hello"
+TextHelpers.handleNullDisplay(null)          // "N/A"
+TextHelpers.handleNullDisplay(null, "—")     // "—"
 ```
 
-### `isAcronym(word)`
+---
 
-Validates if a word is an acronym (all uppercase).
+### `capitalizeText(text?)`
 
-**Parameters:**
-- `word`: `string` - The word to validate.
+Capitalizes the first letter, lowercases the rest.
 
 **Example:**
 ```typescript
-console.log(TextHelpers.isAcronym("HTML")) // true
-console.log(TextHelpers.isAcronym("html")) // false
-console.log(TextHelpers.isAcronym("JavaScript")) // false
+TextHelpers.capitalizeText("hello world") // "Hello world"
+TextHelpers.capitalizeText("HELLO")       // "Hello"
+TextHelpers.capitalizeText()              // ""
 ```
 
-### `acronymToKebabCase(word)`
+---
 
-Converts an acronym to kebab-case.
+### `enforceCharacterLimit({ text, characterLimit, onCharacterLimit })`
 
-**Parameters:**
-- `word`: `string` - The acronym to convert.
+Truncates text to the limit and calls a callback when the limit is hit.
 
 **Example:**
 ```typescript
-const kebab = TextHelpers.acronymToKebabCase("HTML")
-console.log(kebab) // "h-t-m-l"
-
-const kebab2 = TextHelpers.acronymToKebabCase("API")
-console.log(kebab2) // "a-p-i"
-
-// Throws error if not an acronym
-TextHelpers.acronymToKebabCase("html") // Error: The text passed: html is not an acronym.
+TextHelpers.enforceCharacterLimit({
+  text: "This is a long text",
+  characterLimit: 10,
+  onCharacterLimit: () => console.log("Limit hit!"),
+})
+// "This is a" (and logs "Limit hit!")
 ```
 
-### `handleNullDisplay(value, defaultValue?)`
+---
 
-Returns the value or a default string if the value is null or undefined.
+### `isValidEmail(email)`
 
-**Parameters:**
-- `value`: `string | null | undefined` - The value to display.
-- `defaultValue` (optional): `string` - Default value. Defaults to "N/A".
+Validates an email address against RFC-compliant rules.
 
 **Example:**
 ```typescript
-console.log(TextHelpers.handleNullDisplay("Hello")) // "Hello"
-console.log(TextHelpers.handleNullDisplay(null)) // "N/A"
-console.log(TextHelpers.handleNullDisplay(undefined)) // "N/A"
-console.log(TextHelpers.handleNullDisplay(null, "No data")) // "No data"
+TextHelpers.isValidEmail("user@example.com")    // true
+TextHelpers.isValidEmail("user@domain.co.uk")   // true
+TextHelpers.isValidEmail("invalid-email")        // false
+TextHelpers.isValidEmail("")                     // false
 ```
 
-### `capitalizeText(text?)`
+---
 
-Capitalizes the first letter of a text.
+### `generateIDFromWord(text)`
 
-**Parameters:**
-- `text` (optional): `string` - The text to capitalize.
+Converts a phrase to a lowercase hyphenated ID.
 
 **Example:**
 ```typescript
-console.log(TextHelpers.capitalizeText("hello world")) // "Hello world"
-console.log(TextHelpers.capitalizeText("HELLO")) // "Hello"
-console.log(TextHelpers.capitalizeText()) // ""
+TextHelpers.generateIDFromWord("My Awesome Feature") // "my-awesome-feature"
 ```
 
-### `enforceCharacterLimit({text, characterLimit, onCharacterLimit})`
+---
 
-Enforces a character limit and calls a callback when exceeded.
+### `generateWordFromId(id, customList?)`
 
-**Parameters:**
-- `text`: `string` - The text to limit.
-- `characterLimit`: `number` - Maximum characters allowed.
-- `onCharacterLimit`: `() => void` - Callback when limit is exceeded.
+Converts a hyphenated ID back to a readable title. Supports a custom lookup map.
 
 **Example:**
 ```typescript
-const result = TextHelpers.enforceCharacterLimit({
-  text: "This is a very long text that exceeds the limit",
-  characterLimit: 10,
-  onCharacterLimit: () => console.log("Character limit exceeded!")
-})
-console.log(result) // "This is a" (truncated)
-// Console: "Character limit exceeded!"
+TextHelpers.generateWordFromId("hello-world-test")
+// "Hello World Test"
+
+TextHelpers.generateWordFromId("api", { api: "Application Programming Interface" })
+// "Application Programming Interface"
 ```
 
-### `isValidEmail(email)`
+---
 
-Validates if an email address is properly formatted.
+### `generateSlugFromWordsWithID(id, ...words)`
 
-**Parameters:**
-- `email`: `string` - The email to validate.
+Generates a URL-safe slug combining words and an ID.
 
 **Example:**
 ```typescript
-console.log(TextHelpers.isValidEmail("user@example.com")) // true
-console.log(TextHelpers.isValidEmail("invalid-email")) // false
-console.log(TextHelpers.isValidEmail("user@domain.co.uk")) // true
-console.log(TextHelpers.isValidEmail("")) // false
+TextHelpers.generateSlugFromWordsWithID("123", "Blog Post", "Tech")
+// "blog-post-tech-123"
 ```
 
-### `generateIDFromWord(text)`
+---
 
-Generates an ID from a word by converting to lowercase and replacing spaces with hyphens.
+### `extractIDfromSlug(slug)`
 
-**Parameters:**
-- `text`: `string` - The text to convert to ID.
+Extracts the last segment of a hyphenated slug (the ID).
 
 **Example:**
 ```typescript
-const id = TextHelpers.generateIDFromWord("Hello World Test")
-console.log(id) // "hello-world-test"
-
-const id2 = TextHelpers.generateIDFromWord("My Awesome Feature")
-console.log(id2) // "my-awesome-feature"
+TextHelpers.extractIDfromSlug("my-blog-post-42") // "42"
+TextHelpers.extractIDfromSlug("")               // throws Error
 ```
 
-### `generateWordFromId(id, customList?)`
+---
 
-Converts an ID back to a readable word format.
+### `abbreviateNumber(number)`
 
-**Parameters:**
-- `id`: `string` - The ID to convert.
-- `customList` (optional): `Record<string, string>` - Custom mapping for specific IDs.
+Abbreviates large numbers with K / M / B suffixes.
 
 **Example:**
 ```typescript
-const word = TextHelpers.generateWordFromId("hello-world-test")
-console.log(word) // "Hello World Test"
-
-const customWord = TextHelpers.generateWordFromId("api", { "api": "Application Programming Interface" })
-console.log(customWord) // "Application Programming Interface"
+TextHelpers.abbreviateNumber(500)         // "500"
+TextHelpers.abbreviateNumber(1500)        // "1.5K"
+TextHelpers.abbreviateNumber(1500000)     // "1.5M"
+TextHelpers.abbreviateNumber(1500000000)  // "1.5B"
+TextHelpers.abbreviateNumber(null)        // null
 ```
 
-### `generateSlugFromWordsWithID(id, ...words)`
+---
+
+## ObjectHelpers
 
-Generates a URL-safe slug from an ID and additional words.
+### `isPureObject(object)`
 
-**Parameters:**
-- `id`: `string` - The ID to include in the slug.
-- `...words`: `string[]` - Additional words to include.
+Returns `true` if the value is a plain object (not an array, Date, or function).
 
 **Example:**
 ```typescript
-const slug = TextHelpers.generateSlugFromWordsWithID("user", "profile", "settings")
-console.log(slug) // "profile-settings-user"
-
-const slug2 = TextHelpers.generateSlugFromWordsWithID("123", "hello world", "test")
-console.log(slug2) // "hello%20world-test-123"
+ObjectHelpers.isPureObject({})          // true
+ObjectHelpers.isPureObject([])          // false
+ObjectHelpers.isPureObject(new Date())  // false
+ObjectHelpers.isPureObject(() => {})    // false
 ```
 
-### `extractIDfromSlug(slug)`
+---
 
-Extracts the ID from a slug (last part after splitting by hyphens).
+### `parseCookie(str)`
 
-**Parameters:**
-- `slug`: `string` - The slug to extract ID from.
+Parses a `Cookie` header string into a key-value object.
 
 **Example:**
 ```typescript
-const id = TextHelpers.extractIDfromSlug("hello-world-test-123")
-console.log(id) // "123"
-
-const id2 = TextHelpers.extractIDfromSlug("user-profile-abc")
-console.log(id2) // "abc"
-
-// Throws error for empty slug
-TextHelpers.extractIDfromSlug("") // Error: slug cannot be empty, null or undefined string
+ObjectHelpers.parseCookie("name=John; age=30; city=New York")
+// { name: "John", age: "30", city: "New York" }
 ```
 
-### `abbreviateNumber(number)`
+---
 
-Abbreviates large numbers with K, M, B suffixes.
+### `filterObjectsByProperty(array, propertyName, propertyValue)`
 
-**Parameters:**
-- `number`: `number | undefined | null` - The number to abbreviate.
+Filters an array of objects by a specific property value.
 
 **Example:**
 ```typescript
-console.log(TextHelpers.abbreviateNumber(500)) // "500"
-console.log(TextHelpers.abbreviateNumber(1500)) // "1.5K"
-console.log(TextHelpers.abbreviateNumber(1500000)) // "1.5M"
-console.log(TextHelpers.abbreviateNumber(1500000000)) // "1.5B"
-console.log(TextHelpers.abbreviateNumber(null)) // null
-```
+const users = [
+  { id: 1, name: "John", role: "admin" },
+  { id: 2, name: "Jane", role: "user" },
+  { id: 3, name: "Bob",  role: "admin" },
+]
 
-## ObjectHelpers
+ObjectHelpers.filterObjectsByProperty(users, "role", "admin")
+// [{ id: 1, ... }, { id: 3, ... }]
+```
 
-Utility functions for object manipulation and processing.
+---
 
-### `isPureObject(object)`
+### `containsSubObject(mainObject, subObject)`
 
-Checks if an object is a pure object (not array, date, or function).
-
-**Parameters:**
-- `object`: `any` - The object to check.
+Returns `true` if the main object contains all the key-value pairs of the sub-object.
 
 **Example:**
 ```typescript
-console.log(ObjectHelpers.isPureObject({})) // true
-console.log(ObjectHelpers.isPureObject([])) // false
-console.log(ObjectHelpers.isPureObject(new Date())) // false
-console.log(ObjectHelpers.isPureObject(() => {})) // false
-console.log(ObjectHelpers.isPureObject("string")) // false
+const user = { id: 1, name: "John", age: 30, city: "New York" }
+
+ObjectHelpers.containsSubObject(user, { name: "John", age: 30 }) // true
+ObjectHelpers.containsSubObject(user, { name: "Jane" })          // false
 ```
 
-### `parseCookie(str)`
+---
 
-Parses a cookie string into an object.
+### `findObjectBySubObject(array, subObject)`
 
-**Parameters:**
-- `str`: `string` - The cookie string to parse.
+Finds the first object in an array containing the specified sub-object. Returns `null` if not found.
 
 **Example:**
 ```typescript
-const cookies = ObjectHelpers.parseCookie("name=John; age=30; city=New York")
-console.log(cookies) // { name: "John", age: "30", city: "New York" }
+const users = [
+  { id: 1, name: "John", city: "New York" },
+  { id: 2, name: "Jane", city: "Boston" },
+]
+
+ObjectHelpers.findObjectBySubObject(users, { city: "Boston" })
+// { id: 2, name: "Jane", city: "Boston" }
 
-const cookies2 = ObjectHelpers.parseCookie("session=abc123; theme=dark")
-console.log(cookies2) // { session: "abc123", theme: "dark" }
+ObjectHelpers.findObjectBySubObject(users, { name: "Alice" })
+// null
 ```
 
-### `filterObjectsByProperty(array, propertyName, propertyValue)`
+---
 
-Filters an array of objects based on a specific property and value.
+### `filterObjectsBySubObject(array, subObject)`
 
-**Parameters:**
-- `array`: `T[]` - Array of objects to filter.
-- `propertyName`: `keyof T` - Name of the property to filter on.
-- `propertyValue`: `T[keyof T]` - Value to match.
+Filters an array of objects to those containing the specified sub-object.
 
 **Example:**
 ```typescript
 const users = [
   { id: 1, name: "John", age: 30 },
   { id: 2, name: "Jane", age: 25 },
-  { id: 3, name: "John", age: 35 }
+  { id: 3, name: "Bob",  age: 30 },
 ]
 
-const johns = ObjectHelpers.filterObjectsByProperty(users, "name", "John")
-console.log(johns) // [{ id: 1, name: "John", age: 30 }, { id: 3, name: "John", age: 35 }]
-
-const adults = ObjectHelpers.filterObjectsByProperty(users, "age", 30)
-console.log(adults) // [{ id: 1, name: "John", age: 30 }]
+ObjectHelpers.filterObjectsBySubObject(users, { age: 30 })
+// [{ id: 1, ... }, { id: 3, ... }]
 ```
 
-### `containsSubObject(mainObject, subObject)`
+---
 
-Checks if the main object contains all key-value pairs from the sub-object.
+### `objectPropHasValue({ object, propName, value })`
 
-**Parameters:**
-- `mainObject`: `T` - The main object to check.
-- `subObject`: `Partial<T>` - The sub-object to search for.
+Checks if a specific property on an object equals a given value.
 
 **Example:**
 ```typescript
-const mainObj = { id: 1, name: "John", age: 30, city: "New York" }
-const subObj = { name: "John", age: 30 }
-
-console.log(ObjectHelpers.containsSubObject(mainObj, subObj)) // true
+const user = { id: 1, name: "John", age: 30 }
 
-const subObj2 = { name: "Jane", age: 30 }
-console.log(ObjectHelpers.containsSubObject(mainObj, subObj2)) // false
+ObjectHelpers.objectPropHasValue({ object: user, propName: "name", value: "John" }) // true
+ObjectHelpers.objectPropHasValue({ object: user, propName: "age",  value: 25 })     // false
 ```
 
-### `findObjectBySubObject(array, subObject)`
+---
 
-Finds the first object in an array that contains the specified sub-object.
+### `findEntry(array, predicate)`
 
-**Parameters:**
-- `array`: `T[]` - Array of objects to search.
-- `subObject`: `Partial<T>` - The sub-object to search for.
+Returns the first array entry satisfying the predicate, or `null`.
 
 **Example:**
 ```typescript
-const users = [
-  { id: 1, name: "John", age: 30, city: "New York" },
-  { id: 2, name: "Jane", age: 25, city: "Boston" },
-  { id: 3, name: "Bob", age: 30, city: "Chicago" }
-]
-
-const result = ObjectHelpers.findObjectBySubObject(users, { age: 30, city: "New York" })
-console.log(result) // { id: 1, name: "John", age: 30, city: "New York" }
-
-const result2 = ObjectHelpers.findObjectBySubObject(users, { name: "Alice" })
-console.log(result2) // null
+ObjectHelpers.findEntry([1, 2, 3, 4], (n) => n % 2 === 0) // 2
+ObjectHelpers.findEntry([1, 2, 3],    (n) => n > 10)       // null
 ```
 
-### `filterObjectsBySubObject(array, subObject)`
+---
 
-Filters an array of objects based on containing the specified sub-object.
+### `convertArrayToMap(arrayData, keyProp)`
 
-**Parameters:**
-- `array`: `T[]` - Array of objects to filter.
-- `subObject`: `Partial<T>` - The sub-object to search for.
+Converts an array of objects into a keyed map using a specified property.
 
 **Example:**
 ```typescript
 const users = [
-  { id: 1, name: "John", age: 30, city: "New York" },
-  { id: 2, name: "Jane", age: 25, city: "Boston" },
-  { id: 3, name: "Bob", age: 30, city: "Chicago" }
+  { id: 1, name: "John" },
+  { id: 2, name: "Jane" },
 ]
 
-const results = ObjectHelpers.filterObjectsBySubObject(users, { age: 30 })
-console.log(results) // [{ id: 1, name: "John", age: 30, city: "New York" }, { id: 3, name: "Bob", age: 30, city: "Chicago" }]
+ObjectHelpers.convertArrayToMap(users, "id")
+// { "1": { id: 1, name: "John" }, "2": { id: 2, name: "Jane" } }
 ```
 
-### `objectPropHasValue({object, propName, value})`
+---
 
-Checks if an object has a specific property with a specific value.
+### `convertObjectKeysToKebabCase(obj)`
 
-**Parameters:**
-- `object`: `ObjectType` - The object to check.
-- `propName`: `keyof ObjectType` - The property name.
-- `value`: `ObjectType[keyof ObjectType]` - The expected value.
+Converts all camelCase keys of an object to kebab-case. Returns `undefined` for `undefined` input.
 
 **Example:**
 ```typescript
-const user = { id: 1, name: "John", age: 30 }
+ObjectHelpers.convertObjectKeysToKebabCase({ firstName: "John", lastName: "Doe" })
+// { "first-name": "John", "last-name": "Doe" }
 
-console.log(ObjectHelpers.objectPropHasValue({ object: user, propName: "name", value: "John" })) // true
-console.log(ObjectHelpers.objectPropHasValue({ object: user, propName: "age", value: 25 })) // false
+ObjectHelpers.convertObjectKeysToKebabCase(undefined)
+// undefined
 ```
 
-### `findEntry(array, predicate)`
+---
 
-Finds the first entry in an array that satisfies a predicate function.
+## MapHelpers
 
-**Parameters:**
-- `array`: `EntryType[]` - Array to search.
-- `predicate`: `(item: EntryType) => boolean` - Predicate function.
+### `getDistanceBetweenPoints(point1, point2)`
+
+Calculates the distance between two `[lat, lng]` points using the [Haversine formula](https://en.wikipedia.org/wiki/Haversine_formula). Returns metres, or `null` for undefined input.
 
 **Example:**
 ```typescript
-const numbers = [1, 2, 3, 4, 5, 6]
-
-const even = ObjectHelpers.findEntry(numbers, (n) => n % 2 === 0)
-console.log(even) // 2
+// New York → Los Angeles
+MapHelpers.getDistanceBetweenPoints([40.7128, -74.006], [34.0522, -118.2437])
+// ~3,944,419 metres (~3,944 km)
 
-const greaterThan5 = ObjectHelpers.findEntry(numbers, (n) => n > 5)
-console.log(greaterThan5) // 6
-
-const greaterThan10 = ObjectHelpers.findEntry(numbers, (n) => n > 10)
-console.log(greaterThan10) // null
+MapHelpers.getDistanceBetweenPoints([40.7128, -74.006], undefined)
+// null
 ```
 
-### `convertArrayToMap(arrayData, keyProp)`
+---
 
-Converts an array of objects to a map using a specified key property.
+### `compareLocations(location1, location2, precision?)`
+
+Compares two `[lat, lng]` coordinates within a decimal precision. Throws if either is `undefined`.
 
 **Parameters:**
-- `arrayData`: `T[]` - Array of objects to convert.
-- `keyProp`: `keyof T` - Property to use as the key.
+- `precision` (optional): `number` — Decimal places. Defaults to `6`.
 
 **Example:**
 ```typescript
-const users = [
-  { id: 1, name: "John", age: 30 },
-  { id: 2, name: "Jane", age: 25 },
-  { id: 3, name: "Bob", age: 35 }
-]
-
-const userMap = ObjectHelpers.convertArrayToMap(users, "id")
-console.log(userMap)
-// {
-//   "1": { id: 1, name: "John", age: 30 },
-//   "2": { id: 2, name: "Jane", age: 25 },
-//   "3": { id: 3, name: "Bob", age: 35 }
-// }
+MapHelpers.compareLocations([51.5074, -0.1278], [51.5074, -0.1278])       // true
+MapHelpers.compareLocations([51.5074, -0.1278], [51.5074001, -0.127801])  // true  (within 6 decimals)
+MapHelpers.compareLocations([51.5074, -0.1278], [51.51,      -0.13], 2)   // false
 ```
 
-Converts object keys from camelCase to kebab-case.
+---
 
-**Parameters:**
+### `getBearingToCoordinate({ startCoordinate, endCoordinate })`
 
-- `obj`: `T | undefined` - The object to convert.
+Returns the compass bearing (0–360°) from start to end coordinate. Throws if either is `undefined`.
 
 **Example:**
-
 ```typescript
-const camelCaseObj = { firstName: "John", lastName: "Doe", age: 30 }
-const result = ObjectHelpers.convertObjectKeysToKebabCase(camelCaseObj)
-console.log(result) // { "first-name": "John", "last-name": "Doe", age: 30 }
-
-// Handles mixed case keys
-const mixedObj = { firstName: "John", "last-name": "Doe", userName: "johndoe" }
-const result2 = ObjectHelpers.convertObjectKeysToKebabCase(mixedObj)
-console.log(result2) // { "first-name": "John", "last-name": "Doe", "user-name": "johndoe" }
-
-// Returns undefined for undefined input
-const result3 = ObjectHelpers.convertObjectKeysToKebabCase(undefined)
-console.log(result3) // undefined
+// New York → Los Angeles
+MapHelpers.getBearingToCoordinate({
+  startCoordinate: [40.7128, -74.006],
+  endCoordinate:   [34.0522, -118.2437],
+})
+// ~277.5 (roughly west)
 ```
 
-## GenericHelpers
+---
 
-General utility functions for common operations.
+## GenericHelpers
 
 ### `delay(ms)`
 
-Creates a delay (sleep) for the specified number of milliseconds.
-
-**Parameters:**
-- `ms`: `number` - Number of milliseconds to wait.
+Async sleep for the specified number of milliseconds.
 
 **Example:**
 ```typescript
-// Using with async/await
-async function example() {
-  console.log("Starting...")
-  await GenericHelpers.delay(2000) // Wait 2 seconds
-  console.log("Done!")
-}
-
-// Using with promises
-GenericHelpers.delay(1000).then(() => {
-  console.log("1 second has passed")
-})
+await GenericHelpers.delay(1000) // wait 1 second
 ```
 
-### `getPreferredUriScheme(host)`
+---
 
-Determines the preferred URI scheme (http or https) for a given host.
+### `getPreferredUriScheme(host)`
 
-**Parameters:**
-- `host`: `string` - IP address or domain name.
+Returns `"http"` for local/private hosts, `"https"` for everything else.
 
 **Example:**
 ```typescript
-console.log(GenericHelpers.getPreferredUriScheme("example.com")) // "https"
-console.log(GenericHelpers.getPreferredUriScheme("localhost")) // "http"
-console.log(GenericHelpers.getPreferredUriScheme("127.0.0.1")) // "http"
-console.log(GenericHelpers.getPreferredUriScheme("192.168.1.1")) // "http"
-console.log(GenericHelpers.getPreferredUriScheme("10.0.0.1")) // "http"
+GenericHelpers.getPreferredUriScheme("api.example.com") // "https"
+GenericHelpers.getPreferredUriScheme("localhost")        // "http"
+GenericHelpers.getPreferredUriScheme("192.168.1.1")      // "http"
+GenericHelpers.getPreferredUriScheme("10.0.0.1")         // "http"
 ```
 
-## FileHelpers
+---
 
-Utility functions for file operations and validation.
+## FileHelpers
 
 ### `checkFileExtension(filePath, validExtensions)`
 
-Checks if a file path has one of the valid extensions.
-
-**Parameters:**
-- `filePath`: `string` - The file path to check.
-- `validExtensions`: `string[]` - Array of valid file extensions.
+Returns `true` if the file has one of the allowed extensions.
 
 **Example:**
 ```typescript
-console.log(FileHelpers.checkFileExtension("document.pdf", ["pdf", "doc", "docx"])) // true
-console.log(FileHelpers.checkFileExtension("image.jpg", ["png", "gif", "svg"])) // false
-console.log(FileHelpers.checkFileExtension("data.geojson", ["geojson", "json"])) // true
-console.log(FileHelpers.checkFileExtension("script.js", ["js", "ts", "jsx"])) // true
-console.log(FileHelpers.checkFileExtension("file", ["txt", "md"])) // false (no extension)
+FileHelpers.checkFileExtension("report.pdf",  ["pdf", "docx"]) // true
+FileHelpers.checkFileExtension("data.geojson", ["geojson"])    // true
+FileHelpers.checkFileExtension("photo.txt",   ["jpg", "png"])  // false
 ```
 
-### `formatFileSize(bytes)`
-
-Formats a file size in bytes to a human-readable string with appropriate units.
+---
 
-**Parameters:**
+### `formatFileSize(bytes)`
 
-- `bytes`: `number | null` - The file size in bytes.
+Formats a byte count into a human-readable size string.
 
 **Example:**
-
 ```typescript
-console.log(FileHelpers.formatFileSize(1024)) // "1.0 KB"
-console.log(FileHelpers.formatFileSize(1024 * 1024)) // "1.0 MB"
-console.log(FileHelpers.formatFileSize(1024 * 1024 * 1024)) // "1.0 GB"
-console.log(FileHelpers.formatFileSize(512)) // "512 B"
-console.log(FileHelpers.formatFileSize(1536)) // "1.5 KB"
-console.log(FileHelpers.formatFileSize(0)) // "0 B"
-console.log(FileHelpers.formatFileSize(null)) // "0 B"
+FileHelpers.formatFileSize(512)              // "512 B"
+FileHelpers.formatFileSize(1024)             // "1.0 KB"
+FileHelpers.formatFileSize(1024 * 1024 * 2) // "2.0 MB"
+FileHelpers.formatFileSize(0)               // "0 B"
+FileHelpers.formatFileSize(null)            // "0 B"
 ```
 
+---
+
 ## Contributing
 
 We welcome contributions! Please feel free to submit a Pull Request.
@@ -969,60 +758,21 @@ npm test
 
 ### Commit Message Guidelines
 
-We follow [Conventional Commits](https://www.conventionalcommits.org/) for our semantic release process. **We prefer commit messages to include a scope in parentheses** for better categorization and changelog generation.
+We follow [Conventional Commits](https://www.conventionalcommits.org/). Scope is required.
 
-### Preferred Format
-```
+```text
 type(scope): description
-
-[optional body]
-
-[optional footer]
 ```
 
-### Examples
-```bash
-## ✅ Preferred - with scope
-feat(date): add new date formatting options
-fix(text): resolve string validation issue
-docs(readme): add troubleshooting section
-chore(deps): update dependencies
-
-## ❌ Less preferred - without scope
-feat: add new date formatting options
-fix: resolve string validation issue
-docs: add troubleshooting section
-chore: update dependencies
-```
+**Common scopes:** `date` · `text` · `object` · `map` · `generic` · `file` · `docs` · `deps` · `test` · `build` · `ci`
 
-### Common Scopes
-- `date` - Date manipulation functions
-- `text` - Text processing functions
-- `object` - Object manipulation functions
-- `map` - Map and geographical functions
-- `generic` - Generic utility functions
-- `file` - File processing functions
-- `docs` - Documentation updates
-- `deps` - Dependency updates
-- `test` - Test-related changes
-- `build` - Build and build tooling
-- `ci` - CI/CD configuration
-
-### Commit Types
-- `feat` - New features
-- `fix` - Bug fixes
-- `docs` - Documentation changes
-- `style` - Code style changes (formatting, etc.)
-- `refactor` - Code refactoring
-- `test` - Adding or updating tests
-- `chore` - Maintenance tasks
-
-If you introduce a breaking change, please add `BREAKING CHANGE` in the pull request description.
+**Types:** `feat` · `fix` · `docs` · `style` · `refactor` · `test` · `chore`
 
-## License
+## Requirements
 
-[MIT](https://github.com/akadenia/AkadeniaHelpers/blob/main/LICENSE)
+- Node.js >= 20
+- Zero runtime dependencies
 
-## Support
+## License
 
-For support, please open an issue on [GitHub](https://github.com/akadenia/AkadeniaHelpers/issues).
+[MIT](LICENSE)