@akadenia/helpers 1.7.3 → 1.9.0

package/dist/file.d.ts

@@ -8,3 +8,12 @@
  * checkFileExtension("test.txt", ["md"]) // false
  */
 export declare const checkFileExtension: (filePath: string, validExtensions: string[]) => boolean;
+/**
+ * Format a file size to a human readable string
+ * @param bytes The file size in bytes
+ * @returns The formatted file size
+ * @example
+ * formatFileSize(1024) // "1.0 KB"
+ * formatFileSize(1024 * 1024) // "1.0 MB"
+ */
+export declare const formatFileSize: (bytes: number | null) => string;

package/dist/file.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkFileExtension = void 0;
+exports.formatFileSize = exports.checkFileExtension = void 0;
 /**
  * Check if a file path has a valid extension
  * @param filePath The file path to check
@@ -15,3 +15,21 @@ const checkFileExtension = (filePath, validExtensions) => {
     return !!fileExtension && validExtensions.includes(fileExtension);
 };
 exports.checkFileExtension = checkFileExtension;
+/**
+ * Format a file size to a human readable string
+ * @param bytes The file size in bytes
+ * @returns The formatted file size
+ * @example
+ * formatFileSize(1024) // "1.0 KB"
+ * formatFileSize(1024 * 1024) // "1.0 MB"
+ */
+const formatFileSize = (bytes) => {
+    if (!bytes || bytes <= 0)
+        return "0 B";
+    const units = ["B", "KB", "MB", "GB", "TB"];
+    const unitIndex = Math.floor(Math.log2(bytes) / 10);
+    const clampedIndex = Math.min(unitIndex, units.length - 1);
+    const size = bytes / Math.pow(1024, clampedIndex);
+    return `${size.toFixed(clampedIndex === 0 ? 0 : 1)} ${units[clampedIndex]}`;
+};
+exports.formatFileSize = formatFileSize;

package/dist/object.d.ts

@@ -74,3 +74,10 @@ export declare const findEntry: <EntryType>(array: EntryType[], predicate: (item
 export declare function convertArrayToMap<T extends object>(arrayData: T[], keyProp: keyof T): {
     [key: string]: T;
 };
+/**
+ * Converts object keys from camelCase to kebab-case
+ * @template T extends Record<string, any> - The type of the object
+ * @param {T | undefined} obj - The object to convert
+ * @returns {Record<string, any> | undefined} - The object with kebab-case keys or undefined
+ */
+export declare const convertObjectKeysToKebabCase: <T extends Record<string, any>>(obj: T | undefined) => Record<string, any> | undefined;

package/dist/object.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findEntry = exports.objectPropHasValue = exports.parseCookie = exports.isPureObject = void 0;
+exports.convertObjectKeysToKebabCase = exports.findEntry = exports.objectPropHasValue = exports.parseCookie = exports.isPureObject = void 0;
 exports.filterObjectsByProperty = filterObjectsByProperty;
 exports.containsSubObject = containsSubObject;
 exports.findObjectBySubObject = findObjectBySubObject;
 exports.filterObjectsBySubObject = filterObjectsBySubObject;
 exports.convertArrayToMap = convertArrayToMap;
+const text_1 = require("./text");
 /**
  *
  * @function
@@ -121,3 +122,15 @@ function convertArrayToMap(arrayData, keyProp) {
     }, dataAsObject);
     return dataAsObject;
 }
+/**
+ * Converts object keys from camelCase to kebab-case
+ * @template T extends Record<string, any> - The type of the object
+ * @param {T | undefined} obj - The object to convert
+ * @returns {Record<string, any> | undefined} - The object with kebab-case keys or undefined
+ */
+const convertObjectKeysToKebabCase = (obj) => {
+    if (!obj)
+        return undefined;
+    return Object.entries(obj).reduce((acc, [key, value]) => (Object.assign(Object.assign({}, acc), { [(0, text_1.convertCamelToKebabCase)(key)]: value })), {});
+};
+exports.convertObjectKeysToKebabCase = convertObjectKeysToKebabCase;

package/dist/text.d.ts

@@ -82,6 +82,13 @@ export declare function convertCamelToKebabCase(word: string): string;
  * @returns {string} - The word returned as camel case
  */
 export declare function convertKebabToCamelCase(word: string): string;
+/**
+ * Convert camel case to readable text
+ * @function
+ * @param {string} name - The name to be converted to readable text
+ * @returns {string} - The readable text
+ */
+export declare function convertCamelCaseToReadableText(name: string): string;
 /**
  * Generate acronym from text
  * @param term term to be converted to an acronym

package/dist/text.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.abbreviateNumber = exports.isValidEmail = exports.enforceCharacterLimit = exports.capitalizeText = exports.handleNullDisplay = exports.convertCamelToSnakeCase = exports.convertSnakeToCamelCase = exports.pluralizeOnCondition = exports.replaceUnderscoreWithSpaces = exports.replaceSpacesWithUnderscore = exports.fileNameFromPath = exports.truncateText = exports.formatPosition = exports.uuidv4 = exports.convertKeyCasing = void 0;
 exports.convertCamelToKebabCase = convertCamelToKebabCase;
 exports.convertKebabToCamelCase = convertKebabToCamelCase;
+exports.convertCamelCaseToReadableText = convertCamelCaseToReadableText;
 exports.generateAcronym = generateAcronym;
 exports.isAcronym = isAcronym;
 exports.acronymToKebabCase = acronymToKebabCase;
@@ -121,7 +122,22 @@ exports.replaceUnderscoreWithSpaces = replaceUnderscoreWithSpaces;
  * @returns {string} - The word with "s" added to the end if the condition is true
  */
 const pluralizeOnCondition = (word, condition) => {
-    return condition ? `${word}s` : word;
+    if (!condition)
+        return word;
+    const lowerCasedWord = word.toLowerCase();
+    // Handle words ending with 'y' (e.g., 'library' -> 'libraries')
+    if (lowerCasedWord.endsWith("y")) {
+        return `${word.slice(0, -1)}ies`;
+    }
+    // Handle words ending with 's', 'sh', or 'ch' (e.g., 'class' -> 'classes')
+    if (lowerCasedWord.endsWith("s") ||
+        lowerCasedWord.endsWith("sh") ||
+        lowerCasedWord.endsWith("ch") ||
+        lowerCasedWord.endsWith("x")) {
+        return `${word}es`;
+    }
+    // Default pluralization by adding 's'
+    return `${word}s`;
 };
 exports.pluralizeOnCondition = pluralizeOnCondition;
 /**
@@ -163,6 +179,19 @@ function convertKebabToCamelCase(word) {
         .map((token) => (0, exports.capitalizeText)(token))
         .join("");
 }
+/**
+ * Convert camel case to readable text
+ * @function
+ * @param {string} name - The name to be converted to readable text
+ * @returns {string} - The readable text
+ */
+function convertCamelCaseToReadableText(name) {
+    return name
+        .replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
+        .replace(/([a-z\d])([A-Z])/g, "$1 $2")
+        .replace(/^./, (c) => c.toUpperCase())
+        .trim();
+}
 /**
  * Generate acronym from text
  * @param term term to be converted to an acronym

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akadenia/helpers",
-  "version": "1.7.3",
+  "version": "1.9.0",
   "description": "Akadenia helpers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
     "akadenia"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "build": "rimraf dist && tsc -p tsconfig.json",
     "test": "jest",
     "format": "prettier --write \"./**/*.{ts,tsx,js,jsx,json,yml}\"",
     "lint": "prettier --check \"./**/*.{ts,tsx,js,jsx,json,yml}\"",
@@ -42,6 +42,7 @@
     "jest": "^29.7.0",
     "jsdoc-to-markdown": "^8.0.3",
     "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
     "semantic-release": "22.0.12",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.2"