@qrvey/utils 1.2.6 → 1.2.9-1

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.6*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-1*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -80,6 +80,343 @@ Get a text and evaluate if it matchs with a token box label.
 
 
 
+### dist/dates/adapters/mdyDateToDate.js
+
+
+#### mdyDateToDate(monthYearDate, time) 
+
+Transforms String Date from a [mm/dd/yyyy] format to Date object.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| monthYearDate |  | String of [mm/dd/yyyy] date |   |
+| time |  | Flag to parse the object date to milliseconds. |   |
+
+
+
+
+##### Returns
+
+
+-  The date object or the date in milliseconds
+
+
+
+
+### dist/dates/adapters/monthYearToDate.js
+
+
+#### monthYearToDate(monthYearDate, time) 
+
+Transforms String Date from a [Month Year] format to Date object.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| monthYearDate |  | String of [Month Year] date |   |
+| time |  | Flag to parse the object date to milliseconds. |   |
+
+
+
+
+##### Returns
+
+
+-  The date object or the date in milliseconds
+
+
+
+
+### dist/dates/adapters/quarterYearToDate.js
+
+
+#### quarterYearToDate(quarterYearDate, time) 
+
+Transforms String Date from a [Quarter Year] format to Date object.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| quarterYearDate |  | String of [Quarter Year] date |   |
+| time |  | Flag to parse the object date to milliseconds. |   |
+
+
+
+
+##### Returns
+
+
+-  The date object or the date in milliseconds
+
+
+
+
+### dist/dates/adapters/weekYearToDate.js
+
+
+#### weekYearToDate(date, time) 
+
+Transforms String Date from a [Week Year] format to Date object.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date |  | String of [Week Year] date |   |
+| time |  | Flag to parse the object date to milliseconds. |   |
+
+
+
+
+##### Returns
+
+
+-  The date object or the date in milliseconds
+
+
+
+
+### dist/dates/adapters/yearToDate.js
+
+
+#### yearToDate(yearDate, time) 
+
+Transforms String Date from a [Year] format to Date object.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| yearDate |  | String of [Year] date |   |
+| time |  | Flag to parse the object date to milliseconds. |   |
+
+
+
+
+##### Returns
+
+
+-  The date object or the date in milliseconds
+
+
+
+
+### dist/dates/helpers/getDateFormatByProperty.js
+
+
+#### getDateFormatByProperty(property) 
+
+Gets the date format by the given property
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| property |  | The Column Property |   |
+
+
+
+
+##### Returns
+
+
+-  The date format
+
+
+
+
+### dist/dates/helpers/getDateByDateFormat.js
+
+
+#### getDateByDateFormat(date, format, time) 
+
+Gets a Date Object instance by a Date format
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date |  | String with a formatted date |   |
+| format |  | The date format |   |
+| time |  | flag to convert the formatted date to miliseconds |   |
+
+
+
+
+##### Returns
+
+
+-  a Date object, milisecond time or the same value if date format does not match.
+
+
+
+
+### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
+
+
+#### getDateFormatRegularExpressionInArray(dateFormat) 
+
+Gets an array of regular expressions by the given date format
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| dateFormat |  | the date format |   |
+
+
+
+
+##### Returns
+
+
+-  an array of regular expressions
+
+
+
+
+### dist/dates/helpers/getSeparatorByDateFormat.js
+
+
+#### getSeparatorByDateFormat(format) 
+
+Gets the separator of the date format
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| format |  | the date format |   |
+
+
+
+
+##### Returns
+
+
+-  a separator string
+
+
+
+
+### dist/dates/helpers/getWeek.js
+
+
+#### getWeek(date) 
+
+Gets the week number of the year
+Additionally, the month and the year
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date |  | the date object |   |
+
+
+
+
+##### Returns
+
+
+-  an object with the week, month and year.
+
+
+
+
+### dist/dates/helpers/validateDate.js
+
+
+#### validateDate(date, format) 
+
+Validate a string date depending on giving format
+- If the string is a token label, the function lets it pass.
+- Otherwise depends of the format
+- Some escenarios the string is a mix of token labels and dates
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date |  | String of date |   |
+| format |  | String of the format to validate |   |
+
+
+
+
+##### Returns
+
+
+-  True if it is valid or not. Undefined if date is undefined
+
+
+
+
+### dist/dates/helpers/validateDateByDateFormat.js
+
+
+#### validateDateByDateFormat(date, dateForma) 
+
+Validates the given string as Date by its date format.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date |  | a string to validate as date form |   |
+| dateForma |  | the format of the date to validate the string |   |
+
+
+
+
+##### Returns
+
+
+-  true: the string is a valida date
+
+
+
+
 ### dist/dates/range/getDateRange.js
 
 
@@ -351,6 +688,26 @@ Output:
 
 
 
+### dist/filters/classes/FilterInputErrorHandler.js
+
+
+#### new FilterInputErrorHandler() 
+
+
+
+
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### dist/filters/adapters/FDToFlatUI.js
 
 
@@ -1680,6 +2037,35 @@ Validates if the given argument is empty
 
 
 
+### dist/general/mix/isNaNV2.js
+
+
+#### isNaNV2(variable) 
+
+Validates if the recieved number is NaN type.
+This function recieves any variable but will return false.
+Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| variable |  | the variable to validate |   |
+
+
+
+
+##### Returns
+
+
+-  True if variable is a NaN or false otherwise
+
+
+
+
 ### dist/general/mix/isNull.js
 
 
@@ -1767,6 +2153,33 @@ Gets the length of the given array.
 
 
 
+### dist/general/string/capitalize.js
+
+
+#### capitalize(text) 
+
+Upper case the first letter of a given text
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| text | `String`  |  |   |
+
+
+
+
+##### Returns
+
+
+- `String`  a capitalized text
+
+
+
+
 ### dist/general/object/cloneDeep.js
 
 
@@ -2179,39 +2592,12 @@ serialize object to url param
 
 
 
-### dist/general/string/capitalize.js
-
-
-#### capitalize(text) 
-
-Upper case the first letter of a given text
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| text | `String`  |  |   |
-
-
-
-
-##### Returns
-
-
-- `String`  a capitalized text
-
-
-
-
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### getColumnLabels(column) 
+#### getAllQrveys(config, params) 
 
-Get an string of the properties of the given column.
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
@@ -2220,7 +2606,8 @@ Get an string of the properties of the given column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
 
 
@@ -2228,7 +2615,7 @@ Get an string of the properties of the given column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+- `Void`
 
 
 
@@ -2260,12 +2647,12 @@ Get a dataset list from a collection of Qrvey IDs
 
 
 
-### dist/services/api/getAllQrveys.api.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getAllQrveys(config, params) 
+#### getDatasetColumns(qrveyid) 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+Get a dataset by Qrvey ID
 
 
 
@@ -2274,8 +2661,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 |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2283,17 +2669,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/qrvey/helpers/getColumnsLabel.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### getColumnLabels(column) 
 
-Get a dataset by Qrvey ID
+Get an string of the properties of the given column.
 
 
 
@@ -2302,7 +2688,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| column |  | The column |   |
 
 
 
@@ -2310,7 +2696,7 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
+-  an string with the property, aggregate or calculation label.
 
 
 
@@ -2858,12 +3244,12 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### excludeFiltersByAggregateColumn(filterData) 
+#### areFiltersEquals(filter1, filter2) 
 
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
+Validates if both filters are the same
 
 
 
@@ -2872,7 +3258,8 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -2880,17 +3267,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 ##### Returns
 
 
--  The new filter data object that were excluded the aggregate filters
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Validates if both filters are the same
+Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
 
 
 
@@ -2899,8 +3286,7 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -2908,7 +3294,7 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  The new filter data object that were excluded the aggregate filters
 
 
 

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

@@ -0,0 +1,5 @@
+export declare enum AGGREGATE_GENERAL {
+    UNIQUE_VALUE = "Unique value",
+    AGGREGATE = "Aggregate",
+    TITLE = "Aggregation"
+}

package/dist/charts/constants/AGGREGATE_GENERAL.js

@@ -0,0 +1,6 @@
+export var AGGREGATE_GENERAL;
+(function (AGGREGATE_GENERAL) {
+    AGGREGATE_GENERAL["UNIQUE_VALUE"] = "Unique value";
+    AGGREGATE_GENERAL["AGGREGATE"] = "Aggregate";
+    AGGREGATE_GENERAL["TITLE"] = "Aggregation";
+})(AGGREGATE_GENERAL || (AGGREGATE_GENERAL = {}));

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/{qrvey → charts}/constants/AGGREGATE_INFO.js

@@ -2,13 +2,13 @@ import { AGGREGATE } from "./AGGREGATE";
 import { AGGREGATE_ABBREVIATION } from "./AGGREGATE_ABBREVIATION";
 import { AGGREGATE_LABEL } from "./AGGREGATE_LABEL";
 export const AGGREGATE_INFO = {
-    [AGGREGATE.NONE]: { value: AGGREGATE.NONE, displayed: true, label: AGGREGATE_LABEL.NONE, shortLabel: AGGREGATE_LABEL.NONE, abbrLabel: AGGREGATE_ABBREVIATION.NONE },
-    [AGGREGATE.AVG]: { value: AGGREGATE.AVG, displayed: true, label: AGGREGATE_LABEL.AVG, shortLabel: AGGREGATE_LABEL.AVG, abbrLabel: AGGREGATE_ABBREVIATION.AVG },
-    [AGGREGATE.MEDIAN]: { value: AGGREGATE.MEDIAN, displayed: true, label: AGGREGATE_LABEL.MEDIAN, shortLabel: AGGREGATE_LABEL.MEDIAN, abbrLabel: AGGREGATE_ABBREVIATION.MEDIAN },
-    [AGGREGATE.MIN]: { value: AGGREGATE.MIN, displayed: true, label: AGGREGATE_LABEL.MIN, shortLabel: AGGREGATE_LABEL.MIN, abbrLabel: AGGREGATE_ABBREVIATION.MIN },
-    [AGGREGATE.MAX]: { value: AGGREGATE.MAX, displayed: true, label: AGGREGATE_LABEL.MAX, shortLabel: AGGREGATE_LABEL.MAX, abbrLabel: AGGREGATE_ABBREVIATION.MAX },
-    [AGGREGATE.SUM]: { value: AGGREGATE.SUM, displayed: true, label: AGGREGATE_LABEL.SUM, shortLabel: AGGREGATE_LABEL.SUM, abbrLabel: AGGREGATE_ABBREVIATION.SUM },
-    [AGGREGATE.STDEV]: { value: AGGREGATE.STDEV, displayed: true, label: AGGREGATE_LABEL.STDEV, shortLabel: AGGREGATE_LABEL.STDEV, abbrLabel: AGGREGATE_ABBREVIATION.STDEV },
-    [AGGREGATE.COUNT]: { value: AGGREGATE.COUNT, displayed: true, label: AGGREGATE_LABEL.COUNT, shortLabel: AGGREGATE_LABEL.COUNT, abbrLabel: AGGREGATE_ABBREVIATION.COUNT },
-    [AGGREGATE.DISTINCTCOUNT]: { value: AGGREGATE.DISTINCTCOUNT, displayed: true, label: AGGREGATE_LABEL.DISTINCTCOUNT, shortLabel: AGGREGATE_LABEL.DISTINCTCOUNT, abbrLabel: AGGREGATE_ABBREVIATION.DISTINCTCOUNT },
+    [AGGREGATE.NONE]: { value: AGGREGATE.NONE, displayed: true, label: AGGREGATE_LABEL.NONE, shortLabel: AGGREGATE_LABEL.NONE, abbrLabel: AGGREGATE_ABBREVIATION.NONE, i18nLabelPath: 'common.aggregate_labels.none' },
+    [AGGREGATE.AVG]: { value: AGGREGATE.AVG, displayed: true, label: AGGREGATE_LABEL.AVG, shortLabel: AGGREGATE_LABEL.AVG, abbrLabel: AGGREGATE_ABBREVIATION.AVG, i18nLabelPath: 'common.aggregate_labels.avg' },
+    [AGGREGATE.MEDIAN]: { value: AGGREGATE.MEDIAN, displayed: true, label: AGGREGATE_LABEL.MEDIAN, shortLabel: AGGREGATE_LABEL.MEDIAN, abbrLabel: AGGREGATE_ABBREVIATION.MEDIAN, i18nLabelPath: 'common.aggregate_labels.meidan' },
+    [AGGREGATE.MIN]: { value: AGGREGATE.MIN, displayed: true, label: AGGREGATE_LABEL.MIN, shortLabel: AGGREGATE_LABEL.MIN, abbrLabel: AGGREGATE_ABBREVIATION.MIN, i18nLabelPath: 'common.aggregate_labels.min' },
+    [AGGREGATE.MAX]: { value: AGGREGATE.MAX, displayed: true, label: AGGREGATE_LABEL.MAX, shortLabel: AGGREGATE_LABEL.MAX, abbrLabel: AGGREGATE_ABBREVIATION.MAX, i18nLabelPath: 'common.aggregate_labels.max' },
+    [AGGREGATE.SUM]: { value: AGGREGATE.SUM, displayed: true, label: AGGREGATE_LABEL.SUM, shortLabel: AGGREGATE_LABEL.SUM, abbrLabel: AGGREGATE_ABBREVIATION.SUM, i18nLabelPath: 'common.aggregate_labels.sum' },
+    [AGGREGATE.STDEV]: { value: AGGREGATE.STDEV, displayed: true, label: AGGREGATE_LABEL.STDEV, shortLabel: AGGREGATE_LABEL.STDEV, abbrLabel: AGGREGATE_ABBREVIATION.STDEV, i18nLabelPath: 'common.aggregate_labels.stdev' },
+    [AGGREGATE.COUNT]: { value: AGGREGATE.COUNT, displayed: true, label: AGGREGATE_LABEL.COUNT, shortLabel: AGGREGATE_LABEL.COUNT, abbrLabel: AGGREGATE_ABBREVIATION.COUNT, i18nLabelPath: 'common.aggregate_labels.count' },
+    [AGGREGATE.DISTINCTCOUNT]: { value: AGGREGATE.DISTINCTCOUNT, displayed: true, label: AGGREGATE_LABEL.DISTINCTCOUNT, shortLabel: AGGREGATE_LABEL.DISTINCTCOUNT, abbrLabel: AGGREGATE_ABBREVIATION.DISTINCTCOUNT, i18nLabelPath: 'common.aggregate_labels.distinct_count' },
 };

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"
+}