@qrvey/utils 1.2.5 → 1.2.9-0

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.5*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-0*
 
 > 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/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/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/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
 
 
@@ -1201,6 +1538,26 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 
 
 
+### dist/filters/classes/FilterInputErrorHandler.js
+
+
+#### new FilterInputErrorHandler() 
+
+
+
+
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### dist/filters/helpers/applyHierarchyForAggFilters.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
 
 
@@ -2233,49 +2619,47 @@ Get an string of the properties of the given column.
 
 
 
-### dist/services/api/getAllDatasets.api.js
-
+### dist/stencil/decorators/Config.js
 
-#### getAllDatasets(qrveyids) 
-
-Get a dataset list from a collection of Qrvey IDs
 
+#### Config() 
 
+Stencil.js - Prop Decorator
+Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
+But for this, is required ask for a property in `snake_case` style
 
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
 
 
 
+##### Examples
 
-##### Returns
+```javascript
+\ @Config() @Prop() settings;
 
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 
--  a promise
 
+##### Returns
 
 
+- `Void`
 
-### dist/services/api/getAllQrveys.api.js
 
 
-#### getAllQrveys(config, params) 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+### dist/stencil/util/createRef.js
 
 
+#### createRef() 
 
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
 
 
 
@@ -2283,17 +2667,21 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
 
 
-- `Void`
+-  function - Function to use in ref prop in html elements
 
 
 
 
-### dist/services/api/getDatasetColumns.api.js
+### dist/stencil/util/getConfig.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### getConfig(cfg) 
 
-Get a dataset by Qrvey ID
+verify the Config object type and try to return a parsed Object
+- In case _cfg_ is a string, first try to make a JSON parse in other case
+try to find this string as a variable on Windows object
+- If _cfg_ is a fuction, tis is invoked and parsed
+- Finally, if is an object, _cfg_ is inmediatly returned
 
 
 
@@ -2302,7 +2690,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| cfg |  |  |   |
 
 
 
@@ -2310,74 +2698,72 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
-
+- `Void`
 
 
 
-### dist/stencil/decorators/Config.js
 
+### dist/services/api/getAllDatasets.api.js
 
-#### Config() 
 
-Stencil.js - Prop Decorator
-Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
-But for this, is required ask for a property in `snake_case` style
+#### getAllDatasets(qrveyids) 
 
+Get a dataset list from a collection of Qrvey IDs
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| qrveyids |  | Collection of Qrvey IDs |   |
 
-```javascript
-\ @Config() @Prop() settings;
 
-someMethod() {
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-}
-```
 
 
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
 
-### dist/stencil/util/createRef.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### createRef() 
+#### getAllQrveys(config, params) 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
+
+
 
 
 ##### Returns
 
 
--  function - Function to use in ref prop in html elements
+- `Void`
 
 
 
 
-### dist/stencil/util/getConfig.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getConfig(cfg) 
+#### getDatasetColumns(qrveyid) 
 
-verify the Config object type and try to return a parsed Object
-- In case _cfg_ is a string, first try to make a JSON parse in other case
-try to find this string as a variable on Windows object
-- If _cfg_ is a fuction, tis is invoked and parsed
-- Finally, if is an object, _cfg_ is inmediatly returned
+Get a dataset by Qrvey ID
 
 
 
@@ -2386,7 +2772,7 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2394,7 +2780,7 @@ try to find this string as a variable on Windows object
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
@@ -2844,260 +3230,8 @@ Returns a filter builder config object by a any given config
 ##### Parameters
 
 | Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | any config object |   |
-
-
-
-
-##### Returns
-
-
--  The filter builder config object
-
-
-
-
-### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
-
-
-#### excludeUIFiltersByAggregate(uFilters) 
-
-Excludes Aggregate Filters in the Flattened UI Filters array
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Collection of Flat UI Filters |   |
-
-
-
-
-##### Returns
-
-
--  a new Flat UI Filters that were excluded the aggregate filters
-
-
-
-
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
-
-
-#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
-
-Excludes and returns a UI Flat Filters without filters by the given scopes
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters |   |
-| scopes |  | collection of scopes types |   |
-
-
-
-
-##### Returns
-
-
--  The new array of UI Flattened filters
-
-
-
-
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
-
-
-#### getFilterPropertyLabel(filter) 
-
-Gets the label of the filter property
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter |   |
-
-
-
-
-##### Returns
-
-
--  a string of the filter property label
-
-
-
-
-### dist/filters/helpers/ui/getOutputFormatByColumn.js
-
-
-#### getOutputFormatByColumn(column, datasets) 
-
-Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
-| datasets |  | array of datasets |   |
-
-
-
-
-##### Returns
-
-
--  The output format object
-
-
-
-
-### dist/filters/helpers/ui/getUIFlatFilterByParams.js
-
-
-#### getUIFlatFilterByParams() 
-
-Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID,
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-
-
-
-
-
-
-##### Returns
-
-
--  The index of the uFilter array or the Filter object s
-
-
-
-
-### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
-
-
-#### getUIFlatFiltersByParams() 
-
-Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID,
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-- Enabled flags
-
-
-
-
-
-
-##### Returns
-
-
--  The index of the uFilter array or the Filter object s
-
-
-
-
-### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
-
-
-#### getUIFlatFiltersByScopes(uFilters, scopes) 
-
-Filters and gets a UI Flatten Filters by the given scopes
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters |   |
-| scopes |  | collection of scopes types |   |
-
-
-
-
-##### Returns
-
-
--  The new array of UI Flattened filters
-
-
-
-
-### dist/filters/helpers/ui/getUIValues.js
-
-
-#### getUIValues(filter, addEnableds, rankingGroupIndex) 
-
-
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  |  |   |
-| addEnableds |  |  |   |
-| rankingGroupIndex |  |  |   |
-
-
-
-
-##### Returns
-
-
--  
-
-
-
-
-### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
-
-
-#### resolveUIFlatFilterByParams(filter, params) 
-
-Resolves conditions between UI flattened filter and given parameters
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | UI Flatten Filter |   |
-| params |  | Parameters to validate |   |
+| ---- | ---- | ----------- | -------- |
+| config |  | any config object |   |
 
 
 
@@ -3105,7 +3239,7 @@ Resolves conditions between UI flattened filter and given parameters
 ##### Returns
 
 
--  true: the conditions are satisfied.
+-  The filter builder config object
 
 
 
@@ -3934,4 +4068,256 @@ Resolves the conditions by given params
 
 
 
+### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
+
+
+#### excludeUIFiltersByAggregate(uFilters) 
+
+Excludes Aggregate Filters in the Flattened UI Filters array
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Collection of Flat UI Filters |   |
+
+
+
+
+##### Returns
+
+
+-  a new Flat UI Filters that were excluded the aggregate filters
+
+
+
+
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+
+
+#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
+
+Excludes and returns a UI Flat Filters without filters by the given scopes
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
+
+
+
+
+##### Returns
+
+
+-  The new array of UI Flattened filters
+
+
+
+
+### dist/filters/helpers/ui/getFilterPropertyLabel.js
+
+
+#### getFilterPropertyLabel(filter) 
+
+Gets the label of the filter property
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  | The UI Filter |   |
+
+
+
+
+##### Returns
+
+
+-  a string of the filter property label
+
+
+
+
+### dist/filters/helpers/ui/getOutputFormatByColumn.js
+
+
+#### getOutputFormatByColumn(column, datasets) 
+
+Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| column |  | The column |   |
+| datasets |  | array of datasets |   |
+
+
+
+
+##### Returns
+
+
+-  The output format object
+
+
+
+
+### dist/filters/helpers/ui/getUIFlatFilterByParams.js
+
+
+#### getUIFlatFilterByParams() 
+
+Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
+The validation to filter the stored filter is depending on:
+- Column
+- Qrvey ID,
+- Scope type
+- Scope ID
+- Panel ID
+- Validator type
+- Property type
+
+
+
+
+
+
+##### Returns
+
+
+-  The index of the uFilter array or the Filter object s
+
+
+
+
+### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
+
+
+#### getUIFlatFiltersByParams() 
+
+Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
+The validation to filter the stored filter is depending on:
+- Column
+- Qrvey ID,
+- Scope type
+- Scope ID
+- Panel ID
+- Validator type
+- Property type
+- Enabled flags
+
+
+
+
+
+
+##### Returns
+
+
+-  The index of the uFilter array or the Filter object s
+
+
+
+
+### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
+
+
+#### getUIFlatFiltersByScopes(uFilters, scopes) 
+
+Filters and gets a UI Flatten Filters by the given scopes
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
+
+
+
+
+##### Returns
+
+
+-  The new array of UI Flattened filters
+
+
+
+
+### dist/filters/helpers/ui/getUIValues.js
+
+
+#### getUIValues(filter, addEnableds, rankingGroupIndex) 
+
+
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  |  |   |
+| addEnableds |  |  |   |
+| rankingGroupIndex |  |  |   |
+
+
+
+
+##### Returns
+
+
+-  
+
+
+
+
+### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
+
+
+#### resolveUIFlatFilterByParams(filter, params) 
+
+Resolves conditions between UI flattened filter and given parameters
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  | UI Flatten Filter |   |
+| params |  | Parameters to validate |   |
+
+
+
+
+##### Returns
+
+
+-  true: the conditions are satisfied.
+
+
+
+
 *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*