nhb-toolbox 1.0.1 → 1.0.2

package/dist/array/index.d.ts

@@ -1,4 +1,4 @@
-import type { Flatten, SelectOptions } from './types';
+import type { Flattened, ConfigOptions, OptionInput } from './types';
 /**
  * * Flattens a nested array recursively or wraps any non-array data type in an array.
  *
@@ -6,15 +6,14 @@ import type { Flatten, SelectOptions } from './types';
  * @param input - The input value, which can be a nested array or a non-array value.
  * @returns A fully flattened array of type `Flatten<T>`. If the input is not an array, it wraps it in a single-element array.
  */
-export declare const flattenArray: <T>(input: T | T[]) => Flatten<T>[];
+export declare const flattenArray: <T>(input: T | T[]) => Flattened<T>[];
 /**
- * * Converts an array of objects into a formatted array of select options.
+ * * Converts an array of objects into a formatted array of options.
  *
  * @typeParam T - The type of each object in the `data` array.
- * @param data - An array of objects to convert into select options.
- * @param valueKey - The key in each object to use as the `value` field in the select options.
- * @param labelKey - The key in each object to use as the `label` field in the select options.
- * @returns An array of select options, where each option has a `value` and `label` field.
+ * @param data - An array of objects to convert into options.
+ * @param config - The configuration object to specify the keys for the `value` (firstFieldName) and `label` (secondFieldName) fields and rename as needed.
+ * @returns An array of options, where each option has `value` and `label` fields as default or as specified by user in the config options.
  */
-export declare const createSelectOptions: <T extends Record<string, string | number | null | undefined>>(data: T[], valueKey: keyof T, labelKey: keyof T) => SelectOptions[];
+export declare const createOptionsArray: <T extends OptionInput, K1 extends string = "value", K2 extends string = "label">(data: T[], config: ConfigOptions<T, K1, K2>) => { [P in K1 | K2]: string; }[];
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAG,OAAO,CAAC,CAAC,CAAC,EAO1D,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,GAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,QAEtD,CAAC,EAAE,YACC,MAAM,CAAC,YACP,MAAM,CAAC,KACf,aAAa,EASf,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAErE;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAG,SAAS,CAAC,CAAC,CAAC,EAO5D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC9B,CAAC,SAAS,WAAW,EACrB,EAAE,SAAS,MAAM,YACjB,EAAE,SAAS,MAAM,kBAEX,CAAC,EAAE,UACD,aAAa,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,KAC9B,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAE,EAe5B,CAAC"}

package/dist/array/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSelectOptions = exports.flattenArray = void 0;
+exports.createOptionsArray = exports.flattenArray = void 0;
 /**
  * * Flattens a nested array recursively or wraps any non-array data type in an array.
  *
@@ -18,23 +18,23 @@ const flattenArray = (input) => {
 };
 exports.flattenArray = flattenArray;
 /**
- * * Converts an array of objects into a formatted array of select options.
+ * * Converts an array of objects into a formatted array of options.
  *
  * @typeParam T - The type of each object in the `data` array.
- * @param data - An array of objects to convert into select options.
- * @param valueKey - The key in each object to use as the `value` field in the select options.
- * @param labelKey - The key in each object to use as the `label` field in the select options.
- * @returns An array of select options, where each option has a `value` and `label` field.
+ * @param data - An array of objects to convert into options.
+ * @param config - The configuration object to specify the keys for the `value` (firstFieldName) and `label` (secondFieldName) fields and rename as needed.
+ * @returns An array of options, where each option has `value` and `label` fields as default or as specified by user in the config options.
  */
-const createSelectOptions = (data, valueKey, labelKey) => {
+const createOptionsArray = (data, config) => {
+    const { firstFieldKey, secondFieldKey, firstFieldName = 'value', secondFieldName = 'label', } = config || {};
     if (data && data.length) {
         return data.map((datum) => ({
-            value: String(datum[valueKey] ?? ''),
-            label: String(datum[labelKey] ?? ''),
+            [firstFieldName]: String(datum[firstFieldKey] ?? ''),
+            [secondFieldName]: String(datum[secondFieldKey] ?? ''),
         }));
     }
     else {
         return [];
     }
 };
-exports.createSelectOptions = createSelectOptions;
+exports.createOptionsArray = createOptionsArray;

package/dist/array/types.d.ts

@@ -1,9 +1,37 @@
 /** - Flatten Array */
-export type Flatten<T> = T extends (infer U)[] ? Flatten<U> : T;
-/** - Select Options */
-export interface SelectOptions {
-    value: string;
-    label: string;
-}
+export type Flattened<T> = T extends (infer U)[] ? Flattened<U> : T;
 /**  */
+export type OptionInput = Record<string, string | number | null | undefined>;
+/**
+ * - Configuration for `createOptionsArray`.
+ * - Defines the mapping between keys in the input objects and the keys in the output options.
+ *
+ * @typeParam T - The type of the objects in the input array.
+ * @typeParam K1 - The name of the key for the first field in the output (default: `'value'`).
+ * @typeParam K2 - The name of the key for the second field in the output (default: `'label'`).
+ */
+export interface ConfigOptions<T extends Record<string, string | number | null | undefined>, K1 extends string = 'value', K2 extends string = 'label'> {
+    /**
+     * - The key in the input objects to use for the first field of the option.
+     * @example If the input objects have an `id` field and you want to use it as the `value` field in the output, set createOptionsArray(data, {firstFieldKey: 'id'}).
+     */
+    firstFieldKey: keyof T;
+    /**
+     * - The key in the input objects to use for the second field of the option.
+     * @example If the input objects have a `name` field and you want to use it as the `label` field in the output, set createOptionsArray(data, {firstFieldKey: 'id', secondFieldKey: 'name'}).
+     */
+    secondFieldKey: keyof T;
+    /**
+     * - The name of the first field in the output object.
+     * - Defaults to `'value'`.
+     * @example If you want the output field to be named `'key'` instead of `'value'`, set createOptionsArray(data, {firstFieldKey: 'id', secondFieldKey: 'name', firstFieldName: 'key'}).
+     */
+    firstFieldName?: K1;
+    /**
+     * - The name of the second field in the output object.
+     * - Defaults to `'label'`.
+     * @example If you want the output field to be named `'title'` instead of `'label'`, set createOptionsArray(data, {firstFieldKey: 'id', secondFieldKey: 'name', firstFieldName: 'key', secondFieldName: 'title'}).
+     */
+    secondFieldName?: K2;
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/array/types.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAEhE,uBAAuB;AACvB,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACd;AAED,OAAO"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/array/types.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAEpE,OAAO;AACP,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAE7E;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAC7B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAC5D,EAAE,SAAS,MAAM,GAAG,OAAO,EAC3B,EAAE,SAAS,MAAM,GAAG,OAAO;IAE3B;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAE,CAAC;IAEpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,EAAE,CAAC;CACrB"}

package/dist/array/types.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/**  */
-// export interface 

package/dist/index.d.ts

@@ -3,6 +3,6 @@ export { getRandomNumber, convertToDecimal } from './number';
 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 { flattenArray, createOptionsArray, } from './array';
 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,WAAW,EACX,WAAW,EACX,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,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,EACN,YAAY,EACZ,kBAAkB,GAClB,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"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.countObjectFields = exports.isEmptyObject = exports.mergeAndFlattenObjects = exports.flattenObject = exports.mergeObjects = exports.isDeepEqual = exports.cloneObject = exports.generateQueryParams = exports.createOptionsArray = 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; } });
@@ -21,7 +21,7 @@ Object.defineProperty(exports, "convertRgbToHex", { enumerable: true, get: funct
 Object.defineProperty(exports, "convertRgbToHsl", { enumerable: true, get: function () { return convert_1.convertRgbToHsl; } });
 var array_1 = require("./array");
 Object.defineProperty(exports, "flattenArray", { enumerable: true, get: function () { return array_1.flattenArray; } });
-Object.defineProperty(exports, "createSelectOptions", { enumerable: true, get: function () { return array_1.createSelectOptions; } });
+Object.defineProperty(exports, "createOptionsArray", { enumerable: true, get: function () { return array_1.createOptionsArray; } });
 var object_1 = require("./object");
 Object.defineProperty(exports, "generateQueryParams", { enumerable: true, get: function () { return object_1.generateQueryParams; } });
 Object.defineProperty(exports, "cloneObject", { enumerable: true, get: function () { return object_1.cloneObject; } });

package/dist/number/types.d.ts

@@ -9,7 +9,7 @@ export interface RandomNumberOptions {
     /** Whether to include the maximum number. */
     includeMax?: boolean;
 }
-/** Decimal options for converting to decimal */
+/** - Decimal options for converting to decimal */
 export interface DecimalOptions {
     /** Number of decimal places to round to. Defaults to `2`. */
     decimalPlaces?: number;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/number/types.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,MAAM,WAAW,mBAAmB;IACnC,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,gDAAgD;AAChD,MAAM,WAAW,cAAc;IAC9B,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/number/types.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,MAAM,WAAW,mBAAmB;IACnC,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC9B,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/package.json

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