@qrvey/utils 1.3.0-5 → 1.3.0-6

package/bitbucket-pipelines.yml

@@ -1,4 +1,4 @@
-image: node:16.14
+image: node:lts-gallium
 
 pipelines:
   default:

package/dist/cjs/column_format/helpers/columnTypeByChart.d.ts

@@ -13,4 +13,4 @@ import { IChartShelfType } from "../interfaces/IChartShelfType";
  * grouped.
  * @returns The column type of the column.
  */
-export declare const columnTypeByChart: (column: IChartColumn, shelfType: IChartShelfType, chartGroup: IChartGroupType, isGroupedTable?: boolean) => import("../..").COMPLEX_COLUMN | import("../..").COMPOUND_COLUMN | NUMERICAL_COLUMN | COLUMN.SINGLE_CHOICE | COLUMN.MULTIPLE_CHOICE | COLUMN.YES_NO | COLUMN.RANKING | COLUMN.DATE | COLUMN.SIGNATURE | COLUMN.DROPDOWN | COLUMN.IMAGE | COLUMN.EMAIL_FORM | COLUMN.PHONE | COLUMN.PASSWORD | COLUMN.CHECKLIST | COLUMN.NPS_SCORE | COLUMN.NPS_FEEDBACK | COLUMN.TEXT_LABEL | COLUMN.TEXT_CATEGORY | COLUMN.LOOKUP | COLUMN.HEADLINE | COLUMN.SECTION | COLUMN.AGGREGATED_FORMULA | COLUMN.BUCKET | COLUMN.SLIDEBAR | COLUMN.NUMERIC | COLUMN.NUMERICC | COLUMN.NUMERICP | COLUMN.NUMERICG | COLUMN.RATING | COLUMN.TEXTFIELD | COLUMN.LONGTEXT | COLUMN.IMAGEUPLOAD | COLUMN.FILEUPLOAD | COLUMN.EXPRESSION | COLUMN.NAME | COLUMN.USADDRESS | COLUMN.ADDRESS | "DATE" | "NUMERIC" | "TEXT_LABEL";
+export declare const columnTypeByChart: (column: IChartColumn, shelfType: IChartShelfType, chartGroup: IChartGroupType, isGroupedTable?: boolean) => "DATE" | "NUMERIC" | "TEXT_LABEL" | import("../..").COMPLEX_COLUMN | import("../..").COMPOUND_COLUMN | NUMERICAL_COLUMN | COLUMN.SINGLE_CHOICE | COLUMN.MULTIPLE_CHOICE | COLUMN.YES_NO | COLUMN.RANKING | COLUMN.DATE | COLUMN.SIGNATURE | COLUMN.DROPDOWN | COLUMN.IMAGE | COLUMN.EMAIL_FORM | COLUMN.PHONE | COLUMN.PASSWORD | COLUMN.CHECKLIST | COLUMN.NPS_SCORE | COLUMN.NPS_FEEDBACK | COLUMN.TEXT_LABEL | COLUMN.TEXT_CATEGORY | COLUMN.LOOKUP | COLUMN.HEADLINE | COLUMN.SECTION | COLUMN.AGGREGATED_FORMULA | COLUMN.BUCKET | COLUMN.SLIDEBAR | COLUMN.NUMERIC | COLUMN.NUMERICC | COLUMN.NUMERICP | COLUMN.NUMERICG | COLUMN.RATING | COLUMN.TEXTFIELD | COLUMN.LONGTEXT | COLUMN.IMAGEUPLOAD | COLUMN.FILEUPLOAD | COLUMN.EXPRESSION | COLUMN.NAME | COLUMN.USADDRESS | COLUMN.ADDRESS;

package/dist/cjs/general/array/addPropertyToArrayOfObjects.d.ts

@@ -0,0 +1,22 @@
+/**
+ * It takes an array of objects, adds a property to each object, and returns the new array.
+ * @param {Object} info - Information needed to add property to the array of objects.
+ * @param {Array} info.array - The array of objects you want to add a property to.
+ * @param {string} info.property - The property you want to add to the object.
+ * @param {any} info.value - - The value to be added to the array of objects.
+ * ----------------------------------------------------------------------------------------------
+ * @example <caption>Example usage of addPropertyToArrayOfObjects.</caption>
+ * addPropertyToArrayOfObjects({
+ * 	array: [{ name: "John", lastName: "Doe" }, { name: "Chris", lastName: "Musk" }],
+ * 	property: "lastName",
+ * 	value: 'Peck'
+ * });
+ * @returns the new array created.
+ */
+export declare function addPropertyToArrayOfObjects(obj: AddPropertyToArrayOfObjectsParams): any[];
+declare type AddPropertyToArrayOfObjectsParams = {
+    array: any[];
+    property: string;
+    value: any;
+};
+export {};

package/dist/cjs/general/array/addPropertyToArrayOfObjects.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPropertyToArrayOfObjects = void 0;
+const isEmpty_1 = require("../mix/isEmpty");
+const isObject_1 = require("../object/isObject");
+/**
+ * It takes an array of objects, adds a property to each object, and returns the new array.
+ * @param {Object} info - Information needed to add property to the array of objects.
+ * @param {Array} info.array - The array of objects you want to add a property to.
+ * @param {string} info.property - The property you want to add to the object.
+ * @param {any} info.value - - The value to be added to the array of objects.
+ * ----------------------------------------------------------------------------------------------
+ * @example <caption>Example usage of addPropertyToArrayOfObjects.</caption>
+ * addPropertyToArrayOfObjects({
+ * 	array: [{ name: "John", lastName: "Doe" }, { name: "Chris", lastName: "Musk" }],
+ * 	property: "lastName",
+ * 	value: 'Peck'
+ * });
+ * @returns the new array created.
+ */
+function addPropertyToArrayOfObjects(obj) {
+    if ((0, isEmpty_1.isEmpty)(obj) || !(0, isObject_1.isObject)(obj))
+        return [];
+    const { array, property, value } = obj;
+    if (Array.isArray(array)) {
+        if ((0, isEmpty_1.isEmpty)(array) || (0, isEmpty_1.isEmpty)(property))
+            return array;
+        return array.map((element) => (Object.assign(Object.assign({}, element), { [property]: value })));
+    }
+    return [];
+}
+exports.addPropertyToArrayOfObjects = addPropertyToArrayOfObjects;

package/dist/cjs/general/array/index.d.ts

@@ -1,3 +1,4 @@
+export * from './addPropertyToArrayOfObjects';
 export * from './delete';
 export * from './flattenDeep';
 export * from './filterNestedTree';

package/dist/cjs/general/array/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./addPropertyToArrayOfObjects"), exports);
 __exportStar(require("./delete"), exports);
 __exportStar(require("./flattenDeep"), exports);
 __exportStar(require("./filterNestedTree"), exports);

package/dist/general/array/addPropertyToArrayOfObjects.d.ts

@@ -0,0 +1,22 @@
+/**
+ * It takes an array of objects, adds a property to each object, and returns the new array.
+ * @param {Object} info - Information needed to add property to the array of objects.
+ * @param {Array} info.array - The array of objects you want to add a property to.
+ * @param {string} info.property - The property you want to add to the object.
+ * @param {any} info.value - - The value to be added to the array of objects.
+ * ----------------------------------------------------------------------------------------------
+ * @example <caption>Example usage of addPropertyToArrayOfObjects.</caption>
+ * addPropertyToArrayOfObjects({
+ * 	array: [{ name: "John", lastName: "Doe" }, { name: "Chris", lastName: "Musk" }],
+ * 	property: "lastName",
+ * 	value: 'Peck'
+ * });
+ * @returns the new array created.
+ */
+export declare function addPropertyToArrayOfObjects(obj: AddPropertyToArrayOfObjectsParams): any[];
+declare type AddPropertyToArrayOfObjectsParams = {
+    array: any[];
+    property: string;
+    value: any;
+};
+export {};

package/dist/general/array/addPropertyToArrayOfObjects.js

@@ -0,0 +1,28 @@
+import { isEmpty } from '../mix/isEmpty';
+import { isObject } from '../object/isObject';
+/**
+ * It takes an array of objects, adds a property to each object, and returns the new array.
+ * @param {Object} info - Information needed to add property to the array of objects.
+ * @param {Array} info.array - The array of objects you want to add a property to.
+ * @param {string} info.property - The property you want to add to the object.
+ * @param {any} info.value - - The value to be added to the array of objects.
+ * ----------------------------------------------------------------------------------------------
+ * @example <caption>Example usage of addPropertyToArrayOfObjects.</caption>
+ * addPropertyToArrayOfObjects({
+ * 	array: [{ name: "John", lastName: "Doe" }, { name: "Chris", lastName: "Musk" }],
+ * 	property: "lastName",
+ * 	value: 'Peck'
+ * });
+ * @returns the new array created.
+ */
+export function addPropertyToArrayOfObjects(obj) {
+    if (isEmpty(obj) || !isObject(obj))
+        return [];
+    const { array, property, value } = obj;
+    if (Array.isArray(array)) {
+        if (isEmpty(array) || isEmpty(property))
+            return array;
+        return array.map((element) => (Object.assign(Object.assign({}, element), { [property]: value })));
+    }
+    return [];
+}

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

@@ -1,3 +1,4 @@
+export * from './addPropertyToArrayOfObjects';
 export * from './delete';
 export * from './flattenDeep';
 export * from './filterNestedTree';

package/dist/general/array/index.js

@@ -1,3 +1,4 @@
+export * from './addPropertyToArrayOfObjects';
 export * from './delete';
 export * from './flattenDeep';
 export * from './filterNestedTree';

package/jest.config.js

@@ -1,4 +1,5 @@
 module.exports = {
+  preset: 'ts-jest',
   testEnvironment: 'node',
   verbose: true,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.3.0-5",
+  "version": "1.3.0-6",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",
@@ -21,15 +21,16 @@
   "author": "Qrvey Inc",
   "license": "MIT",
   "devDependencies": {
+    "@compodoc/compodoc": "1.1.19",
+    "@types/jest": "27.5.0",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0",
     "eslint": "8.14.0",
     "jest": "27.5.1",
     "np": "7.6.1",
+    "ts-jest": "27.1.4",
     "typedoc": "0.22.15",
-    "typescript": "4.6.4",
-    "@compodoc/compodoc": "1.1.19",
-    "@types/jest": "27.4.1",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0"
+    "typescript": "4.6.4"
   },
   "dependencies": {
     "d3": "6.3.1",

package/src/general/array/addPropertyToArrayOfObjects.ts

@@ -0,0 +1,32 @@
+import { isEmpty } from '../mix/isEmpty';
+import { isObject } from '../object/isObject';
+
+/**
+ * It takes an array of objects, adds a property to each object, and returns the new array.
+ * @param {Object} info - Information needed to add property to the array of objects.
+ * @param {Array} info.array - The array of objects you want to add a property to.
+ * @param {string} info.property - The property you want to add to the object.
+ * @param {any} info.value - - The value to be added to the array of objects.
+ * ----------------------------------------------------------------------------------------------
+ * @example <caption>Example usage of addPropertyToArrayOfObjects.</caption>
+ * addPropertyToArrayOfObjects({
+ * 	array: [{ name: "John", lastName: "Doe" }, { name: "Chris", lastName: "Musk" }],
+ * 	property: "lastName",
+ * 	value: 'Peck'
+ * });
+ * @returns the new array created.
+ */
+export function addPropertyToArrayOfObjects(obj: AddPropertyToArrayOfObjectsParams): any[] {
+	if (isEmpty(obj) || !isObject(obj)) return [];
+	const { array, property, value } = obj;
+	if (Array.isArray(array)) {
+		if (isEmpty(array) || isEmpty(property)) return array;
+		return array.map((element) => ({ ...element, [property]: value }));
+	}
+	return [];
+}
+type AddPropertyToArrayOfObjectsParams = {
+	array: any[];
+	property: string;
+	value: any;
+};

package/src/general/array/index.ts

@@ -1,3 +1,4 @@
+export * from './addPropertyToArrayOfObjects';
 export * from './delete';
 export * from './flattenDeep';
 export * from './filterNestedTree';

package/test/general/array/addPropertyToArrayOfObjects.test.js

@@ -0,0 +1,96 @@
+const { addPropertyToArrayOfObjects } = require('../../../dist/cjs');
+
+describe('Testing undefined argument', function () {
+	test('no argument passed', function () {
+		const validation = addPropertyToArrayOfObjects();
+		expect(validation).toEqual([]);
+	});
+
+	test('Undefined argument', function () {
+		const validation = addPropertyToArrayOfObjects(undefined);
+		expect(validation).toEqual([]);
+	});
+
+	test('Null argument', function () {
+		const validation = addPropertyToArrayOfObjects(null);
+		expect(validation).toEqual([]);
+	});
+});
+
+describe('Testing no-object argument', function () {
+	const scenarios1 = 1;
+	const scenarios2 = false;
+	const scenarios4 = 'Hello World';
+	const scenarios5 = ['Hello', 'World'];
+
+	test('Numeric variable', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios1);
+		expect(validation).toEqual([]);
+	});
+
+	test('Boolean variable', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios2);
+		expect(validation).toEqual([]);
+	});
+
+	test('String variable', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios4);
+		expect(validation).toEqual([]);
+	});
+
+	test('Array variable', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios5);
+		expect(validation).toEqual([]);
+	});
+});
+
+describe('Testing invalid object arguments', function () {
+	const scenarios1 = { array: undefined, property: 'lastName', value: 'Doe' };
+	const scenarios2 = { array: [{ name: 'Lebron', lastName: 'James' }], property: undefined, value: 'Doe' };
+
+	test('Empty Array', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios1);
+		expect(validation).toEqual([]);
+	});
+
+	test('Empty Property', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios2);
+		expect(validation).toEqual(scenarios2.array);
+	});
+});
+
+describe('Regular scenarios', function () {
+	const commonArray = [
+		{ name: 'John', lastName: 'Doe' },
+		{ name: 'Chris', lastName: 'Musk' },
+	];
+
+	const scenarios1 = { array: commonArray, property: 'name', value: 'Daniel' };
+	const scenarios2 = { array: commonArray, property: 'nationality', value: 'Colombian' };
+	const scenarios3 = { array: [{ name: 'Lebron', lastName: 'James' }], property: 'lastName', value: undefined };
+
+	const expectedScenario1 = [
+		{ name: 'Daniel', lastName: 'Doe' },
+		{ name: 'Daniel', lastName: 'Musk' },
+	];
+	const expectedScenario2 = [
+		{ name: 'John', lastName: 'Doe', nationality: 'Colombian' },
+		{ name: 'Chris', lastName: 'Musk', nationality: 'Colombian' },
+	];
+	const expectedScenario3 = [{ name: 'Lebron', lastName: undefined }];
+
+	test('Scenario #1', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios1);
+		expect(validation).toEqual(expectedScenario1);
+	});
+
+	test('Scenario #2', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios2);
+		expect(validation).toEqual(expectedScenario2);
+	});
+
+	test('Scenario #3', function () {
+		const validation = addPropertyToArrayOfObjects(scenarios3);
+		expect(validation).toEqual(expectedScenario3);
+	});
+});

package/test/tokens/{isTokenLabel.test.js → isTokenLabel.test.ts}

@@ -1,129 +1,129 @@
-const { isTokenLabel } = require("../../dist/cjs");
+import { isTokenLabel } from '../../src/tokens/isTokenLabel';
 
 describe('Testing undefined argument', function () {
     test('no argument passed', function () {
-        const validation = isTokenLabel();
+        const validation: boolean = isTokenLabel();
         expect(validation).toBeFalsy();
     });
 
     test('Undefined argument', function () {
-        const validation = isTokenLabel(undefined);
+        const validation: boolean = isTokenLabel(undefined);
         expect(validation).toBeFalsy();
     });
 
     test('Null argument', function () {
-        const validation = isTokenLabel(null);
+        const validation: boolean = isTokenLabel(null);
         expect(validation).toBeFalsy();
     });
 });
 
 describe('Testing no-string arguments', function () {
-    const variable1 = 1;
-    const variable2 = false;
-    const variable3 = new Date();
-    const variable4 = { const1: 'Hello', const2: 'World'};
-    const variable5 = ['Hello', 'World'];
+    const variable1: any = 1;
+    const variable2: any = false;
+    const variable3: any = new Date();
+    const variable4: any = { const1: 'Hello', const2: 'World'};
+    const variable5: any = ['Hello', 'World'];
 
     test('Numeric variable', function () {
-        const validation = isTokenLabel(variable1);
+        const validation: boolean = isTokenLabel(variable1);
         expect(validation).toBeFalsy();
     });
 
     test('Boolean variable', function () {
-        const validation = isTokenLabel(variable2);
+        const validation: boolean = isTokenLabel(variable2);
         expect(validation).toBeFalsy();
     });
 
     test('Date object variable', function () {
-        const validation = isTokenLabel(variable3);
+        const validation: boolean = isTokenLabel(variable3);
         expect(validation).toBeFalsy();
     });
 
     test('Object variable', function () {
-        const validation = isTokenLabel(variable4);
+        const validation: boolean = isTokenLabel(variable4);
         expect(validation).toBeFalsy();
     });
 
     test('Array variable', function () {
-        const validation = isTokenLabel(variable5);
+        const validation: boolean = isTokenLabel(variable5);
         expect(validation).toBeFalsy();
     });
 });
 
 describe('Testing invalid string argument', function () {
-    const variable1 = '';
-    const variable2 = 'Hello World';
-    const variable3 = '{}';
-    const variable4 = '{{}}';
-    const variable5 = '{{ }}';
-    const variable6 = '{{ Hello }}';
-    const variable7 = '{{Hello}';
-    const variable8 = '{{Hello}}{{World}}';
-    const variable9 = '{Hello}';
+    const variable1: string = '';
+    const variable2: string = 'Hello World';
+    const variable3: string = '{}';
+    const variable4: string = '{{}}';
+    const variable5: string = '{{ }}';
+    const variable6: string = '{{ Hello }}';
+    const variable7: string = '{{Hello}';
+    const variable8: string = '{{Hello}}{{World}}';
+    const variable9: string = '{Hello}';
     
     test('Empty string', function () {
-        const validation = isTokenLabel(variable1);
+        const validation: boolean = isTokenLabel(variable1);
         expect(validation).toBeFalsy();
     });
 
     test('Non-empty and regular string', function () {
-        const validation = isTokenLabel(variable2);
+        const validation: boolean = isTokenLabel(variable2);
         expect(validation).toBeFalsy();
     });
 
     test('Single curly brackets and empty label', function () {
-        const validation = isTokenLabel(variable3);
+        const validation: boolean = isTokenLabel(variable3);
         expect(validation).toBeFalsy();
     });
 
     test('Double curly brackets and empty label', function () {
-        const validation = isTokenLabel(variable4);
+        const validation: boolean = isTokenLabel(variable4);
         expect(validation).toBeFalsy();
     });
 
     test('Double curly brackets and space between them', function () {
-        const validation = isTokenLabel(variable5);
+        const validation: boolean = isTokenLabel(variable5);
         expect(validation).toBeFalsy();
     });
 
     test('Double curly brackets and non-empty label with space between them', function () {
-        const validation = isTokenLabel(variable6);
+        const validation: boolean = isTokenLabel(variable6);
         expect(validation).toBeFalsy();
     });
 
     test('Double left and single right curly brackets and non-empty label', function () {
-        const validation = isTokenLabel(variable7);
+        const validation: boolean = isTokenLabel(variable7);
         expect(validation).toBeFalsy();
     });
 
     test('Two data tokens in a single string', function () {
-        const validation = isTokenLabel(variable8);
+        const validation: boolean = isTokenLabel(variable8);
         expect(validation).toBeFalsy();
     });
 
     test('Single curly brackets and non-empty label', function () {
-        const validation = isTokenLabel(variable9);
+        const validation: boolean = isTokenLabel(variable9);
         expect(validation).toBeFalsy();
     });
 });
 
 describe('Regular scenarios', function () {
-    const variable1 = '{{NOW}}';
-    const variable2 = '{{LAST_YEAR_END}}';
-    const variable3 = '{{data.marathonparatooltips-cambiodesorting.FECHA.avg}}';
+    const variable1: string = '{{NOW}}';
+    const variable2: string = '{{LAST_YEAR_END}}';
+    const variable3: string = '{{data.marathonparatooltips-cambiodesorting.FECHA.avg}}';
     
     test('Scenario #1', function () {
-        const validation = isTokenLabel(variable1);
+        const validation: boolean = isTokenLabel(variable1);
         expect(validation).toBeTruthy();
     });
 
     test('Scenario #2', function () {
-        const validation = isTokenLabel(variable2);
+        const validation: boolean = isTokenLabel(variable2);
         expect(validation).toBeTruthy();
     });
 
     test('Scenario #3', function () {
-        const validation = isTokenLabel(variable3);
+        const validation: boolean = isTokenLabel(variable3);
         expect(validation).toBeTruthy();
     });
 });

package/tsconfig.json

@@ -63,4 +63,7 @@
     /* Advanced Options */
     "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
   },
+  "exclude": [
+    "test"
+  ]
 }