@akadenia/helpers 1.4.1 → 1.6.0

package/README.MD

@@ -29,7 +29,10 @@
   - [`TextHelpers.enforceCharacterLimit({text, characterLimit, onCharacterLimit})`](#texthelpersenforcecharacterlimittext-characterlimit-oncharacterlimit)
   - [`TextHelpers.isValidEmail(email)`](#texthelpersisvalidemailemail)
   - [`TextHelpers.generateIdFromWord(word)`](#texthelpersgenerateidfromwordword)
-  - [`TextHelpers.generateWordFromId(id)`](#texthelpersgeneratewordfromidid)
+  - [`TextHelpers.generateWordFromId(word)`](#texthelpersgeneratewordfromidword)
+  - [`TextHelpers.generateSlugFromWords(id, ...words)`](#texthelpersgenerateslugfromwordsid-words)
+  - [`TextHelpers.extractIDfromSlug(slug)`](#texthelpersextractidfromslugslug)
+  - [`TextHelpers.abbreviateNumber(number)`](#texthelpersabbreviatenumbernumber)
 - [ObjectHelpers](#objecthelpers)
   - [`ObjectHelpers.isPureObject(any)`](#objecthelpersispureobjectany)
   - [`ObjectHelpers.parseCookie(str)`](#objecthelpersparsecookiestr)
@@ -37,13 +40,15 @@
   - [`ObjectHelpers.containsSubObject(mainObject, subObject)`](#objecthelperscontainssubobjectmainobject-subobject)
   - [`ObjectHelpers.findObjectBySubObject(array, subObject)`](#objecthelpersfindobjectbysubobjectarray-subobject)
   - [`ObjectHelpers.filterObjectsBySubObject(array, subObject)`](#objecthelpersfilterobjectsbysubobjectarray-subobject)
-  - [`ObjectHelpers.objectPropHasValue({object, key, value)}`](#objecthelpersobjectkeyhasvalueobject-key-value)
+  - [`ObjectHelpers.objectPropHasValue({object, key, value)}`](#objecthelpersobjectprophasvalueobject-key-value)
   - [`ObjectHelpers.findEntry(array, predicate)`](#objecthelpersfindentryarray-predicate)
 - [GenericHelpers](#generichelpers)
   - [`GenericHelpers.delay(ms)`](#generichelpersdelayms)
   - [`GenericHelpers.getPreferredUriScheme(host)`](#generichelpersgetpreferredurischemehost)
 - [FileHelpers](#filehelpers)
   - [`FileHelpers.checkFileExtension(filePath, validExtensions)`](#filehelperscheckfileextensionfilepath-validextensions)
+  - [Contributing to this package](#contributing-to-this-package)
+  - [License](#license)
 
 # DateHelpers
 
@@ -260,7 +265,6 @@ Arguments
 |--|--|--|--|
 |`data`|`string`|The word that is being validated as acronym|
 
-
 ## `TextHelpers.acronymToKebabCase(data)`
 
 Convert acronym to kebab case
@@ -271,7 +275,6 @@ Arguments
 |--|--|--|--|
 |`data`|`string`|The acronym to be converted to kebab case|
 
-
 ## `TextHelpers.handleNullDisplay(value, defaultValue="N/A")`
 
 Returns the input string or the default string if the input value is null or undefined.
@@ -302,7 +305,7 @@ Arguments
 ## `TextHelpers.generateIdFromWord(word)`
 
 Generate ID from word
-The generated ID from the word
+Returns the generated ID from the word
 
 Arguments
 |Name|Type|Required|Description|
@@ -312,14 +315,45 @@ Arguments
 ## `TextHelpers.generateWordFromId(word)`
 
 Get the word from the generated ID
-The word that is got from the id
+Returns the word that is got from the id
 
 Arguments
 |Name|Type|Required|Description|
 |--|--|--|--|
-|`word`|`string`|`true`|The id that is needed to get the word from|
+|`words`|`string`|`true`|The id that is needed to get the word from|
 |`customList`|`Record<string, string>`|`false`|The custom lists that has the id with the custom list of words|
 
+## `TextHelpers.generateSlugFromWords(id, ...words)`
+
+Get the slug from words
+Returns the slug from the words and it will be url path safe
+
+Arguments
+|Name|Type|Required|Description|
+|--|--|--|--|
+|`id`|`string`|`true`|The id that is needed to be concatenated with the slug|
+|`words`|`string[]`|`true`|The words that will be in the slug|
+
+## `TextHelpers.extractIDfromSlug(slug)`
+
+Extracts the id from the slug
+Returns the id from the slug
+Throws error if the string is empty, null or undefined
+
+Arguments
+|Name|Type|Required|Description|
+|--|--|--|--|
+|`slug`|`string`|`true`|The slug associated with the id|
+
+## `TextHelpers.abbreviateNumber(number)`
+
+Abbreviate number
+Returns the string representation of the abbreviated number
+
+Arguments
+|Name|Type|Required|Description|
+|--|--|--|--|
+|`number`|`number`|`true`|The number to be abbreviated|
 
 # ObjectHelpers
 
@@ -402,7 +436,9 @@ Arguments
 |--|--|--|--|
 |`array`|`T[]`|`true`|An array of objects to be filtered|
 |`array`|`Partial<T>`|`true`|The sub-object to be searched for in the array|
+
 ## `ObjectHelpers.objectPropHasValue({object, key, value)}`
+
 Checks if the object has the key with the value.
 
 Arguments
@@ -413,6 +449,7 @@ Arguments
 |`value`|`any`|`true`|The value to check|
 
 ## `ObjectHelpers.findEntry(array, predicate)`
+
 Finds the first entry in the array that satisfies the predicate.
 
 Arguments
@@ -457,7 +494,6 @@ Arguments
 |`filePath`|`string`|`true`|The file path to check|
 |`validExtensions`|`string[]`|`true`|The valid extensions|
 
-
 ## Contributing to this package
 
 This package follows the commitlint and conventional commits standards. As such the commit messages should follow the following format:

package/dist/index.d.ts

@@ -1,28 +1,7 @@
-import { convertCamelToSnakeCase, convertSnakeToCamelCase, fileNameFromPath, formatPosition, handleNullDisplay, pluralizeOnCondition, replaceSpacesWithUnderscore, replaceUnderscoreWithSpaces, truncateText, uuidv4, enforceCharacterLimit, capitalizeText, generateIDFromWord, generateWordFromId, convertCamelToKebabCase, convertKebabToCamelCase, generateAcronym, isAcronym, acronymToKebabCase } from "./text";
+import * as TextHelpers from "./text";
 import * as DateHelpers from "./date";
 import * as ObjectHelpers from "./object";
 import * as MapHelpers from "./map";
 import * as GenericHelpers from "./generic";
 import * as FileHelpers from "./file";
-declare const TextHelpers: {
-    convertCamelToSnakeCase: typeof convertCamelToSnakeCase;
-    convertSnakeToCamelCase: typeof convertSnakeToCamelCase;
-    fileNameFromPath: typeof fileNameFromPath;
-    formatPosition: typeof formatPosition;
-    handleNullDisplay: typeof handleNullDisplay;
-    pluralizeOnCondition: typeof pluralizeOnCondition;
-    replaceSpacesWithUnderscore: typeof replaceSpacesWithUnderscore;
-    replaceUnderscoreWithSpaces: typeof replaceUnderscoreWithSpaces;
-    truncateText: typeof truncateText;
-    uuidv4: typeof uuidv4;
-    enforceCharacterLimit: typeof enforceCharacterLimit;
-    capitalizeText: typeof capitalizeText;
-    convertCamelToKebabCase: typeof convertCamelToKebabCase;
-    convertKebabToCamelCase: typeof convertKebabToCamelCase;
-    generateAcronym: typeof generateAcronym;
-    isAcronym: typeof isAcronym;
-    acronymToKebabCase: typeof acronymToKebabCase;
-    generateIDFromWord: typeof generateIDFromWord;
-    generateWordFromId: typeof generateWordFromId;
-};
 export { ObjectHelpers, DateHelpers, MapHelpers, TextHelpers, GenericHelpers, FileHelpers };

package/dist/index.js

@@ -24,7 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileHelpers = exports.GenericHelpers = exports.TextHelpers = exports.MapHelpers = exports.DateHelpers = exports.ObjectHelpers = void 0;
-const text_1 = require("./text");
+const TextHelpers = __importStar(require("./text"));
+exports.TextHelpers = TextHelpers;
 const DateHelpers = __importStar(require("./date"));
 exports.DateHelpers = DateHelpers;
 const ObjectHelpers = __importStar(require("./object"));
@@ -35,25 +36,3 @@ const GenericHelpers = __importStar(require("./generic"));
 exports.GenericHelpers = GenericHelpers;
 const FileHelpers = __importStar(require("./file"));
 exports.FileHelpers = FileHelpers;
-const TextHelpers = {
-    convertCamelToSnakeCase: text_1.convertCamelToSnakeCase,
-    convertSnakeToCamelCase: text_1.convertSnakeToCamelCase,
-    fileNameFromPath: text_1.fileNameFromPath,
-    formatPosition: text_1.formatPosition,
-    handleNullDisplay: text_1.handleNullDisplay,
-    pluralizeOnCondition: text_1.pluralizeOnCondition,
-    replaceSpacesWithUnderscore: text_1.replaceSpacesWithUnderscore,
-    replaceUnderscoreWithSpaces: text_1.replaceUnderscoreWithSpaces,
-    truncateText: text_1.truncateText,
-    uuidv4: text_1.uuidv4,
-    enforceCharacterLimit: text_1.enforceCharacterLimit,
-    capitalizeText: text_1.capitalizeText,
-    convertCamelToKebabCase: text_1.convertCamelToKebabCase,
-    convertKebabToCamelCase: text_1.convertKebabToCamelCase,
-    generateAcronym: text_1.generateAcronym,
-    isAcronym: text_1.isAcronym,
-    acronymToKebabCase: text_1.acronymToKebabCase,
-    generateIDFromWord: text_1.generateIDFromWord,
-    generateWordFromId: text_1.generateWordFromId,
-};
-exports.TextHelpers = TextHelpers;

package/dist/text.d.ts

@@ -150,3 +150,25 @@ export declare function generateIDFromWord(text: string): string;
  * @returns The word that is got from the id
  */
 export declare function generateWordFromId(id: string, customList?: Record<string, string>): string;
+/**
+ * Get the slug from words
+ * @function
+ * @param id The id that will be in the slug
+ * @param words The words that will be in the slug
+ * @returns The slug from the words and it will be url path safe
+ */
+export declare function generateSlugFromWordsWithID(id: string, ...words: string[]): string;
+/**
+ * Extracts the id from the slug
+ * @function
+ * @param slug The slug associated with the id
+ * @returns The id from the slug
+ */
+export declare function extractIDfromSlug(slug: string): string | undefined;
+/**
+ * Abbreviate number
+ * @function
+ * @param number The number to be abbreviated
+ * @returns The string representation of the abbreviated number
+ */
+export declare const abbreviateNumber: (number: number | undefined | null) => string | null;

package/dist/text.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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;
 const _1 = require("./");
 // Internal Helper Functions At The Top
 /**
@@ -266,3 +266,51 @@ function generateWordFromId(id, customList = {}) {
     return (_a = customList[id]) !== null && _a !== void 0 ? _a : id.split("-").map(exports.capitalizeText).join(" ");
 }
 exports.generateWordFromId = generateWordFromId;
+/**
+ * Get the slug from words
+ * @function
+ * @param id The id that will be in the slug
+ * @param words The words that will be in the slug
+ * @returns The slug from the words and it will be url path safe
+ */
+function generateSlugFromWordsWithID(id, ...words) {
+    let allWords = [...words.map((word) => word.split(" ")).flat(), ...id.split(" ").flat()];
+    allWords = allWords.map((word) => encodeURIComponent(word.toLocaleLowerCase()));
+    return allWords.join("-");
+}
+exports.generateSlugFromWordsWithID = generateSlugFromWordsWithID;
+/**
+ * Extracts the id from the slug
+ * @function
+ * @param slug The slug associated with the id
+ * @returns The id from the slug
+ */
+function extractIDfromSlug(slug) {
+    if (!slug) {
+        throw new Error("slug cannot be empty, null or undefined string");
+    }
+    return slug.split("-").pop();
+}
+exports.extractIDfromSlug = extractIDfromSlug;
+/**
+ * Abbreviate number
+ * @function
+ * @param number The number to be abbreviated
+ * @returns The string representation of the abbreviated number
+ */
+const abbreviateNumber = (number) => {
+    const abbreviations = [
+        { value: 1e9, symbol: "B" },
+        { value: 1e6, symbol: "M" },
+        { 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.toString();
+};
+exports.abbreviateNumber = abbreviateNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akadenia/helpers",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "description": "Akadenia helpers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",