nhb-toolbox 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -4,5 +4,5 @@ export { getColorForFirstCharacter } from './colors';
 export { generateRandomColor } from './colors/random';
 export { convertHexToHsl, convertHexToRgb, convertHslToHex, convertHslToRgb, convertRgbToHex, convertRgbToHsl, } from './colors/convert';
 export { flattenArray, createSelectOptions } from './array';
-export { generateQueryParams, deepClone, deepEqual, mergeObjects, flattenObject, isEmptyObject, countObjectFields, } from './object';
+export { generateQueryParams, cloneObject, isDeepEqual, mergeObjects, flattenObject, mergeAndFlattenObjects, isEmptyObject, countObjectFields, } from './object';
 //# 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,cAAc,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EACN,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE5D,OAAO,EACN,mBAAmB,EACnB,SAAS,EACT,SAAS,EACT,YAAY,EACZ,aAAa,EACb,aAAa,EACb,iBAAiB,GACjB,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,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EACN,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE5D,OAAO,EACN,mBAAmB,EACnB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,iBAAiB,GACjB,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.countObjectFields = exports.isEmptyObject = exports.flattenObject = exports.mergeObjects = exports.deepEqual = exports.deepClone = exports.generateQueryParams = exports.createSelectOptions = exports.flattenArray = exports.convertRgbToHsl = exports.convertRgbToHex = exports.convertHslToRgb = exports.convertHslToHex = exports.convertHexToRgb = exports.convertHexToHsl = exports.generateRandomColor = exports.getColorForFirstCharacter = exports.convertToDecimal = exports.getRandomNumber = exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
+exports.countObjectFields = exports.isEmptyObject = exports.mergeAndFlattenObjects = exports.flattenObject = exports.mergeObjects = exports.isDeepEqual = exports.cloneObject = exports.generateQueryParams = exports.createSelectOptions = exports.flattenArray = exports.convertRgbToHsl = exports.convertRgbToHex = exports.convertHslToRgb = exports.convertHslToHex = exports.convertHexToRgb = exports.convertHexToHsl = exports.generateRandomColor = exports.getColorForFirstCharacter = exports.convertToDecimal = exports.getRandomNumber = 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; } });
@@ -24,9 +24,10 @@ Object.defineProperty(exports, "flattenArray", { enumerable: true, get: function
 Object.defineProperty(exports, "createSelectOptions", { enumerable: true, get: function () { return array_1.createSelectOptions; } });
 var object_1 = require("./object");
 Object.defineProperty(exports, "generateQueryParams", { enumerable: true, get: function () { return object_1.generateQueryParams; } });
-Object.defineProperty(exports, "deepClone", { enumerable: true, get: function () { return object_1.deepClone; } });
-Object.defineProperty(exports, "deepEqual", { enumerable: true, get: function () { return object_1.deepEqual; } });
+Object.defineProperty(exports, "cloneObject", { enumerable: true, get: function () { return object_1.cloneObject; } });
+Object.defineProperty(exports, "isDeepEqual", { enumerable: true, get: function () { return object_1.isDeepEqual; } });
 Object.defineProperty(exports, "mergeObjects", { enumerable: true, get: function () { return object_1.mergeObjects; } });
 Object.defineProperty(exports, "flattenObject", { enumerable: true, get: function () { return object_1.flattenObject; } });
+Object.defineProperty(exports, "mergeAndFlattenObjects", { enumerable: true, get: function () { return object_1.mergeAndFlattenObjects; } });
 Object.defineProperty(exports, "isEmptyObject", { enumerable: true, get: function () { return object_1.isEmptyObject; } });
 Object.defineProperty(exports, "countObjectFields", { enumerable: true, get: function () { return object_1.countObjectFields; } });

package/dist/object/index.d.ts

@@ -16,7 +16,7 @@ export declare const generateQueryParams: <T extends Record<string, string | num
  * @param obj Object to clone.
  * @returns Deep cloned object.
  */
-export declare const deepClone: <T extends Record<string, unknown>>(obj: T) => T;
+export declare const cloneObject: <T extends Record<string, unknown>>(obj: T) => T;
 /**
  * * Check if an object is empty.
  *
@@ -40,11 +40,20 @@ export declare const countObjectFields: <T extends Record<string, unknown>>(obj:
 export declare const mergeObjects: <T extends Record<string, unknown>>(...objects: T[]) => T;
 /**
  * * Deeply merge objects and flatten nested objects.
+ * * Useful for flattening a single object or merging multiple objects with duplicate key(s).
+ * * If keys are duplicated, the last object's value will be used.
  *
  * @param objects Objects to merge.
  * @returns Merged object with flattened structure.
  */
-export declare const flattenObject: <T extends Record<string, unknown>>(...objects: T[]) => T;
+export declare const mergeAndFlattenObjects: <T extends Record<string, unknown>>(...objects: T[]) => Record<string, unknown>;
+/**
+ * * Flattens a nested object into a dot notation format.
+ *
+ * @param object - The `object` to flatten.
+ * @returns A `flattened object` with dot notation keys.
+ */
+export declare const flattenObject: <T extends Record<string, unknown>>(object: T) => Record<string, unknown>;
 /**
  * * Deeply compare two values (arrays, objects, or primitive values).
  *
@@ -52,5 +61,5 @@ export declare const flattenObject: <T extends Record<string, unknown>>(...objec
  * @param b Second value to compare.
  * @returns Whether the values are deeply equal.
  */
-export declare const deepEqual: <T>(a: T, b: T) => boolean;
+export declare const isDeepEqual: <T>(a: T, b: T) => boolean;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/object/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,WAEvD,CAAC,KACP,MAkBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,KAAG,CAErE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OACzD,CAAC,KACJ,OAEF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAC7D,CAAC,KACJ,MAEF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,cACjD,CAAC,EAAE,KACb,CAuCF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,cAClD,CAAC,EAAE,KACb,CAyBF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAG,OAgCzC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/object/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,WAEvD,CAAC,KACP,MAkBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,KAAG,CAEvE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OACzD,CAAC,KACJ,OAEF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAC7D,CAAC,KACJ,MAEF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,cACjD,CAAC,EAAE,KACb,CAuCF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,cAC3D,CAAC,EAAE,KACb,MAAM,CAAC,MAAM,EAAE,OAAO,CA4BxB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,UACtD,CAAC,KACP,MAAM,CAAC,MAAM,EAAE,OAAO,CAgCxB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAG,OAgC3C,CAAC"}

package/dist/object/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepEqual = exports.flattenObject = exports.mergeObjects = exports.countObjectFields = exports.isEmptyObject = exports.deepClone = exports.generateQueryParams = void 0;
+exports.isDeepEqual = exports.flattenObject = exports.mergeAndFlattenObjects = exports.mergeObjects = exports.countObjectFields = exports.isEmptyObject = exports.cloneObject = exports.generateQueryParams = void 0;
 /**
  * * Utility function to generate query parameters from an object.
  *
@@ -28,10 +28,10 @@ exports.generateQueryParams = generateQueryParams;
  * @param obj Object to clone.
  * @returns Deep cloned object.
  */
-const deepClone = (obj) => {
+const cloneObject = (obj) => {
     return JSON.parse(JSON.stringify(obj));
 };
-exports.deepClone = deepClone;
+exports.cloneObject = cloneObject;
 /**
  * * Check if an object is empty.
  *
@@ -90,18 +90,20 @@ const mergeObjects = (...objects) => {
 exports.mergeObjects = mergeObjects;
 /**
  * * Deeply merge objects and flatten nested objects.
+ * * Useful for flattening a single object or merging multiple objects with duplicate key(s).
+ * * If keys are duplicated, the last object's value will be used.
  *
  * @param objects Objects to merge.
  * @returns Merged object with flattened structure.
  */
-const flattenObject = (...objects) => {
+const mergeAndFlattenObjects = (...objects) => {
     const map = new Map();
-    const flattenObject = (obj, parentKey = '') => {
+    const _flattenObject = (obj, parentKey = '') => {
         for (const key in obj) {
-            const newKey = parentKey ? `${parentKey}.${key}` : key;
+            const newKey = parentKey ? `${String(parentKey)}.${key}` : key;
             if (obj[key] instanceof Object && !Array.isArray(obj[key])) {
                 // Recursively flatten nested objects
-                flattenObject(obj[key], newKey);
+                _flattenObject(obj[key], newKey);
             }
             else {
                 // Set the flattened key
@@ -109,13 +111,47 @@ const flattenObject = (...objects) => {
             }
         }
     };
-    objects.forEach((obj) => flattenObject(obj));
+    objects.forEach((obj) => _flattenObject(obj));
     const result = {};
     map.forEach((value, key) => {
         result[key] = value;
     });
     return result;
 };
+exports.mergeAndFlattenObjects = mergeAndFlattenObjects;
+/**
+ * * Flattens a nested object into a dot notation format.
+ *
+ * @param object - The `object` to flatten.
+ * @returns A `flattened object` with dot notation keys.
+ */
+const flattenObject = (object) => {
+    /**
+     * * Recursively flattens an object, transforming nested structures into dot-notation keys.
+     *
+     * @param source - The `object` to be flattened.
+     * @param prefix - The prefix to prepend to each key. Used for nested objects.
+     * @returns A flattened version of the input object.
+     */
+    const _flattenObject = (source, prefix = '') => {
+        const flattened = {};
+        for (const [key, value] of Object.entries(source)) {
+            // Construct the dot-notation key
+            const newKey = prefix ? `${String(prefix)}.${key}` : key;
+            if (value && typeof value === 'object' && !Array.isArray(value)) {
+                // Recursively process nested objects
+                Object.assign(flattened, _flattenObject(value, newKey));
+            }
+            else {
+                // Directly assign non-object values
+                flattened[newKey] = value;
+            }
+        }
+        return flattened;
+    };
+    // Call the recursive function with an empty prefix initially
+    return _flattenObject(object);
+};
 exports.flattenObject = flattenObject;
 /**
  * * Deeply compare two values (arrays, objects, or primitive values).
@@ -124,7 +160,7 @@ exports.flattenObject = flattenObject;
  * @param b Second value to compare.
  * @returns Whether the values are deeply equal.
  */
-const deepEqual = (a, b) => {
+const isDeepEqual = (a, b) => {
     // If both values are strictly equal (handles primitive types and same references)
     if (a === b)
         return true;
@@ -138,7 +174,7 @@ const deepEqual = (a, b) => {
     if (Array.isArray(a) && Array.isArray(b)) {
         if (a.length !== b.length)
             return false;
-        return a.every((element, index) => (0, exports.deepEqual)(element, b[index]));
+        return a.every((element, index) => (0, exports.isDeepEqual)(element, b[index]));
     }
     // Check for object equality
     if (typeof a === 'object' && typeof b === 'object') {
@@ -146,8 +182,8 @@ const deepEqual = (a, b) => {
         const bKeys = Object.keys(b);
         if (aKeys.length !== bKeys.length)
             return false;
-        return aKeys.every((key) => (0, exports.deepEqual)(a[key], b[key]));
+        return aKeys.every((key) => (0, exports.isDeepEqual)(a[key], b[key]));
     }
     return false;
 };
-exports.deepEqual = deepEqual;
+exports.isDeepEqual = isDeepEqual;

package/package.json

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