nhb-toolbox 0.9.2 → 0.9.3

package/dist/colors/constants.d.ts

@@ -0,0 +1,5 @@
+/** Colors based on the ASCII value of the letter. */
+export declare const alphabetColorPalette: string[];
+/** Colors based on the index of numbers. */
+export declare const numberColorPalette: string[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/colors/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/colors/constants.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,eAAO,MAAM,oBAAoB,UA2BhC,CAAC;AAEF,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB,UAW9B,CAAC"}

package/dist/colors/constants.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.numberColorPalette = exports.alphabetColorPalette = void 0;
+/** Colors based on the ASCII value of the letter. */
+exports.alphabetColorPalette = [
+    '#00094C',
+    '#00376E',
+    '#005600',
+    '#024647',
+    '#423067',
+    '#55188E',
+    '#00453E',
+    '#00516C',
+    '#263E0D',
+    '#0F6F3F',
+    '#730073',
+    '#053636',
+    '#253654',
+    '#4682B4',
+    '#3253B6',
+    '#43616C',
+    '#036C44',
+    '#30784F',
+    '#601C1C',
+    '#690000',
+    '#005B00',
+    '#BF0E6C',
+    '#008080',
+    '#475F47',
+    '#546F1C',
+    '#824809',
+];
+/** Colors based on the index of numbers. */
+exports.numberColorPalette = [
+    '#893213',
+    '#A44C15',
+    '#8B4513',
+    '#8A1D33',
+    '#3B543B',
+    '#342656',
+    '#A43522',
+    '#04605F',
+    '#B5680A',
+    '#6437B3',
+];

package/dist/colors/helpers.d.ts

@@ -0,0 +1,16 @@
+import type { OpacityValue } from './types';
+/**
+ * * Converts opacity percentage (0-100) to a 2-digit hex string.
+ *
+ * @param opacity - The opacity value as a percentage (0-100).
+ * @returns A 2-digit hex string representing the alpha value.
+ */
+export declare const convertOpacityToHex: (opacity: OpacityValue) => string;
+/**
+ * * Applies an opacity value to a color string.
+ * @param color The color string to apply opacity to.
+ * @param opacity The opacity value as a percentage (0-100).
+ * @returns The color string with the opacity value applied.
+ */
+export declare const applyOpacity: (color: string, opacity: string) => string;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/colors/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/colors/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,YAAa,YAAY,KAAG,MAO3D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,UAAW,MAAM,WAAW,MAAM,KAAG,MAE7D,CAAC"}

package/dist/colors/helpers.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyOpacity = exports.convertOpacityToHex = void 0;
+/**
+ * * Converts opacity percentage (0-100) to a 2-digit hex string.
+ *
+ * @param opacity - The opacity value as a percentage (0-100).
+ * @returns A 2-digit hex string representing the alpha value.
+ */
+const convertOpacityToHex = (opacity) => {
+    // Ensure opacity is between 0 and 100
+    const validOpacity = Math.min(100, Math.max(0, opacity));
+    // Convert to a value between 0 and 255, then to a hex string
+    const alpha = Math.round((validOpacity / 100) * 255);
+    // Ensure it's 2 digits (e.g., 0x0A instead of 0xA)
+    return alpha.toString(16).padStart(2, '0').toUpperCase();
+};
+exports.convertOpacityToHex = convertOpacityToHex;
+/**
+ * * Applies an opacity value to a color string.
+ * @param color The color string to apply opacity to.
+ * @param opacity The opacity value as a percentage (0-100).
+ * @returns The color string with the opacity value applied.
+ */
+const applyOpacity = (color, opacity) => {
+    return color.concat(opacity);
+};
+exports.applyOpacity = applyOpacity;

package/dist/colors/index.d.ts

@@ -0,0 +1,25 @@
+import type { ColorInput, ColorInputArray, OpacityValue } from './types';
+/**
+ *  * Generates a hex color based on the first character of a string or number.
+ *
+ * - For numbers, it uses 10 predefined colors (0-9).
+ * - For letters, it uses 26 predefined colors (A-Z).
+ * - Invalid characters handled with a fallback color.
+ * @param input - A string or number.
+ * @param opacity - A value from 0 to 100 representing the opacity percentage.
+ * @returns A hex color for the first character of the provided string/number.
+ */
+export declare function getColorForFirstCharacter(input?: ColorInput, opacity?: OpacityValue): string;
+/**
+ *  * Generates an array of hex colors based on the first character of an array of strings/numbers or even nested arrays of strings/numbers.
+ *
+ * - For numbers, it uses 10 predefined colors (0-9).
+ * - For letters, it uses 26 predefined colors (A-Z).
+ * - For empty array it returns all 36 colors.
+ * - Invalid characters and inputs are handled with a fallback color.
+ * @param input - A string, number, or an array of strings/numbers or even nested arrays of strings/numbers.
+ * @param opacity - A value from 0 to 100 representing the opacity percentage.
+ * @returns A hex color for a string/number, or an array of hex colors for each element of the provided array.
+ */
+export declare function getColorForFirstCharacter(input: ColorInputArray, opacity?: OpacityValue): string[];
+//# sourceMappingURL=index.d.ts.map

package/dist/colors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/colors/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGzE;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACxC,KAAK,CAAC,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,YAAY,GACpB,MAAM,CAAC;AAEV;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CACxC,KAAK,EAAE,eAAe,EACtB,OAAO,CAAC,EAAE,YAAY,GACpB,MAAM,EAAE,CAAC"}

package/dist/colors/index.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getColorForFirstCharacter = getColorForFirstCharacter;
+const helpers_1 = require("./helpers");
+const constants_1 = require("./constants");
+/**
+ *  * Generates an array of hex colors based on the first character of an array of strings/numbers or even nested arrays of strings/numbers.
+ *
+ * - For numbers, it uses 10 predefined colors (0-9).
+ * - For letters, it uses 26 predefined colors (A-Z).
+ * - For empty array it returns all 36 colors.
+ * - Invalid characters and inputs are handled with a fallback color.
+ * @param input - A string, number, or an array of strings/numbers or even nested arrays of strings/numbers.
+ * @param opacity - A value from 0 to 100 representing the opacity percentage.
+ * @returns A hex color for a string/number, or an array of hex colors for each element of the provided array.
+ */
+function getColorForFirstCharacter(input = '', opacity = 100) {
+    let initial;
+    const hexOpacity = (0, helpers_1.convertOpacityToHex)(opacity);
+    const numbers = '0123456789';
+    // Handle empty string case
+    if (!input)
+        return (0, helpers_1.applyOpacity)('#010514', hexOpacity);
+    // Handle string input
+    if (typeof input === 'string') {
+        initial = input[0];
+        // Handle number as string
+        if (numbers.includes(initial)) {
+            return (0, helpers_1.applyOpacity)(constants_1.numberColorPalette[parseInt(initial, 10)], hexOpacity);
+        }
+        const upperInitial = initial.toUpperCase();
+        const index = upperInitial.charCodeAt(0) - 'A'.charCodeAt(0);
+        // Validate alphabet
+        if (index >= 0 && index < constants_1.alphabetColorPalette.length) {
+            return (0, helpers_1.applyOpacity)(constants_1.alphabetColorPalette[index], hexOpacity);
+        }
+        return (0, helpers_1.applyOpacity)('#010514', hexOpacity);
+        // Handle number input
+    }
+    else if (typeof input === 'number' && !isNaN(input)) {
+        initial = input.toString()[0];
+        if (numbers.includes(initial)) {
+            return (0, helpers_1.applyOpacity)(constants_1.numberColorPalette[parseInt(initial, 10)], hexOpacity);
+        }
+        return (0, helpers_1.applyOpacity)('#010514', hexOpacity);
+        // Handle array of strings/numbers
+    }
+    else if (Array.isArray(input)) {
+        if (input.length < 1)
+            return [...constants_1.alphabetColorPalette, ...constants_1.numberColorPalette].map((color) => (0, helpers_1.applyOpacity)(color, hexOpacity));
+        return input
+            .map((el) => {
+            if (Array.isArray(el)) {
+                return getColorForFirstCharacter(el, opacity);
+            }
+            return getColorForFirstCharacter(el, opacity);
+        })
+            .flat();
+    }
+    return (0, helpers_1.applyOpacity)('#010514', hexOpacity);
+}

package/dist/colors/types.d.ts

@@ -0,0 +1,7 @@
+/** - A string, number for generating color. */
+export type ColorInput = string | number;
+/** - An array of strings/numbers or nested arrays of strings/numbers for generating colors. */
+export type ColorInputArray = (ColorInput | ColorInputArray)[];
+/** - Opacity options */
+export type OpacityValue = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100;
+//# sourceMappingURL=types.d.ts.map

package/dist/colors/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/colors/types.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC,+FAA+F;AAC/F,MAAM,MAAM,eAAe,GAAG,CAAC,UAAU,GAAG,eAAe,CAAC,EAAE,CAAC;AAE/D,wBAAwB;AACxB,MAAM,MAAM,YAAY,GACrB,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,GAAG,CAAC"}

package/dist/colors/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export { capitalizeString } from './string';
+export { capitalizeString, truncateString, generateRandomID } from './string';
+export { getColorForFirstCharacter } from './colors';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalizeString = void 0;
+exports.getColorForFirstCharacter = exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
 var string_1 = require("./string");
 Object.defineProperty(exports, "capitalizeString", { enumerable: true, get: function () { return string_1.capitalizeString; } });
+Object.defineProperty(exports, "truncateString", { enumerable: true, get: function () { return string_1.truncateString; } });
+Object.defineProperty(exports, "generateRandomID", { enumerable: true, get: function () { return string_1.generateRandomID; } });
+var colors_1 = require("./colors");
+Object.defineProperty(exports, "getColorForFirstCharacter", { enumerable: true, get: function () { return colors_1.getColorForFirstCharacter; } });

package/dist/string/index.d.ts

@@ -1,6 +1,6 @@
-import type { CapitalizeOptions, RandomIDOptions } from './types';
+import type { CapitalizeOptions, RandomIdOptions } from './types';
 /**
- * Utility to convert the first letter of any string to uppercase and the rest lowercase (unless specified).
+ * * Utility to convert the first letter of any string to uppercase and the rest lowercase (unless specified).
  * Handles surrounding symbols like quotes or parentheses.
  *
  * @param string String to be capitalized.
@@ -9,7 +9,7 @@ import type { CapitalizeOptions, RandomIDOptions } from './types';
  */
 export declare const capitalizeString: (string: string, options?: CapitalizeOptions) => string;
 /**
- * Utility to truncate a string to a specified length.
+ * * Utility to truncate a string to a specified length.
  *
  * @param string The string to truncate.
  * @param maxLength The maximum length of the truncated string.
@@ -17,10 +17,10 @@ export declare const capitalizeString: (string: string, options?: CapitalizeOpti
  */
 export declare const truncateString: (string: string, maxLength: number) => string;
 /**
- * Generates a unique ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `separator`, and a random alphanumeric string, separated by a customizable separator.
+ * * Generates a unique ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `separator`, and a random alphanumeric string, separated by a customizable separator.
  *
  * @param options Configuration options for random ID generation.
- * @returns The generated ID string composed of the prefix, timestamp, random alphanumeric string, and suffix, separated by the specified separator.
+ * @returns The generated ID string composed of the random alphanumeric string, timestamp, prefix, and suffix, separated by the specified separator.
  */
-export declare const generateRandomID: (options?: RandomIDOptions) => string;
+export declare const generateRandomID: (options?: RandomIdOptions) => string;
 //# sourceMappingURL=index.d.ts.map

package/dist/string/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
 /**
- * Utility to convert the first letter of any string to uppercase and the rest lowercase (unless specified).
+ * * Utility to convert the first letter of any string to uppercase and the rest lowercase (unless specified).
  * Handles surrounding symbols like quotes or parentheses.
  *
  * @param string String to be capitalized.
@@ -41,7 +41,7 @@ const capitalizeString = (string, options) => {
 };
 exports.capitalizeString = capitalizeString;
 /**
- * Utility to truncate a string to a specified length.
+ * * Utility to truncate a string to a specified length.
  *
  * @param string The string to truncate.
  * @param maxLength The maximum length of the truncated string.
@@ -61,13 +61,13 @@ const truncateString = (string, maxLength) => {
 };
 exports.truncateString = truncateString;
 /**
- * Generates a unique ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `separator`, and a random alphanumeric string, separated by a customizable separator.
+ * * Generates a unique ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `separator`, and a random alphanumeric string, separated by a customizable separator.
  *
  * @param options Configuration options for random ID generation.
- * @returns The generated ID string composed of the prefix, timestamp, random alphanumeric string, and suffix, separated by the specified separator.
+ * @returns The generated ID string composed of the random alphanumeric string, timestamp, prefix, and suffix, separated by the specified separator.
  */
 const generateRandomID = (options) => {
-    const { prefix = '', suffix = '', timeStamp = true, length = 13, separator = '.', caseOption = null, } = options || {};
+    const { prefix = '', suffix = '', timeStamp = false, length = 16, separator = '', caseOption = null, } = options || {};
     // generate timestamp
     const date = timeStamp ? Date.now() : '';
     // Generate a random string of alphanumeric characters

package/dist/string/types.d.ts

@@ -1,4 +1,4 @@
-/** Options for capitalizeString function. */
+/** - Options for capitalizeString function. */
 export interface CapitalizeOptions {
     /** If true, capitalizes the first letter of each word (space separated). Defaults to `false`. */
     capitalizeEachFirst?: boolean;
@@ -7,17 +7,17 @@ export interface CapitalizeOptions {
     /** If true, ensures that the rest of the string is lowercase. Defaults to `true`. */
     lowerCaseRest?: boolean;
 }
-/** Configuration options for ID generation. */
-export interface RandomIDOptions {
+/** - Configuration options for ID generation. */
+export interface RandomIdOptions {
     /** A string to prepend to the ID. Default is an empty string. */
     prefix?: string;
     /** A string to append to the ID. Default is an empty string.*/
     suffix?: string;
-    /** Whether to include the current timestamp in the ID. Default is `true`. */
+    /** Whether to include the current timestamp in the ID. Default is `false`. */
     timeStamp?: boolean;
-    /** The length of the random alphanumeric string. Default is `13`. */
+    /** The length of the random alphanumeric string. Default is `16`. */
     length?: number;
-    /** The separator to use between parts of the ID. Default is a `period (.)`. */
+    /** The separator to use between parts of the ID. Default is an empty string. */
     separator?: string;
     /** Specifies the case for the random alphanumeric string. */
     caseOption?: 'upper' | 'lower' | null;

package/dist/string/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/string/types.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IACjC,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC/B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;CACtC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/string/types.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,MAAM,WAAW,iBAAiB;IACjC,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,iDAAiD;AACjD,MAAM,WAAW,eAAe;IAC/B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;CACtC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "description": "A versatile collection of smart, efficient, and reusable utility functions for everyday development needs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",