@qrvey/utils 1.2.3 → 1.2.4-11

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.3*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-11*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -1340,12 +1340,15 @@ Inmutable Array Item deletion
 
 
 
-### dist/general/array/flattenDeep.js
+### dist/general/array/filterNestedTree.js
 
 
-#### flattenDeep(arr) 
+#### filterNestedTree(arr, childArrKey, condition) 
 
-Flat deeply an array
+Filters a nested tree array by a custom condition on the last child node
+- If the given arguments are not valid, the function returns the first argument.
+- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
+- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
 
 
 
@@ -1354,7 +1357,9 @@ Flat deeply an array
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply |   |
+| arr |  | nested tree array |   |
+| childArrKey |  | property representing the children array on the nested tree |   |
+| condition |  | function callback that determines if the filter is applied on the last child node of the nested tree |   |
 
 
 
@@ -1362,20 +1367,17 @@ Flat deeply an array
 ##### Returns
 
 
--  flatten array
+-  array filtered
 
 
 
 
-### dist/general/array/filterNestedTree.js
+### dist/general/array/flattenDeep.js
 
 
-#### filterNestedTree(arr, childArrKey, condition) 
+#### flattenDeep(arr) 
 
-Filters a nested tree array by a custom condition on the last child node
-- If the given arguments are not valid, the function returns the first argument.
-- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
-- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
+Flat deeply an array
 
 
 
@@ -1384,9 +1386,7 @@ Filters a nested tree array by a custom condition on the last child node
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | nested tree array |   |
-| childArrKey |  | property representing the children array on the nested tree |   |
-| condition |  | function callback that determines if the filter is applied on the last child node of the nested tree |   |
+| arr |  | Array to flat deeply |   |
 
 
 
@@ -1394,7 +1394,7 @@ Filters a nested tree array by a custom condition on the last child node
 ##### Returns
 
 
--  array filtered
+-  flatten array
 
 
 
@@ -1511,6 +1511,35 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 
 
 
+### dist/general/mix/compareDeep.js
+
+
+#### compareDeep(object1, object2) 
+
+Compares two objects to know if they are equals. Go across nested objects.
+Includes arrays in the comparison.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| object1 |  | First Object to compare |   |
+| object2 |  | Second Object to compare |   |
+
+
+
+
+##### Returns
+
+
+-  True: objects are equal. False: Objects are not equal. Undefined: invalid
+
+
+
+
 ### dist/general/mix/getTag.js
 
 
@@ -1738,12 +1767,13 @@ Gets the length of the given array.
 
 
 
-### dist/general/string/capitalize.js
+### dist/general/object/cloneDeep.js
 
 
-#### capitalize(text) 
+#### cloneDeep(obj) 
 
-Upper case the first letter of a given text
+A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
+Not to use this function with inner objects and functions
 
 
 
@@ -1752,7 +1782,7 @@ Upper case the first letter of a given text
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| text | `String`  |  |   |
+| obj |  | The object |   |
 
 
 
@@ -1760,7 +1790,7 @@ Upper case the first letter of a given text
 ##### Returns
 
 
-- `String`  a capitalized text
+-  The new reference object or the given object if the parsing is incorrect or empty
 
 
 
@@ -1822,34 +1852,6 @@ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
 
 
 
-### dist/general/object/cloneDeep.js
-
-
-#### cloneDeep(obj) 
-
-A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
-Not to use this function with inner objects and functions
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj |  | The object |   |
-
-
-
-
-##### Returns
-
-
--  The new reference object or the given object if the parsing is incorrect or empty
-
-
-
-
 ### dist/general/object/getAttribute.js
 
 
@@ -1989,6 +1991,83 @@ and return a mapped object
 
 
 
+### dist/general/object/mergeDeep.js
+
+
+#### mergeDeep(obj1, obj2, settings) 
+
+Merges two objects into a new one.
+The second given argument to the first given argument.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| obj1 |  | The target object |   |
+| obj2 |  | The object to be merged |   |
+| settings |  | Object settings for this function |   |
+
+
+
+
+##### Returns
+
+
+-  a new merged object
+
+
+
+#### isValid(obj1, obj2) 
+
+Validates if the two arguments are objects
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| obj1 |  | The target object |   |
+| obj2 |  | The object to be merged |   |
+
+
+
+
+##### Returns
+
+
+-  true: they are valid; false: they are not
+
+
+
+#### getParamsToMergeDeep(settings) 
+
+Validates and gets the settings with all set parameters.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| settings |  | the settings object |   |
+
+
+
+
+##### Returns
+
+
+-  a new settings object with all set parameters.
+
+
+
+
 ### dist/general/object/objectCopy.js
 
 
@@ -2100,12 +2179,12 @@ serialize object to url param
 
 
 
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/general/string/capitalize.js
 
 
-#### getColumnLabels(column) 
+#### capitalize(text) 
 
-Get an string of the properties of the given column.
+Upper case the first letter of a given text
 
 
 
@@ -2114,7 +2193,7 @@ Get an string of the properties of the given column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
+| text | `String`  |  |   |
 
 
 
@@ -2122,17 +2201,17 @@ Get an string of the properties of the given column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+- `String`  a capitalized text
 
 
 
 
-### dist/services/api/getAllQrveys.api.js
+### dist/services/api/getAllDatasets.api.js
 
 
-#### getAllQrveys(config, params) 
+#### getAllDatasets(qrveyids) 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+Get a dataset list from a collection of Qrvey IDs
 
 
 
@@ -2141,8 +2220,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
+| qrveyids |  | Collection of Qrvey IDs |   |
 
 
 
@@ -2150,17 +2228,17 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
 
-### dist/services/api/getDatasetColumns.api.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### getAllQrveys(config, params) 
 
-Get a dataset by Qrvey ID
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
@@ -2169,7 +2247,8 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
 
 
@@ -2177,17 +2256,17 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
+- `Void`
 
 
 
 
-### dist/services/api/getAllDatasets.api.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getAllDatasets(qrveyids) 
+#### getDatasetColumns(qrveyid) 
 
-Get a dataset list from a collection of Qrvey IDs
+Get a dataset by Qrvey ID
 
 
 
@@ -2196,7 +2275,7 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2293,6 +2372,33 @@ try to find this string as a variable on Windows object
 
 
 
+### dist/qrvey/helpers/getColumnsLabel.js
+
+
+#### getColumnLabels(column) 
+
+Get an string of the properties of the given column.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| column |  | The column |   |
+
+
+
+
+##### Returns
+
+
+-  an string with the property, aggregate or calculation label.
+
+
+
+
 ### dist/typescript/decorators/Debounce.js
 
 

package/dist/charts/constants/AGGREGATE_INFO.d.ts

@@ -0,0 +1,5 @@
+import { IAggregateInfo } from "../interfaces/IAggregateInfo";
+import { IAggregateType } from "../interfaces/IAggregateType";
+export declare const AGGREGATE_INFO: {
+    [key in IAggregateType]: IAggregateInfo;
+};

package/dist/charts/constants/AGGREGATE_INFO_LIST.d.ts

@@ -0,0 +1 @@
+export declare const AGGREGATE_INFO_LIST: import("..").IAggregateInfo[];

package/dist/charts/constants/AGGREGATE_LABEL.d.ts

@@ -0,0 +1,11 @@
+export declare enum AGGREGATE_LABEL {
+    NONE = "None",
+    AVG = "Average",
+    MEDIAN = "Median",
+    MIN = "Minimum",
+    MAX = "Maximum",
+    SUM = "Sum",
+    STDEV = "Standard deviation",
+    COUNT = "Count",
+    DISTINCTCOUNT = "Distinct Count"
+}

package/dist/charts/constants/AGGREGATE_LABEL.js

@@ -0,0 +1,12 @@
+export var AGGREGATE_LABEL;
+(function (AGGREGATE_LABEL) {
+    AGGREGATE_LABEL["NONE"] = "None";
+    AGGREGATE_LABEL["AVG"] = "Average";
+    AGGREGATE_LABEL["MEDIAN"] = "Median";
+    AGGREGATE_LABEL["MIN"] = "Minimum";
+    AGGREGATE_LABEL["MAX"] = "Maximum";
+    AGGREGATE_LABEL["SUM"] = "Sum";
+    AGGREGATE_LABEL["STDEV"] = "Standard deviation";
+    AGGREGATE_LABEL["COUNT"] = "Count";
+    AGGREGATE_LABEL["DISTINCTCOUNT"] = "Distinct Count";
+})(AGGREGATE_LABEL || (AGGREGATE_LABEL = {}));

package/dist/charts/constants/index.d.ts

@@ -0,0 +1,5 @@
+export * from './AGGREGATE_ABBREVIATION';
+export * from './AGGREGATE_INFO_LIST';
+export * from './AGGREGATE_INFO';
+export * from './AGGREGATE_LABEL';
+export * from './AGGREGATE';

package/dist/charts/constants/index.js

@@ -0,0 +1,5 @@
+export * from './AGGREGATE_ABBREVIATION';
+export * from './AGGREGATE_INFO_LIST';
+export * from './AGGREGATE_INFO';
+export * from './AGGREGATE_LABEL';
+export * from './AGGREGATE';

package/dist/charts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants/index';
+export * from './interfaces/index';

package/dist/charts/index.js

@@ -0,0 +1,2 @@
+export * from './constants/index';
+export * from './interfaces/index';

package/dist/charts/interfaces/IAggregateAbbreviation.d.ts

@@ -0,0 +1,2 @@
+import { AGGREGATE_ABBREVIATION } from "../constants/AGGREGATE_ABBREVIATION";
+export declare type IAggregateAbbreviation = AGGREGATE_ABBREVIATION;

package/dist/charts/interfaces/IAggregateInfo.d.ts

@@ -0,0 +1,9 @@
+import { IGeneralInfo } from "../../interfaces/general/IGeneralInfo";
+import { IAggregateAbbreviation } from "./IAggregateAbbreviation";
+import { IAggregateLabel } from "./IAggregateLabel";
+import { IAggregateType } from "./IAggregateType";
+export interface IAggregateInfo extends IGeneralInfo {
+    abbrLabel: IAggregateAbbreviation;
+    label: IAggregateLabel;
+    value: IAggregateType;
+}

package/dist/charts/interfaces/IAggregateLabel.d.ts

@@ -0,0 +1,2 @@
+import { AGGREGATE_LABEL } from "../constants/AGGREGATE_LABEL";
+export declare type IAggregateLabel = AGGREGATE_LABEL;

package/dist/{cjs/qrvey/interfaces/IAggregate.d.ts → charts/interfaces/IAggregateType.d.ts}

@@ -1,2 +1,2 @@
 import { AGGREGATE } from "../constants/AGGREGATE";
-export declare type IAggregate = AGGREGATE;
+export declare type IAggregateType = AGGREGATE;

package/dist/charts/interfaces/index.d.ts

@@ -0,0 +1,4 @@
+export * from './IAggregateAbbreviation';
+export * from './IAggregateInfo';
+export * from './IAggregateLabel';
+export * from './IAggregateType';

package/dist/charts/interfaces/index.js

@@ -0,0 +1,4 @@
+export * from './IAggregateAbbreviation';
+export * from './IAggregateInfo';
+export * from './IAggregateLabel';
+export * from './IAggregateType';

package/dist/cjs/charts/constants/AGGREGATE_INFO.d.ts

@@ -0,0 +1,5 @@
+import { IAggregateInfo } from "../interfaces/IAggregateInfo";
+import { IAggregateType } from "../interfaces/IAggregateType";
+export declare const AGGREGATE_INFO: {
+    [key in IAggregateType]: IAggregateInfo;
+};

package/dist/cjs/charts/constants/AGGREGATE_INFO_LIST.d.ts

@@ -0,0 +1 @@
+export declare const AGGREGATE_INFO_LIST: import("..").IAggregateInfo[];

package/dist/cjs/charts/constants/AGGREGATE_LABEL.d.ts

@@ -0,0 +1,11 @@
+export declare enum AGGREGATE_LABEL {
+    NONE = "None",
+    AVG = "Average",
+    MEDIAN = "Median",
+    MIN = "Minimum",
+    MAX = "Maximum",
+    SUM = "Sum",
+    STDEV = "Standard deviation",
+    COUNT = "Count",
+    DISTINCTCOUNT = "Distinct Count"
+}

package/dist/cjs/charts/constants/AGGREGATE_LABEL.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AGGREGATE_LABEL = void 0;
+var AGGREGATE_LABEL;
+(function (AGGREGATE_LABEL) {
+    AGGREGATE_LABEL["NONE"] = "None";
+    AGGREGATE_LABEL["AVG"] = "Average";
+    AGGREGATE_LABEL["MEDIAN"] = "Median";
+    AGGREGATE_LABEL["MIN"] = "Minimum";
+    AGGREGATE_LABEL["MAX"] = "Maximum";
+    AGGREGATE_LABEL["SUM"] = "Sum";
+    AGGREGATE_LABEL["STDEV"] = "Standard deviation";
+    AGGREGATE_LABEL["COUNT"] = "Count";
+    AGGREGATE_LABEL["DISTINCTCOUNT"] = "Distinct Count";
+})(AGGREGATE_LABEL = exports.AGGREGATE_LABEL || (exports.AGGREGATE_LABEL = {}));

package/dist/cjs/charts/constants/index.d.ts

@@ -0,0 +1,5 @@
+export * from './AGGREGATE_ABBREVIATION';
+export * from './AGGREGATE_INFO_LIST';
+export * from './AGGREGATE_INFO';
+export * from './AGGREGATE_LABEL';
+export * from './AGGREGATE';

package/dist/cjs/charts/constants/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./AGGREGATE_ABBREVIATION"), exports);
+__exportStar(require("./AGGREGATE_INFO_LIST"), exports);
+__exportStar(require("./AGGREGATE_INFO"), exports);
+__exportStar(require("./AGGREGATE_LABEL"), exports);
+__exportStar(require("./AGGREGATE"), exports);

package/dist/cjs/charts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants/index';
+export * from './interfaces/index';

package/dist/cjs/{globalization/filters → charts}/index.js

@@ -10,6 +10,5 @@ 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("./FILTER_BUILDER"), exports);
-__exportStar(require("./SLIDEBAR"), exports);
-__exportStar(require("./VALUES_CONTAINER"), exports);
+__exportStar(require("./constants/index"), exports);
+__exportStar(require("./interfaces/index"), exports);

package/dist/cjs/charts/interfaces/IAggregateAbbreviation.d.ts

@@ -0,0 +1,2 @@
+import { AGGREGATE_ABBREVIATION } from "../constants/AGGREGATE_ABBREVIATION";
+export declare type IAggregateAbbreviation = AGGREGATE_ABBREVIATION;

package/dist/cjs/charts/interfaces/IAggregateInfo.d.ts

@@ -0,0 +1,9 @@
+import { IGeneralInfo } from "../../interfaces/general/IGeneralInfo";
+import { IAggregateAbbreviation } from "./IAggregateAbbreviation";
+import { IAggregateLabel } from "./IAggregateLabel";
+import { IAggregateType } from "./IAggregateType";
+export interface IAggregateInfo extends IGeneralInfo {
+    abbrLabel: IAggregateAbbreviation;
+    label: IAggregateLabel;
+    value: IAggregateType;
+}

package/dist/cjs/charts/interfaces/IAggregateLabel.d.ts

@@ -0,0 +1,2 @@
+import { AGGREGATE_LABEL } from "../constants/AGGREGATE_LABEL";
+export declare type IAggregateLabel = AGGREGATE_LABEL;

package/dist/{qrvey/interfaces/IAggregate.d.ts → cjs/charts/interfaces/IAggregateType.d.ts}

@@ -1,2 +1,2 @@
 import { AGGREGATE } from "../constants/AGGREGATE";
-export declare type IAggregate = AGGREGATE;
+export declare type IAggregateType = AGGREGATE;