@akadenia/helpers 1.6.0 → 1.7.1

package/README.MD

@@ -347,14 +347,21 @@ Arguments
 
 ## `TextHelpers.abbreviateNumber(number)`
 
-Abbreviate number
-Returns the string representation of the abbreviated number
+Returns the string representation of the abbreviated number, rounded to two decimal places.
 
 Arguments
 |Name|Type|Required|Description|
 |--|--|--|--|
 |`number`|`number`|`true`|The number to be abbreviated|
 
+Examples
+- Numbers below 1,000 are displayed without abbreviation
+- Numbers between 1,000 and 1,000,000 are displayed in thousands (e.g. 1.23K)
+- Numbers between 1,000,000 and 1,000,000,000 are displayed in millions (e.g. 1.23M)
+- Numbers above 1,000,000,000 are displayed in billions (e.g. 1.23B)
+
+Note: If the input `number` is null or undefined, the function returns null.
+
 # ObjectHelpers
 
 Import the ObjectHelpers utility.

package/dist/date.d.ts

@@ -39,6 +39,7 @@ export declare function parseDate(date: string | Date): Date;
  *
  * @function
  * @param {string | Date} date - The date string that needs to be formatted
+ * @param {boolean} appendTime - A boolean to determine if the time should be appended to the date
  * @returns {string} - A string representing the date in the short ordinal date
  */
-export declare function getShortOrdinalDate(date: string | Date): string;
+export declare function getShortOrdinalDate(date: string | Date, appendTime?: boolean): string;

package/dist/date.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getShortOrdinalDate = exports.parseDate = exports.formatDateTime = exports.getDateString = exports.getReadableDate = exports.getReadableDateTime = void 0;
+exports.formatDateTime = exports.getDateString = exports.getReadableDate = exports.getReadableDateTime = void 0;
+exports.parseDate = parseDate;
+exports.getShortOrdinalDate = getShortOrdinalDate;
 /**
  *
  * @function
@@ -47,27 +49,27 @@ exports.formatDateTime = formatDateTime;
 function parseDate(date) {
     const outputDate = typeof date === "string" ? new Date(date) : date;
     if (isNaN(outputDate.getTime())) {
-        throw new Error(`Cannot parse passed date: ${JSON.stringify(date)}`);
+        throw new Error(`Cannot parse date: ${JSON.stringify(date)}`);
     }
     return outputDate;
 }
-exports.parseDate = parseDate;
 /**
  *
  * @function
  * @param {string | Date} date - The date string that needs to be formatted
+ * @param {boolean} appendTime - A boolean to determine if the time should be appended to the date
  * @returns {string} - A string representing the date in the short ordinal date
  */
-function getShortOrdinalDate(date) {
+function getShortOrdinalDate(date, appendTime) {
     var _a;
     const newDate = parseDate(date);
-    const day = newDate.getDate();
+    const day = newDate.getUTCDate();
     const monthNames = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
-    const monthIndex = newDate.getMonth();
-    const year = newDate.getFullYear();
-    const hours = newDate.getHours().toString().padStart(2, "0");
-    const minutes = newDate.getMinutes().toString().padStart(2, "0");
-    const seconds = newDate.getSeconds().toString().padStart(2, "0");
+    const monthIndex = newDate.getUTCMonth();
+    const year = newDate.getUTCFullYear();
+    const hours = newDate.getUTCHours().toString().padStart(2, "0");
+    const minutes = newDate.getUTCMinutes().toString().padStart(2, "0");
+    const seconds = newDate.getUTCSeconds().toString().padStart(2, "0");
     const ordinalEndings = ["th", "st", "nd", "rd"];
     let suffix = ordinalEndings[0];
     if (day <= 3 && day > 0) {
@@ -77,6 +79,10 @@ function getShortOrdinalDate(date) {
         // Determine the ordinal endings based on the last digit of the day
         suffix = (_a = ordinalEndings[day % 10]) !== null && _a !== void 0 ? _a : suffix;
     }
-    return `${day}${suffix}, ${monthNames[monthIndex]} ${year} ${hours}:${minutes}:${seconds}`;
+    if (appendTime) {
+        return `${monthNames[monthIndex]} ${day}${suffix} ${year} ${hours}:${minutes}:${seconds}`;
+    }
+    else {
+        return `${monthNames[monthIndex]} ${day}${suffix} ${year}`;
+    }
 }
-exports.getShortOrdinalDate = getShortOrdinalDate;

package/dist/object.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertArrayToMap = exports.findEntry = exports.objectPropHasValue = exports.filterObjectsBySubObject = exports.findObjectBySubObject = exports.containsSubObject = exports.filterObjectsByProperty = exports.parseCookie = exports.isPureObject = void 0;
+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;
 /**
  *
  * @function
@@ -39,7 +44,6 @@ function filterObjectsByProperty(array, propertyName, propertyValue) {
     const predicate = (obj) => Object.getOwnPropertyDescriptor(obj, propertyName) && obj[propertyName] === propertyValue;
     return array.filter(predicate);
 }
-exports.filterObjectsByProperty = filterObjectsByProperty;
 /**
  * Checks if the main object contains the sub object.
  * @template T extends Record<string, any> - The type of the main object.
@@ -58,7 +62,6 @@ function containsSubObject(mainObject, subObject) {
     }
     return true;
 }
-exports.containsSubObject = containsSubObject;
 /**
  * Finds the object containing the given sub object in the array.
  * @template T extends Record<string, any> - The type of objects in the array.
@@ -70,7 +73,6 @@ function findObjectBySubObject(array, subObject) {
     const predicate = (obj) => containsSubObject(obj, subObject);
     return array.find(predicate) || null;
 }
-exports.findObjectBySubObject = findObjectBySubObject;
 /**
  * Filters an array of objects based on the objects containing the given sub object
  * @template T extends Record<string, any>
@@ -82,7 +84,6 @@ function filterObjectsBySubObject(array, subObject) {
     const predicate = (obj) => containsSubObject(obj, subObject);
     return array.filter(predicate);
 }
-exports.filterObjectsBySubObject = filterObjectsBySubObject;
 /**
  * Checks if the object has the key with the value.
  * @param {Object} object - The object to check
@@ -120,4 +121,3 @@ function convertArrayToMap(arrayData, keyProp) {
     }, dataAsObject);
     return dataAsObject;
 }
-exports.convertArrayToMap = convertArrayToMap;

package/dist/text.d.ts

@@ -5,7 +5,7 @@
  * @param {"toSnakeCase" | "toCamelCase"} type - The type of casing the string, object, or array of objects should be converted to (snake_case or camelCase)
  * @returns {T} - A new string, object, or array of objects in the specified casing
  */
-export declare const convertKeyCasing: <T extends string | Object | Object[]>(input: T, type: "toSnakeCase" | "toCamelCase") => T;
+export declare const convertKeyCasing: <T extends string | Object | Array<Object>>(input: T, type: "toSnakeCase" | "toCamelCase") => T;
 /**
  *
  * @function

package/dist/text.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.abbreviateNumber = exports.extractIDfromSlug = exports.generateSlugFromWordsWithID = exports.generateWordFromId = exports.generateIDFromWord = exports.isValidEmail = exports.enforceCharacterLimit = exports.capitalizeText = exports.handleNullDisplay = exports.acronymToKebabCase = exports.isAcronym = exports.generateAcronym = exports.convertKebabToCamelCase = exports.convertCamelToKebabCase = exports.convertCamelToSnakeCase = exports.convertSnakeToCamelCase = exports.pluralizeOnCondition = exports.replaceUnderscoreWithSpaces = exports.replaceSpacesWithUnderscore = exports.fileNameFromPath = exports.truncateText = exports.formatPosition = exports.uuidv4 = exports.convertKeyCasing = void 0;
+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.generateAcronym = generateAcronym;
+exports.isAcronym = isAcronym;
+exports.acronymToKebabCase = acronymToKebabCase;
+exports.generateIDFromWord = generateIDFromWord;
+exports.generateWordFromId = generateWordFromId;
+exports.generateSlugFromWordsWithID = generateSlugFromWordsWithID;
+exports.extractIDfromSlug = extractIDfromSlug;
 const _1 = require("./");
 // Internal Helper Functions At The Top
 /**
@@ -142,7 +151,6 @@ exports.convertCamelToSnakeCase = convertCamelToSnakeCase;
 function convertCamelToKebabCase(word) {
     return word.replace(/[A-Z]+(?![a-z])|[A-Z]/g, ($, ofs) => (ofs ? "-" : "") + $.toLowerCase());
 }
-exports.convertCamelToKebabCase = convertCamelToKebabCase;
 /**
  * Convert kebab case to camel case
  * @function
@@ -155,7 +163,6 @@ function convertKebabToCamelCase(word) {
         .map((token) => (0, exports.capitalizeText)(token))
         .join("");
 }
-exports.convertKebabToCamelCase = convertKebabToCamelCase;
 /**
  * Generate acronym from text
  * @param term term to be converted to an acronym
@@ -167,7 +174,6 @@ function generateAcronym(term) {
         .map((word) => word[0])
         .join("");
 }
-exports.generateAcronym = generateAcronym;
 /**
  * Validate if a word is acronym
  * @function
@@ -177,7 +183,6 @@ exports.generateAcronym = generateAcronym;
 function isAcronym(word) {
     return word.toUpperCase() === word;
 }
-exports.isAcronym = isAcronym;
 /**
  * Convert acronym to kebab case
  * @function
@@ -193,7 +198,6 @@ function acronymToKebabCase(word) {
         .map((token) => token.toLowerCase())
         .join("-");
 }
-exports.acronymToKebabCase = acronymToKebabCase;
 /**
  * @function
  * @param  value The string to be displayed
@@ -253,7 +257,6 @@ function generateIDFromWord(text) {
         .map((word) => word.toLowerCase())
         .join("-");
 }
-exports.generateIDFromWord = generateIDFromWord;
 /**
  * Get the word from the generated ID
  * @function
@@ -265,7 +268,6 @@ function generateWordFromId(id, customList = {}) {
     var _a;
     return (_a = customList[id]) !== null && _a !== void 0 ? _a : id.split("-").map(exports.capitalizeText).join(" ");
 }
-exports.generateWordFromId = generateWordFromId;
 /**
  * Get the slug from words
  * @function
@@ -278,7 +280,6 @@ function generateSlugFromWordsWithID(id, ...words) {
     allWords = allWords.map((word) => encodeURIComponent(word.toLocaleLowerCase()));
     return allWords.join("-");
 }
-exports.generateSlugFromWordsWithID = generateSlugFromWordsWithID;
 /**
  * Extracts the id from the slug
  * @function
@@ -291,7 +292,6 @@ function extractIDfromSlug(slug) {
     }
     return slug.split("-").pop();
 }
-exports.extractIDfromSlug = extractIDfromSlug;
 /**
  * Abbreviate number
  * @function
@@ -302,14 +302,14 @@ const abbreviateNumber = (number) => {
     const abbreviations = [
         { value: 1e9, symbol: "B" },
         { value: 1e6, symbol: "M" },
-        { value: 1e3, symbol: "k" },
+        { value: 1e3, symbol: "K" },
     ];
     if (!number || isNaN(number))
         return null;
     const abbreviated = abbreviations.find(({ value }) => Math.abs(number) >= value);
     if (abbreviated) {
         const { value, symbol } = abbreviated;
-        return (number / value).toFixed(1).replace(/\.0$/, "") + symbol;
+        return (number / value).toFixed(2).replace(/\.00$/, "") + symbol;
     }
     return number.toString();
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akadenia/helpers",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "Akadenia helpers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,20 +30,20 @@
   "bugs": {
     "url": "https://github.com/akadenia/AkadeniaHelpers/issues"
   },
-  "homepage": "https://github.com/akadenia/AkadeniaHelpers#readme",
+  "homepage": "https://akadenia.com/packages/akadenia-helpers",
   "devDependencies": {
     "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.2",
+    "@commitlint/config-conventional": "^18.6.3",
     "@jest/globals": "^29.7.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
-    "@types/node": "^18.16.1",
-    "husky": "^9.0.11",
+    "@types/node": "^18.19.54",
+    "husky": "^9.1.6",
     "jest": "^29.7.0",
-    "jsdoc-to-markdown": "^8.0.1",
-    "prettier": "^3.2.5",
+    "jsdoc-to-markdown": "^8.0.3",
+    "prettier": "^3.3.3",
     "semantic-release": "22.0.12",
-    "ts-jest": "^29.1.2",
-    "typescript": "^5.4.3"
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.2"
   }
 }