nhb-toolbox 1.1.6 → 1.2.1

package/dist/index.d.ts

@@ -6,4 +6,5 @@ export { convertHexToHsl, convertHexToRgb, convertHslToHex, convertHslToRgb, con
 export { flattenArray, createOptionsArray, sortAnArray, filterArrayOfObjects, } from './array';
 export { generateQueryParams, cloneObject, isDeepEqual, mergeObjects, flattenObject, mergeAndFlattenObjects, isEmptyObject, countObjectFields, } from './object';
 export { sanitizeData } from './object/sanitize';
+export { convertObjectValues } from './object/convert';
 //# 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,EACN,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,UAAU,GACV,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C,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,EACN,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,oBAAoB,GACpB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACN,mBAAmB,EACnB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,iBAAiB,GACjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,UAAU,GACV,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C,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,EACN,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,oBAAoB,GACpB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACN,mBAAmB,EACnB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,iBAAiB,GACjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeData = exports.countObjectFields = exports.isEmptyObject = exports.mergeAndFlattenObjects = exports.flattenObject = exports.mergeObjects = exports.isDeepEqual = exports.cloneObject = exports.generateQueryParams = exports.filterArrayOfObjects = exports.sortAnArray = exports.createOptionsArray = exports.flattenArray = exports.convertRgbToHsl = exports.convertRgbToHex = exports.convertHslToRgb = exports.convertHslToHex = exports.convertHexToRgb = exports.convertHexToHsl = exports.generateRandomColor = exports.getColorForInitial = exports.convertToDecimal = exports.getRandomNumber = exports.trimString = exports.generateRandomID = exports.truncateString = exports.capitalizeString = void 0;
+exports.convertObjectValues = exports.sanitizeData = exports.countObjectFields = exports.isEmptyObject = exports.mergeAndFlattenObjects = exports.flattenObject = exports.mergeObjects = exports.isDeepEqual = exports.cloneObject = exports.generateQueryParams = exports.filterArrayOfObjects = exports.sortAnArray = exports.createOptionsArray = exports.flattenArray = exports.convertRgbToHsl = exports.convertRgbToHex = exports.convertHslToRgb = exports.convertHslToHex = exports.convertHexToRgb = exports.convertHexToHsl = exports.generateRandomColor = exports.getColorForInitial = exports.convertToDecimal = exports.getRandomNumber = exports.trimString = 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; } });
@@ -36,3 +36,5 @@ Object.defineProperty(exports, "isEmptyObject", { enumerable: true, get: functio
 Object.defineProperty(exports, "countObjectFields", { enumerable: true, get: function () { return object_1.countObjectFields; } });
 var sanitize_1 = require("./object/sanitize");
 Object.defineProperty(exports, "sanitizeData", { enumerable: true, get: function () { return sanitize_1.sanitizeData; } });
+var convert_2 = require("./object/convert");
+Object.defineProperty(exports, "convertObjectValues", { enumerable: true, get: function () { return convert_2.convertObjectValues; } });

package/dist/object/convert.d.ts

@@ -0,0 +1,57 @@
+import type { DotNotationKey, GenericObject, Numberified, Stringified } from './types';
+/**
+ * * Converts the values of specified keys in an object to strings.
+ * * Supports nested objects using dot-notation keys.
+ *
+ * @param data The object to convert.
+ * @param options Options object specifying the conversion mapping.
+ *   - `keys`: The keys in the object to be converted (dot-notation supported).
+ *   - `convertTo`: Must be "string".
+ * @returns The modified object with the converted values as strings.
+ */
+export declare function convertObjectValues<T extends GenericObject>(data: T, options: {
+    keys: DotNotationKey<T>[];
+    convertTo: 'string';
+}): Stringified<T>;
+/**
+ * * Converts the values of specified keys in an object to numbers.
+ * * Supports nested objects using dot-notation keys.
+ *
+ * @param data The object to convert.
+ * @param options Options object specifying the conversion mapping.
+ *   - `keys`: The keys in the object to be converted (dot-notation supported).
+ *   - `convertTo`: Must be "number".
+ * @returns The modified object with the converted values as numbers.
+ */
+export declare function convertObjectValues<T extends GenericObject>(data: T, options: {
+    keys: DotNotationKey<T>[];
+    convertTo: 'number';
+}): Numberified<T>;
+/**
+ * * Converts the values of specified keys in an array of objects to strings.
+ * * Supports nested objects using dot-notation keys.
+ *
+ * @param data The array of objects to convert.
+ * @param options Options object specifying the conversion mapping.
+ *   - `keys`: The keys in the objects to be converted (dot-notation supported).
+ *   - `convertTo`: Must be "string".
+ * @returns The modified array of objects with the converted values as strings.
+ */
+export declare function convertObjectValues<T extends GenericObject>(data: T[], options: {
+    keys: DotNotationKey<T>[];
+    convertTo: 'string';
+}): Stringified<T>[];
+/**
+ * * Converts the values of specified keys in an array of objects to numbers.
+ * * Supports nested objects using dot-notation keys.
+ * @param data The array of objects to convert.
+ * @param options Options object specifying the conversion mapping.
+ *   - `keys`: The keys in the objects to be converted (dot-notation supported).
+ *   - `convertTo`: Must be "number".
+ * @returns The modified array of objects with the converted values as numbers.
+ */
+export declare function convertObjectValues<T extends GenericObject>(data: T[], options: {
+    keys: DotNotationKey<T>[];
+    convertTo: 'number';
+}): Numberified<T>[];
+//# sourceMappingURL=convert.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../src/object/convert.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEX,cAAc,EACd,aAAa,EACb,WAAW,EACX,WAAW,EACX,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,aAAa,EAC1D,IAAI,EAAE,CAAC,EACP,OAAO,EAAE;IAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE,GACzD,WAAW,CAAC,CAAC,CAAC,CAAC;AAElB;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,aAAa,EAC1D,IAAI,EAAE,CAAC,EACP,OAAO,EAAE;IAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE,GACzD,WAAW,CAAC,CAAC,CAAC,CAAC;AAElB;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,aAAa,EAC1D,IAAI,EAAE,CAAC,EAAE,EACT,OAAO,EAAE;IAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE,GACzD,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AAEpB;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,aAAa,EAC1D,IAAI,EAAE,CAAC,EAAE,EACT,OAAO,EAAE;IAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE,GACzD,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC"}

package/dist/object/convert.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertObjectValues = convertObjectValues;
+/**
+ * * Converts the values of specified keys in an object or array of objects to either string or number.
+ * * Supports nested objects using dot-notation keys.
+ *
+ * @param data The object or array of objects to convert.
+ * @param options Options object specifying the conversion mapping.
+ *   - `keys`: The keys in the object to be converted (dot-notation supported).
+ *   - `convertTo`: The target type, either "string" or "number".
+ * @returns The modified object or array of objects with the converted values, with updated types.
+ */
+function convertObjectValues(data, options) {
+    const { keys, convertTo } = options;
+    /** * Helper function to determine if value should be preserved. */
+    const _shouldPreserveValue = (value) => convertTo === 'number' &&
+        typeof value === 'string' &&
+        isNaN(Number(value));
+    /** * Helper function to resolve a dot-notation key path and modify the corresponding value in the object. */
+    const _setValueAtPath = (obj, path, convertTo) => {
+        const segments = path.split('.');
+        let current = obj;
+        segments.forEach((key, index) => {
+            if (index === segments.length - 1) {
+                const value = current[key];
+                if (_shouldPreserveValue(value)) {
+                    return;
+                }
+                if (convertTo === 'string' && typeof value !== 'string') {
+                    current[key] = String(value);
+                }
+                else if (convertTo === 'number' &&
+                    typeof value !== 'number') {
+                    current[key] = Number(value);
+                }
+            }
+            else {
+                if (typeof current[key] === 'object' && current[key] !== null) {
+                    current = current[key];
+                }
+                else {
+                    current[key] = {};
+                    current = current[key];
+                }
+            }
+        });
+        return obj;
+    };
+    /** * Recursively process a single object. */
+    const convertValue = (obj) => {
+        let newObj = { ...obj };
+        keys.forEach((key) => {
+            newObj = _setValueAtPath(newObj, key, convertTo);
+        });
+        return newObj;
+    };
+    if (Array.isArray(data)) {
+        return data.map((d) => convertValue(d));
+    }
+    return convertValue(data);
+}

package/dist/object/types.d.ts

@@ -1,8 +1,8 @@
 /** - Generic object type */
 export type GenericObject = Record<string, unknown>;
-/** - Dot-notation keys for nested objects. */
-export type DotNotationKey<T> = T extends object ? {
-    [K in keyof T & string]: T[K] extends object ? K | `${K}.${DotNotationKey<T[K]>}` : K;
+/** - Dot-notation keys for nested objects */
+export type DotNotationKey<T> = T extends GenericObject ? {
+    [K in keyof T & string]: T[K] extends GenericObject ? `${K}` | `${K}.${DotNotationKey<T[K]>}` : `${K}`;
 }[keyof T & string] : never;
 /** - Options for `sanitizeData` */
 export interface SanitizeOptions<T extends GenericObject> {
@@ -15,6 +15,24 @@ export interface SanitizeOptions<T extends GenericObject> {
 }
 /** - Data after sanitization. */
 export type SanitizedData<T> = {
-    [P in keyof T]?: T[P] extends object ? SanitizedData<T[P]> : T[P];
+    [P in keyof T]?: T[P] extends GenericObject ? SanitizedData<T[P]> : T[P];
+};
+/** - Dot-notation keys for nested objects. */
+export type KeyConversion<T> = T extends GenericObject ? {
+    [K in keyof T & string]: K extends string ? T[K] extends GenericObject ? `${K}` | `${K}.${KeyConversion<T[K]>}` : `${K}` : never;
+}[keyof T & string] : never;
+/**
+ * * Determines the return type of `convertObjectValues` based on the `ConvertTo` type.
+ * @template T The object type.
+ * @template C The conversion type, either "string" or "number".
+ */
+export type ConvertedData<T, C extends 'string' | 'number'> = C extends 'string' ? Stringified<T> | Stringified<T>[] : T | T[];
+/** - Type of data value converted to `string` */
+export type Stringified<T> = {
+    [K in keyof T]: T[K] extends (infer U)[] ? Stringified<U>[] : T[K] extends object | null | undefined ? Stringified<T[K]> : T[K] extends string | number ? string : T[K];
+};
+/** - Type of data value converted to `number` */
+export type Numberified<T> = {
+    [K in keyof T]: T[K] extends (infer U)[] ? Numberified<U>[] : T[K] extends object | null | undefined ? Numberified<T[K]> : T[K] extends string ? number : T[K] extends number ? T[K] : number;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object/types.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD,8CAA8C;AAC9C,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC7C;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACzC,CAAC,GAAG,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAClC,CAAC;CACJ,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAClB,KAAK,CAAC;AAET,mCAAmC;AACnC,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,aAAa;IACvD,qBAAqB;IACrB,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACnC,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,iCAAiC;AACjC,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object/types.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD,6CAA6C;AAC7C,MAAM,MAAM,cAAc,CAAC,CAAC,IAC3B,CAAC,SAAS,aAAa,GACtB;KACE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,GAClD,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GACtC,GAAG,CAAC,EAAE;CACR,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAClB,KAAK,CAAC;AAET,mCAAmC;AACnC,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,aAAa;IACvD,qBAAqB;IACrB,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACnC,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,iCAAiC;AACjC,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACxE,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,aAAa,CAAC,CAAC,IAC1B,CAAC,SAAS,aAAa,GACtB;KACE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,SAAS,MAAM,GACxC,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,GACzB,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GACrC,GAAG,CAAC,EAAE,GACP,KAAK;CACP,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAClB,KAAK,CAAC;AAET;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,GAAG,QAAQ,IACzD,CAAC,SAAS,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;AAElE,iDAAiD;AACjD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GACzD,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC1D,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GACrC,CAAC,CAAC,CAAC,CAAC;CACN,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GACzD,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC1D,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAC5B,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAC1B,MAAM;CACR,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+/** Uncontrolled any to use for edge cases */
+export type UncontrolledAny = any;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,MAAM,eAAe,GAAG,GAAG,CAAC"}

package/dist/types/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "1.1.6",
+  "version": "1.2.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",