npm - @qrvey/utils - Versions diffs - 1.2.4-13 → 1.2.4-17 - Mend

@qrvey/utils 1.2.4-13 → 1.2.4-17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (580) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-13*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-17*
 > Helper, Utils for all Qrvey Projects
@@ -80,12 +80,12 @@ Get a text and evaluate if it matchs with a token box label.
-### dist/dates/range/getDateRange.js
+### dist/dates/adapters/mdyDateToDate.js
-#### getDateRange(value, dateGroupLabel, withTime)
+#### mdyDateToDate(monthYearDate, time)
-Get date range object from a string date value
+Transforms String Date from a [mm/dd/yyyy] format to Date object.
@@ -94,58 +94,36 @@ Get date range object from a string date value
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value | `String`  | string date value | &nbsp; |
-| dateGroupLabel | `String`  | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
-| withTime | `Boolean`  | determines if the date range will include time. Default is true | &nbsp; |
+| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Examples
-```javascript
-// 1) Year:
-getDateRange('2020', 'YEAR');
-// Will return:
-{
-   from: '01/01/2020 00:00:00',
-   to: '12/31/2020 23:59:59'
-}
-// 2) Quarter:
-getDateRange('Q3 2020', 'QUARTER');
-// Will return:
-{
-   from: '07/01/2020 00:00:00',
-   to: '09/30/2020 23:59:59'
-}
+##### Returns
-// 3) Month:
-getDateRange('Oct 2020', 'MONTH');
-// Will return:
-{
-   from: '10/01/2020 00:00:00',
-   to: '10/31/2020 23:59:59'
-}
-```
+-  The date object or the date in milliseconds
-##### Returns
-- `Object`  an object with the date range with two string date properties: from and to
+### dist/dates/adapters/monthYearToDate.js
+#### monthYearToDate(monthYearDate, time)
-### dist/dates/relative/Adapter.js
+Transforms String Date from a [Month Year] format to Date object.
-#### value()
-Resolves statement and returns statement value
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| monthYearDate |  | String of [Month Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -153,47 +131,55 @@ Resolves statement and returns statement value
 ##### Returns
-- `AbsoluteRange` `string`
+-  The date object or the date in milliseconds
-#### valueAsAnchor()
-Resolves statement as an anchor
+### dist/dates/adapters/quarterYearToDate.js
+#### quarterYearToDate(quarterYearDate, time)
+Transforms String Date from a [Quarter Year] format to Date object.
-##### Returns
+##### Parameters
-- `string`
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| quarterYearDate |  | String of [Quarter Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-#### _statementToRange()  *private method*
-Convert verbal statement to range value
+##### Returns
+-  The date object or the date in milliseconds
-##### Returns
+### dist/dates/adapters/weekYearToDate.js
-- `AbsoluteRange`
+#### weekYearToDate(date, time)
+Transforms String Date from a [Week Year] format to Date object.
-#### _resolveAsThis()  *private method*
-Apply 'this' cursor logic to statement
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date |  | String of [Week Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -201,45 +187,45 @@ Apply 'this' cursor logic to statement
 ##### Returns
-- `AbsoluteStatement`
-#### _resolveAsTheLast()  *private method*
+-  The date object or the date in milliseconds
-Apply 'the last' cursor logic to statement
+### dist/dates/adapters/yearToDate.js
+#### yearToDate(yearDate, time)
-##### Returns
+Transforms String Date from a [Year] format to Date object.
-- `AbsoluteStatement`
+##### Parameters
-#### _resolveAsTheNext()  *private method*
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| yearDate |  | String of [Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-Apply 'the next' cursor logic to statement
+##### Returns
+-  The date object or the date in milliseconds
-##### Returns
-- `AbsoluteStatement`
+### dist/dates/helpers/getDateByDateFormat.js
-#### replaceNowToken(value, now)
+#### getDateByDateFormat(date, format, time)
-Replace '@now' token inside a string
+Gets a Date Object instance by a Date format
@@ -248,8 +234,9 @@ Replace '@now' token inside a string
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value | `string`  |  | &nbsp; |
-| now | `Date`  |  | &nbsp; |
+| date |  | String with a formatted date | &nbsp; |
+| format |  | The date format | &nbsp; |
+| time |  | flag to convert the formatted date to miliseconds | &nbsp; |
@@ -257,60 +244,44 @@ Replace '@now' token inside a string
 ##### Returns
-- `string`
+-  a Date object, milisecond time or the same value if date format does not match.
-#### convertRelativeToAbsolute(args)
-Returns a range object (date) from a group of statement params
+### dist/dates/helpers/getDateFormatByProperty.js
+#### getDateFormatByProperty(property)
+Gets the date format by the given property
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| args | `RelativeToAbsoluteStruct`  |  | &nbsp; |
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| property |  | The Column Property | &nbsp; |
-##### Examples
-```javascript
-pivot = '2021-03-03T12:30:40'
-unit = month
-steps = 2
-setTo = END
-resolverAsCalendar: true
-=> Returns  '2021-05-31T23:59:59'
-```
-```javascript
-pivot = '2021-03-03T12:30:40'
-unit = month
-steps = -2
-setTo = START
-resolverAsCalendar: false
-=> Returns '2021-01-03T00:00:00'
-```
 ##### Returns
-- `string`
+-  The date format
-### dist/dates/relative/relative.js
+### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
-#### resolveRelative(statements, clock)
+#### getDateFormatRegularExpressionInArray(dateFormat)
-Resolve a list of relative statements according to operator
+Gets an array of regular expressions by the given date format
@@ -319,44 +290,25 @@ Resolve a list of relative statements according to operator
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
-| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
+| dateFormat |  | the date format | &nbsp; |
-##### Examples
-```javascript
-Input:
-{
- "cursor": "the_next",
- "unit": "year",
- "number": 1,
- "includeCurrent": false,
- "isCalendarDate": false,
- "anchor": "03/05/2021"
-}
-Output:
-{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
-```
 ##### Returns
-- `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
+-  an array of regular expressions
-### dist/filters/adapters/FDToFlatUI.js
+### dist/dates/helpers/getSeparatorByDateFormat.js
-#### FDToFlatUI(filterData, datasetsInfo)
+#### getSeparatorByDateFormat(format)
-Generates a Flattened UI filter structure from Filter Data structure.
+Gets the separator of the date format
@@ -365,8 +317,7 @@ Generates a Flattened UI filter structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| format |  | the date format | &nbsp; |
@@ -374,13 +325,18 @@ Generates a Flattened UI filter structure from Filter Data structure.
 ##### Returns
--  a flattened UI filters array
+-  a separator string
-#### FD21ToFlatUI(scopes, datasetsInfo)
-Generates a Filter Builder Structure from the Filter Data structure v2.1
+### dist/dates/helpers/getWeek.js
+#### getWeek(date)
+Gets the week number of the year
+Additionally, the month and the year
@@ -389,8 +345,7 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| date |  | the date object | &nbsp; |
@@ -398,17 +353,20 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 ##### Returns
--  a flattened UI filters array
+-  an object with the week, month and year.
-### dist/filters/adapters/FDToLogic.js
+### dist/dates/helpers/validateDate.js
-#### FDToLogic(filterData)
+#### validateDate(date, format)
-Generates a Filter Logic structure from Filter Data structure.
+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
@@ -417,7 +375,8 @@ Generates a Filter Logic structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
+| date |  | String of date | &nbsp; |
+| format |  | String of the format to validate | &nbsp; |
@@ -425,13 +384,17 @@ Generates a Filter Logic structure from Filter Data structure.
 ##### Returns
--  a filter logic array
+-  True if it is valid or not. Undefined if date is undefined
-#### getLogicBodyFromFD21(filterData)
-Gets the logic body
+### dist/dates/helpers/validateDateByDateFormat.js
+#### validateDateByDateFormat(date, dateForma)
+Validates the given string as Date by its date format.
@@ -440,7 +403,8 @@ Gets the logic body
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
+| date |  | a string to validate as date form | &nbsp; |
+| dateForma |  | the format of the date to validate the string | &nbsp; |
@@ -448,17 +412,17 @@ Gets the logic body
 ##### Returns
--  a filter logic array
+-  true: the string is a valida date
-### dist/filters/adapters/FDToUI.js
+### dist/dates/range/getDateRange.js
-#### FDToUI(filterData, datasetsInfo)
+#### getDateRange(value, dateGroupLabel, withTime)
-Generates a UI filter structure from Filter Data structure.
+Get date range object from a string date value
@@ -467,61 +431,74 @@ Generates a UI filter structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| value | `String`  | string date value | &nbsp; |
+| dateGroupLabel | `String`  | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
+| withTime | `Boolean`  | determines if the date range will include time. Default is true | &nbsp; |
-##### Returns
+##### Examples
--  a UI Filters structure
+```javascript
+// 1) Year:
+getDateRange('2020', 'YEAR');
+// Will return:
+{
+   from: '01/01/2020 00:00:00',
+   to: '12/31/2020 23:59:59'
+}
+// 2) Quarter:
+getDateRange('Q3 2020', 'QUARTER');
+// Will return:
+{
+   from: '07/01/2020 00:00:00',
+   to: '09/30/2020 23:59:59'
+}
+// 3) Month:
+getDateRange('Oct 2020', 'MONTH');
+// Will return:
+{
+   from: '10/01/2020 00:00:00',
+   to: '10/31/2020 23:59:59'
+}
+```
-#### FD21ToUI(scopes, section, version, datasetsInfo)
-Generates a UI filter Structure from the Filter Data structure v2.1
+##### Returns
+- `Object`  an object with the date range with two string date properties: from and to
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &nbsp; |
-| section |  | The filter section. | &nbsp; |
-| version |  | The version of the filter structure | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+### dist/dates/relative/Adapter.js
+#### value()
-##### Returns
+Resolves statement and returns statement value
--  a UI filter Structure
-### dist/filters/adapters/UIToFD.js
+##### Returns
-#### UIToFD(filterData)
+- `AbsoluteRange` `string`
-Generates a Filter Data Structure structure from UI Filter Data structure.
+#### valueAsAnchor()
+Resolves statement as an anchor
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
@@ -529,74 +506,63 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 ##### Returns
--  a Filter Data structure
+- `string`
-#### UI21ToFD(uFilterData, version)
+#### _statementToRange()  *private method*
-Builds the Fitler Data structure from UI filter data
+Convert verbal statement to range value
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilterData |  | The UI filter Data object | &nbsp; |
-| version |  | the version of the structure | &nbsp; |
+##### Returns
+- `AbsoluteRange`
-##### Returns
--
+#### _resolveAsThis()  *private method*
+Apply 'this' cursor logic to statement
-### dist/filters/adapters/UIToFlatUI.js
-#### UIToFlatUI(filterData, datasetsInfo)
-Generates a Flattened UI filter structure from UI Filter Data structure.
+##### Returns
+- `AbsoluteStatement`
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
+#### _resolveAsTheLast()  *private method*
+Apply 'the last' cursor logic to statement
-##### Returns
--  a flattened UI filters array
+##### Returns
-#### UI21ToFlatUI(scopes)
+- `AbsoluteStatement`
-Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
+#### _resolveAsTheNext()  *private method*
+Apply 'the next' cursor logic to statement
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &nbsp; |
@@ -604,18 +570,13 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
 ##### Returns
--  a flattened UI filters array
+- `AbsoluteStatement`
-### dist/filters/adapters/adaptDateGroupingProperty.js
-#### adaptDateGroupingProperty(property)
+#### replaceNowToken(value, now)
-[TODO: For 2022, eliminate this adapter]
-Get the new property base on the old date grouping properties
+Replace '@now' token inside a string
@@ -624,7 +585,8 @@ Get the new property base on the old date grouping properties
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| property |  |  | &nbsp; |
+| value | `string`  |  | &nbsp; |
+| now | `Date`  |  | &nbsp; |
@@ -632,17 +594,13 @@ Get the new property base on the old date grouping properties
 ##### Returns
--
+- `string`
-### dist/filters/adapters/adaptFilterData.js
-#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
+#### convertRelativeToAbsolute(args)
-Checks and adapts the v2.0 Filter Data Structure to the v2.1
+Returns a range object (date) from a group of statement params
@@ -651,28 +609,45 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data structure. Accepts both v2.1 or v2.0 | &nbsp; |
-| getUIFilterData |  | Flag to get a Filter Data (False) or the UI Filter Data (True) | &nbsp; |
-| datasetsInfo |  | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | &nbsp; |
+| args | `RelativeToAbsoluteStruct`  |  | &nbsp; |
+##### Examples
+```javascript
+pivot = '2021-03-03T12:30:40'
+unit = month
+steps = 2
+setTo = END
+resolverAsCalendar: true
+=> Returns  '2021-05-31T23:59:59'
+```
+```javascript
+pivot = '2021-03-03T12:30:40'
+unit = month
+steps = -2
+setTo = START
+resolverAsCalendar: false
+=> Returns '2021-01-03T00:00:00'
+```
 ##### Returns
--  A new filter data structure v2.1
+- `string`
-### dist/filters/adapters/adaptFilterValues.js
+### dist/dates/relative/relative.js
-#### adaptFilterValues(filter)
+#### resolveRelative(statements, clock)
-[TODO: For 2022, eliminate this adapter]
-Gets an adapted filter value array. Validates the enabled property and sets
+Resolve a list of relative statements according to operator
@@ -681,35 +656,46 @@ Gets an adapted filter value array. Validates the enabled property and sets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
+| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
+| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
-##### Returns
+##### Examples
+```javascript
+Input:
+{
+ "cursor": "the_next",
+ "unit": "year",
+ "number": 1,
+ "includeCurrent": false,
+ "isCalendarDate": false,
+ "anchor": "03/05/2021"
+}
--  A new value array with the filled properties.
+Output:
+{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
+```
+##### Returns
-### dist/filters/adapters/flatUIToFD.js
+- `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
-#### flatUIToFD(uFilters, version)
-Generates a filter data structure from the flatttened UI filters.
+### dist/filters/classes/FilterInputErrorHandler.js
+#### new FilterInputErrorHandler()
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flattened filters from UI | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
@@ -717,14 +703,17 @@ Generates a filter data structure from the flatttened UI filters.
 ##### Returns
--  a Filter Data.
+- `Void`
-#### buildScopes(fbFilters)
-Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
-Also, adds and organizes filters by datasets
+### dist/filters/adapters/FDToFlatUI.js
+#### FDToFlatUI(filterData, datasetsInfo)
+Generates a Flattened UI filter structure from Filter Data structure.
@@ -733,7 +722,8 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -741,13 +731,13 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+-  a flattened UI filters array
-#### buildScope(uFilter)
+#### FD21ToFlatUI(scopes, datasetsInfo)
-Gets an scope structure for the filter data
+Generates a Filter Builder Structure from the Filter Data structure v2.1
@@ -756,7 +746,8 @@ Gets an scope structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| scopes |  | The filter scope section | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -764,13 +755,17 @@ Gets an scope structure for the filter data
 ##### Returns
--  an scope structure
+-  a flattened UI filters array
-#### buildDataset(uFilter)
-Gets an dataset structure for the filter data
+### dist/filters/adapters/FDToLogic.js
+#### FDToLogic(filterData)
+Generates a Filter Logic structure from Filter Data structure.
@@ -779,7 +774,7 @@ Gets an dataset structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| filterData |  | The filter data object. | &nbsp; |
@@ -787,13 +782,13 @@ Gets an dataset structure for the filter data
 ##### Returns
--  an dataset structure
+-  a filter logic array
-#### buildFilter(uFilter)
+#### getLogicBodyFromFD21(filterData)
-Gets an filter structure for the filter data
+Gets the logic body
@@ -802,7 +797,7 @@ Gets an filter structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| filterData |  | The filter data object | &nbsp; |
@@ -810,17 +805,17 @@ Gets an filter structure for the filter data
 ##### Returns
--  an filter structure
+-  a filter logic array
-### dist/filters/adapters/flatUIToLogic.js
+### dist/filters/adapters/FDToUI.js
-#### flatUIToLogic(uFilter)
+#### FDToUI(filterData, datasetsInfo)
-Generates a Logic structure from flattened UI filters
+Generates a UI filter structure from Filter Data structure.
@@ -829,7 +824,8 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | Array of flat filters from UI | &nbsp; |
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -837,17 +833,13 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+-  a UI Filters structure
-### dist/filters/adapters/flatUIToOldLogic.js
-#### flatUIToOldLogic(uFilters)
+#### FD21ToUI(scopes, section, version, datasetsInfo)
-Generates a Logic structure from flattened UI filters
+Generates a UI filter Structure from the Filter Data structure v2.1
@@ -856,7 +848,10 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flat filters from UI | &nbsp; |
+| scopes |  | The filter scope section | &nbsp; |
+| section |  | The filter section. | &nbsp; |
+| version |  | The version of the filter structure | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -864,17 +859,17 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+-  a UI filter Structure
-### dist/filters/adapters/flatUIToUI.js
+### dist/filters/adapters/UIToFD.js
-#### flatUIToUI(uFilters, version)
+#### UIToFD(filterData)
-Generates a UI filter data structure from the flatttened UI filters.
+Generates a Filter Data Structure structure from UI Filter Data structure.
@@ -883,8 +878,7 @@ Generates a UI filter data structure from the flatttened UI filters.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flattened filters from UI | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
+| filterData |  | The UI filter data object. | &nbsp; |
@@ -892,14 +886,13 @@ Generates a UI filter data structure from the flatttened UI filters.
 ##### Returns
--  a UI Filter Data.
+-  a Filter Data structure
-#### buildScopes(fbFilters)
+#### UI21ToFD(uFilterData, version)
-Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
-Also, adds and organizes filters by datasets
+Builds the Fitler Data structure from UI filter data
@@ -908,7 +901,8 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| uFilterData |  | The UI filter Data object | &nbsp; |
+| version |  | the version of the structure | &nbsp; |
@@ -916,13 +910,17 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+-
-#### buildScope(uFilter)
-Gets an scope structure for the UI filter data
+### dist/filters/adapters/UIToFlatUI.js
+#### UIToFlatUI(filterData, datasetsInfo)
+Generates a Flattened UI filter structure from UI Filter Data structure.
@@ -931,7 +929,8 @@ Gets an scope structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| filterData |  | The UI filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
@@ -939,13 +938,13 @@ Gets an scope structure for the UI filter data
 ##### Returns
--  an scope structure
+-  a flattened UI filters array
-#### buildDataset(uFilter)
+#### UI21ToFlatUI(scopes)
-Gets an dataset structure for the UI filter data
+Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
@@ -954,7 +953,7 @@ Gets an dataset structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| scopes |  | The filter scope section | &nbsp; |
@@ -962,13 +961,18 @@ Gets an dataset structure for the UI filter data
 ##### Returns
--  an dataset structure
+-  a flattened UI filters array
-#### buildFilter(uFilter)
-Gets an filter structure for the UI filter data
+### dist/filters/adapters/adaptDateGroupingProperty.js
+#### adaptDateGroupingProperty(property)
+[TODO: For 2022, eliminate this adapter]
+Get the new property base on the old date grouping properties
@@ -977,7 +981,7 @@ Gets an filter structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| property |  |  | &nbsp; |
@@ -985,17 +989,17 @@ Gets an filter structure for the UI filter data
 ##### Returns
--  an filter structure
+-
-### dist/filters/adapters/logicToFD.js
+### dist/filters/adapters/adaptFilterData.js
-#### logicToFD(filterData, version)
+#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
-Generates a filter data structure from the old logic structure (v2.0).
+Checks and adapts the v2.0 Filter Data Structure to the v2.1
@@ -1004,8 +1008,9 @@ Generates a filter data structure from the old logic structure (v2.0).
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
+| filterData |  | The filter data structure. Accepts both v2.1 or v2.0 | &nbsp; |
+| getUIFilterData |  | Flag to get a Filter Data (False) or the UI Filter Data (True) | &nbsp; |
+| datasetsInfo |  | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | &nbsp; |
@@ -1013,17 +1018,18 @@ Generates a filter data structure from the old logic structure (v2.0).
 ##### Returns
--  a Filter Data.
+-  A new filter data structure v2.1
-### dist/filters/adapters/logicToFlatUI.js
+### dist/filters/adapters/adaptFilterValues.js
-#### logicToFlatUI(logics)
+#### adaptFilterValues(filter)
-Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
+[TODO: For 2022, eliminate this adapter]
+Gets an adapted filter value array. Validates the enabled property and sets
@@ -1032,7 +1038,7 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The old logic structure (v2.0) | &nbsp; |
+| filter |  | The filter | &nbsp; |
@@ -1040,13 +1046,17 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 ##### Returns
--  The Flattened UI Filters array
+-  A new value array with the filled properties.
-#### getFilter(filters, filter, getIndex)
-Get the filter or the index of the given array, validating an old filter structure.
+### dist/filters/adapters/flatUIToFD.js
+#### flatUIToFD(uFilters, version)
+Generates a filter data structure from the flatttened UI filters.
@@ -1055,9 +1065,685 @@ Get the filter or the index of the given array, validating an old filter structu
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filters |  | The array of UI filters | &nbsp; |
-| filter |  | The old logic structure filter | &nbsp; |
-| getIndex |  | Determines if the index or returns the UI filter object | &nbsp; |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
+##### Returns
+-  a Filter Data.
+#### buildScopes(fbFilters)
+Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
+Also, adds and organizes filters by datasets
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
+##### Returns
+-  an array of scopes structure.
+#### buildScope(uFilter)
+Gets an scope structure for the filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | UI structure filter | &nbsp; |
+##### Returns
+-  an scope structure
+#### buildDataset(uFilter)
+Gets an dataset structure for the filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
+##### Returns
+-  an dataset structure
+#### buildFilter(uFilter)
+Gets an filter structure for the filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
+##### Returns
+-  an filter structure
+### dist/filters/adapters/flatUIToLogic.js
+#### flatUIToLogic(uFilter)
+Generates a Logic structure from flattened UI filters
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | Array of flat filters from UI | &nbsp; |
+##### Returns
+-  The logic structure
+### dist/filters/adapters/flatUIToOldLogic.js
+#### flatUIToOldLogic(uFilters)
+Generates a Logic structure from flattened UI filters
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Array of flat filters from UI | &nbsp; |
+##### Returns
+-  The logic structure
+### dist/filters/adapters/flatUIToUI.js
+#### flatUIToUI(uFilters, version)
+Generates a UI filter data structure from the flatttened UI filters.
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
+##### Returns
+-  a UI Filter Data.
+#### buildScopes(fbFilters)
+Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
+Also, adds and organizes filters by datasets
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
+##### Returns
+-  an array of scopes structure.
+#### buildScope(uFilter)
+Gets an scope structure for the UI filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | UI structure filter | &nbsp; |
+##### Returns
+-  an scope structure
+#### buildDataset(uFilter)
+Gets an dataset structure for the UI filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
+##### Returns
+-  an dataset structure
+#### buildFilter(uFilter)
+Gets an filter structure for the UI filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
+##### Returns
+-  an filter structure
+### dist/filters/adapters/logicToFD.js
+#### logicToFD(filterData, version)
+Generates a filter data structure from the old logic structure (v2.0).
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
+##### Returns
+-  a Filter Data.
+### dist/filters/adapters/logicToFlatUI.js
+#### logicToFlatUI(logics)
+Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| logics |  | The old logic structure (v2.0) | &nbsp; |
+##### Returns
+-  The Flattened UI Filters array
+#### getFilter(filters, filter, getIndex)
+Get the filter or the index of the given array, validating an old filter structure.
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filters |  | The array of UI filters | &nbsp; |
+| filter |  | The old logic structure filter | &nbsp; |
+| getIndex |  | Determines if the index or returns the UI filter object | &nbsp; |
+##### Returns
+-  the index or the UI filter object
+#### refineRankingValues(values, uiValues)
+Refines the values of the Ranking column type.
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| values |  | the Array of Ranking values | &nbsp; |
+| uiValues |  | Object with additional info about the values of the filter. | &nbsp; |
+##### Returns
+-  the array of Ranking values
+### dist/filters/adapters/logicToUI.js
+#### logicToUI(uFilters, datasetsInfo)
+Generates a UI filter structure from the old logic structure (v2.0).
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Array of filters from old logic structure | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
+##### Returns
+-  a UI Filter Data.
+### dist/filters/adapters/transformFilters.js
+#### transformFilters(oldFiltersObj, section)
+Transform the old filters structure into the new one
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| oldFiltersObj | `Object`  | an object with the old filters structure | &nbsp; |
+| section | `String`  | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
+##### Examples
+```javascript
+const oldPreferenceFilters = {
+  "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
+  "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
+  "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
+  "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
+  "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
+    "formulaId": null,
+    "panelId": null,
+    "values": [
+      {
+        "EQUALS": [
+          {
+            "id": "AK4M8UV2a0",
+            "value": "A",
+            "enabled": true,
+            "imageUrl": null
+          },
+          {
+            "id": "AK4M8UV2a1",
+            "value": "B",
+            "enabled": true,
+            "imageUrl": null
+          }
+        ]
+      }
+    ],
+    "bucketId": null,
+    "text": "MC",
+    "title": "MC",
+    "type": "SINGLE_CHOICE",
+    "qid": "AK4M8UV2",
+    "dataset": {
+      "sourceid": "xYOQAdpqT",
+      "name": "Form All Questions",
+      "qrveyid": "xYOQAdpqT",
+      "text": "Form All Questions",
+      "linkid": 0
+    },
+    "enabled": true,
+    "linked": null
+  }
+};
+const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
+```
+##### Returns
+- `Object`  an object with the new filters structure
+### dist/filters/helpers/applyHierarchyForAggFilters.js
+#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
+[TODO: Make a proper description for this function]
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
+| scopes |  |  | &nbsp; |
+| currentScope |  |  | &nbsp; |
+##### Returns
+-
+### dist/filters/helpers/getAvailableScopes.js
+#### getAvailableScopes(config)
+Gets Scopes/Scope IDs by given IDs
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | given Differnts IDs in order set a available scope | &nbsp; |
+##### Returns
+-  a Scopes/Scope IDs array
+### dist/filters/helpers/getAvailableScopesIDsByConfig.js
+#### getAvailableScopesIDsByConfig(config)
+Gets the Scopes IDS for the Available Scope function by any config
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | any config | &nbsp; |
+##### Returns
+-  a Available Scope IDS config
+### dist/filters/helpers/getScopesByHierarchy.js
+#### getScopesByHierarchy(scopes, currentScope)
+[TODO: Make a description for this]
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| scopes |  | the collection of Scopes/Scope IDs | &nbsp; |
+| currentScope |  | Current scope type | &nbsp; |
+##### Returns
+-  A new array of Scopes/Scope IDs
+### dist/general/array/filterNestedTree.js
+#### filterNestedTree(arr, childArrKey, condition)
+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
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| arr |  | nested tree array | &nbsp; |
+| childArrKey |  | property representing the children array on the nested tree | &nbsp; |
+| condition |  | function callback that determines if the filter is applied on the last child node of the nested tree | &nbsp; |
+##### Returns
+-  array filtered
+### dist/general/array/getFirstIndexFromArray.js
+#### getFirstIndexFromArray(array, callback)
+Gets the first index from the array by a callback condition
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
+##### Returns
+-  the first index of the array. -1 when the condition is not satisfied
+### dist/general/array/flattenDeep.js
+#### flattenDeep(arr)
+Flat deeply an array
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| arr |  | Array to flat deeply | &nbsp; |
@@ -1065,13 +1751,17 @@ Get the filter or the index of the given array, validating an old filter structu
 ##### Returns
--  the index or the UI filter object
+-  flatten array
-#### refineRankingValues(values, uiValues)
-Refines the values of the Ranking column type.
+### dist/general/array/getLastIndexFromArray.js
+#### getLastIndexFromArray(array, callback)
+Gets the last index from the array by a callback condition
@@ -1080,8 +1770,8 @@ Refines the values of the Ranking column type.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| values |  | the Array of Ranking values | &nbsp; |
-| uiValues |  | Object with additional info about the values of the filter. | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -1089,17 +1779,17 @@ Refines the values of the Ranking column type.
 ##### Returns
--  the array of Ranking values
+-  the last index of the array. -1 when the condition is not satisfied
-### dist/filters/adapters/logicToUI.js
+### dist/general/array/delete.js
-#### logicToUI(uFilters, datasetsInfo)
+#### ArrayDelete(array, index)
-Generates a UI filter structure from the old logic structure (v2.0).
+Inmutable Array Item deletion
@@ -1108,8 +1798,8 @@ Generates a UI filter structure from the old logic structure (v2.0).
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of filters from old logic structure | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| array | `Array`  | a collection of items to delete | &nbsp; |
+| index | `Number`  | the position of the item to delete | &nbsp; |
@@ -1117,17 +1807,17 @@ Generates a UI filter structure from the old logic structure (v2.0).
 ##### Returns
--  a UI Filter Data.
+-  a new Array or the given parameter when is empty or not an array
-### dist/filters/adapters/transformFilters.js
+### dist/general/function/debounce.js
-#### transformFilters(oldFiltersObj, section)
+#### debounce(fn, time)
-Transform the old filters structure into the new one
+Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
@@ -1136,77 +1826,147 @@ Transform the old filters structure into the new one
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| oldFiltersObj | `Object`  | an object with the old filters structure | &nbsp; |
-| section | `String`  | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
-##### Examples
+##### Returns
-```javascript
-const oldPreferenceFilters = {
-  "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
-  "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
-  "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
-  "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
-  "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
-    "formulaId": null,
-    "panelId": null,
-    "values": [
-      {
-        "EQUALS": [
-          {
-            "id": "AK4M8UV2a0",
-            "value": "A",
-            "enabled": true,
-            "imageUrl": null
-          },
-          {
-            "id": "AK4M8UV2a1",
-            "value": "B",
-            "enabled": true,
-            "imageUrl": null
-          }
-        ]
-      }
-    ],
-    "bucketId": null,
-    "text": "MC",
-    "title": "MC",
-    "type": "SINGLE_CHOICE",
-    "qid": "AK4M8UV2",
-    "dataset": {
-      "sourceid": "xYOQAdpqT",
-      "name": "Form All Questions",
-      "qrveyid": "xYOQAdpqT",
-      "text": "Form All Questions",
-      "linkid": 0
-    },
-    "enabled": true,
-    "linked": null
-  }
-};
+- `Function`  debounced functions
-const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
+### dist/general/function/throttled.js
+#### throttled(fn, time)
+Make sure to only invokes _fn_ at most once per every _time_ milliseconds
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
+##### Returns
+- `Function`  throttled function
+### 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 | &nbsp; |
+##### Returns
+-  The new reference object or the given object if the parsing is incorrect or empty
+### dist/general/object/get.js
+#### _get(baseObject, path, defaultValue)
+Like lodash _.get.
+Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
+Empty arrays and empty objects are returned but the defaultValue is not
+Undefined and null values will return the defaultValue.
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| baseObject |  | The object to query | &nbsp; |
+| path |  | The string path or collection of string paths of the property to get. | &nbsp; |
+| defaultValue |  | The value returned for undefined resolved values. | &nbsp; |
+##### Examples
+```javascript
+// returns 'Hello'
+_get({ item1: 'Hello', item2: 'World' }, 'item1')
+```
+```javascript
+// returns 'A simple Hello'
+_get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
+```
+```javascript
+// returns 'Hello Again'
+_get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
+```
+```javascript
+// returns 'Hello 2'
+_get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
+```
+```javascript
+// returns 'Hello Again'
+_get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
 ```
 ##### Returns
-- `Object`  an object with the new filters structure
+-  the resolved value.
-### dist/filters/helpers/applyHierarchyForAggFilters.js
+### dist/general/object/getAttribute.js
-#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
+#### getAttribute(obj, key)
-[TODO: Make a proper description for this function]
+Searchs for properties in different case styles such as: lower, upper, camel and pascal
+- To optimize the searching, it is required a key in a snake_case style
+- List of cases that do not match
+-- From lower to snake case
+-- From upper to snake case
+-- From lower to camel case
+-- From upper to camel case
+-- From lower to pascal case
+-- From upper to pascal case
@@ -1215,27 +1975,33 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &nbsp; |
+| obj | `object`  | object to look for | &nbsp; |
+| key | `string`  | String attribute in snake_case style | &nbsp; |
+##### Examples
+```javascript
+getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+```
 ##### Returns
--
+- `Void`
-### dist/filters/helpers/getAvailableScopes.js
+### dist/general/object/hasProperty.js
-#### getAvailableScopes(config)
+#### _hasProperty(obj, property)
-Gets Scopes/Scope IDs by given IDs
+Use the hasOwnProperty in order to verify if the given property exists in the object.
@@ -1244,25 +2010,38 @@ Gets Scopes/Scope IDs by given IDs
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | given Differnts IDs in order set a available scope | &nbsp; |
+| obj | `object`  | an object | &nbsp; |
+| property | `string`  | String to verify if exists in the object as property | &nbsp; |
+##### Examples
+```javascript
+const prop = 'prop2'
+const obj1 = { prop1: 'hello', prop2: 'world'}
+_hasProperty(ob1, prop1) // true
+const obj2 = { prop1: 'hello world' }
+_hasProperty(ob1, prop2) // false
+```
 ##### Returns
--  a Scopes/Scope IDs array
+-  True if the object has the given property; otherwise, false.
-### dist/filters/helpers/getAvailableScopesIDsByConfig.js
+### dist/general/object/isObject.js
-#### getAvailableScopesIDsByConfig(config)
+#### isObject(obj)
-Gets the Scopes IDS for the Available Scope function by any config
+Checks if the given argument is an object type
@@ -1271,7 +2050,7 @@ Gets the Scopes IDS for the Available Scope function by any config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | any config | &nbsp; |
+| obj |  | the variable to check | &nbsp; |
@@ -1279,17 +2058,18 @@ Gets the Scopes IDS for the Available Scope function by any config
 ##### Returns
--  a Available Scope IDS config
+-  True: It is an object; False: It is not.
-### dist/filters/helpers/getScopesByHierarchy.js
+### dist/general/object/mapValues.js
-#### getScopesByHierarchy(scopes, currentScope)
+#### mapValues(baseObject, iteratee)
-[TODO: Make a description for this]
+Invoke iteratee (function) for each object key-value pair
+and return a mapped object
@@ -1298,8 +2078,8 @@ Gets the Scopes IDS for the Available Scope function by any config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes |  | the collection of Scopes/Scope IDs | &nbsp; |
-| currentScope |  | Current scope type | &nbsp; |
+| baseObject | `Object`  | Base object. | &nbsp; |
+| iteratee | `Function`  | The executed per iteration. | &nbsp; |
@@ -1307,17 +2087,18 @@ Gets the Scopes IDS for the Available Scope function by any config
 ##### Returns
--  A new array of Scopes/Scope IDs
+- `Object`  New mapped object.
-### dist/general/function/debounce.js
+### dist/general/object/mergeDeep.js
-#### debounce(fn, time)
+#### mergeDeep(obj1, obj2, settings)
-Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
+Merges two objects into a new one.
+The second given argument to the first given argument.
@@ -1326,8 +2107,9 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
+| settings |  | Object settings for this function | &nbsp; |
@@ -1335,17 +2117,13 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
 ##### Returns
-- `Function`  debounced functions
+-  a new merged object
-### dist/general/function/throttled.js
-#### throttled(fn, time)
+#### isValid(obj1, obj2)
-Make sure to only invokes _fn_ at most once per every _time_ milliseconds
+Validates if the two arguments are objects
@@ -1354,8 +2132,8 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
@@ -1363,17 +2141,13 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 ##### Returns
-- `Function`  throttled function
+-  true: they are valid; false: they are not
-### dist/general/array/delete.js
-#### ArrayDelete(array, index)
+#### getParamsToMergeDeep(settings)
-Inmutable Array Item deletion
+Validates and gets the settings with all set parameters.
@@ -1382,8 +2156,7 @@ Inmutable Array Item deletion
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array | `Array`  | a collection of items to delete | &nbsp; |
-| index | `Number`  | the position of the item to delete | &nbsp; |
+| settings |  | the settings object | &nbsp; |
@@ -1391,20 +2164,17 @@ Inmutable Array Item deletion
 ##### Returns
--  a new Array or the given parameter when is empty or not an array
+-  a new settings object with all set parameters.
-### dist/general/array/filterNestedTree.js
+### dist/general/object/objectCopy.js
-#### filterNestedTree(arr, childArrKey, condition)
+#### objectCopy(entity, cache)
-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
+Created a new reference of the given argument
@@ -1413,9 +2183,8 @@ Filters a nested tree array by a custom condition on the last child node
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | nested tree array | &nbsp; |
-| childArrKey |  | property representing the children array on the nested tree | &nbsp; |
-| condition |  | function callback that determines if the filter is applied on the last child node of the nested tree | &nbsp; |
+| entity |  | The variable to be copied | &nbsp; |
+| cache |  |  | &nbsp; |
@@ -1423,17 +2192,17 @@ Filters a nested tree array by a custom condition on the last child node
 ##### Returns
--  array filtered
+-  A new reference of the given argument
-### dist/general/array/flattenDeep.js
+### dist/general/object/omit.js
-#### flattenDeep(arr)
+#### omit(obj, props)
-Flat deeply an array
+return a new Object excluding attributes in _props_ list
@@ -1442,7 +2211,8 @@ Flat deeply an array
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply | &nbsp; |
+| obj | `Object`  | base object | &nbsp; |
+| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
@@ -1450,17 +2220,17 @@ Flat deeply an array
 ##### Returns
--  flatten array
+- `Object`  clean object
-### dist/general/array/getFirstIndexFromArray.js
+### dist/general/object/pick.js
-#### getFirstIndexFromArray(array, callback)
+#### pick(baseObject, keys)
-Gets the first index from the array by a callback condition
+return a new object just with attributes in _keys_ list
@@ -1469,8 +2239,8 @@ Gets the first index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| baseObject | `Object`  | base object | &nbsp; |
+| keys | `Array.<String>`  | list of attributes to preserve | &nbsp; |
@@ -1478,17 +2248,17 @@ Gets the first index from the array by a callback condition
 ##### Returns
--  the first index of the array. -1 when the condition is not satisfied
+- `Object`  new object just with desired attributes
-### dist/general/array/getLastIndexFromArray.js
+### dist/general/object/serialize.js
-#### getLastIndexFromArray(array, callback)
+#### serialize(obj)
-Gets the last index from the array by a callback condition
+serialize object to url param
@@ -1497,8 +2267,7 @@ Gets the last index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| obj |  | - Object to be serialized | &nbsp; |
@@ -1506,7 +2275,7 @@ Gets the last index from the array by a callback condition
 ##### Returns
--  the last index of the array. -1 when the condition is not satisfied
+- `Void`
@@ -1680,131 +2449,14 @@ Validates if the given argument is empty
-### dist/general/mix/isNull.js
-#### isNull(arg)
-return if a given variable is either `null` or `undefined`
-useful to avoid falsify validating Number Zero (0)
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| arg | `any`  |  | &nbsp; |
-##### Returns
-- `Boolean`
-### dist/general/mix/randomId.js
-#### randomId(length, exclude)
-Creates a random string
-- If the first given argument is different than a length number, the variable is replaced by a default number
-- If the optional second given argument is passed the random string is permutated.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| length | `Number`  | size of the generated string. Default 8 | &nbsp; |
-| exclude | `Array`  | collection of strings that is going to be excluded of the random string. | &nbsp; |
-##### Returns
-- `String`  Random string
-### dist/general/mix/size.js
-#### size(obj)
-Gets the length of the given array.
-- Useful for Object, Array and string type.
-- For `null` or `undefined` or else argument the returned value will be 0.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj | `Any`  | Any object-type variable | &nbsp; |
-##### Returns
-- `Number`  the size of the given variable
+### dist/general/mix/isNaNV2.js
-### 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 | &nbsp; |
-##### Returns
--  The new reference object or the given object if the parsing is incorrect or empty
-### dist/general/object/get.js
-#### _get(baseObject, path, defaultValue)
-Like lodash _.get.
-Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
+#### isNaNV2(variable)
-Empty arrays and empty objects are returned but the defaultValue is not
-Undefined and null values will return the defaultValue.
+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.
@@ -1813,59 +2465,26 @@ Undefined and null values will return the defaultValue.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject |  | The object to query | &nbsp; |
-| path |  | The string path or collection of string paths of the property to get. | &nbsp; |
-| defaultValue |  | The value returned for undefined resolved values. | &nbsp; |
+| variable |  | the variable to validate | &nbsp; |
-##### Examples
-```javascript
-// returns 'Hello'
-_get({ item1: 'Hello', item2: 'World' }, 'item1')
-```
-```javascript
-// returns 'A simple Hello'
-_get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
-```
-```javascript
-// returns 'Hello Again'
-_get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
-```
-```javascript
-// returns 'Hello 2'
-_get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
-```
-```javascript
-// returns 'Hello Again'
-_get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
-```
 ##### Returns
--  the resolved value.
+-  True if variable is a NaN or false otherwise
-### dist/general/object/getAttribute.js
+### dist/general/mix/isNull.js
-#### getAttribute(obj, key)
+#### isNull(arg)
-Searchs for properties in different case styles such as: lower, upper, camel and pascal
-- To optimize the searching, it is required a key in a snake_case style
-- List of cases that do not match
--- From lower to snake case
--- From upper to snake case
--- From lower to camel case
--- From upper to camel case
--- From lower to pascal case
--- From upper to pascal case
+return if a given variable is either `null` or `undefined`
+useful to avoid falsify validating Number Zero (0)
@@ -1874,33 +2493,27 @@ Searchs for properties in different case styles such as: lower, upper, camel and
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `object`  | object to look for | &nbsp; |
-| key | `string`  | String attribute in snake_case style | &nbsp; |
+| arg | `any`  |  | &nbsp; |
-##### Examples
-```javascript
-getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-```
 ##### Returns
-- `Void`
+- `Boolean`
-### dist/general/object/hasProperty.js
+### dist/general/mix/randomId.js
-#### _hasProperty(obj, property)
+#### randomId(length, exclude)
-Use the hasOwnProperty in order to verify if the given property exists in the object.
+Creates a random string
+- If the first given argument is different than a length number, the variable is replaced by a default number
+- If the optional second given argument is passed the random string is permutated.
@@ -1909,38 +2522,28 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `object`  | an object | &nbsp; |
-| property | `string`  | String to verify if exists in the object as property | &nbsp; |
-##### Examples
+| length | `Number`  | size of the generated string. Default 8 | &nbsp; |
+| exclude | `Array`  | collection of strings that is going to be excluded of the random string. | &nbsp; |
-```javascript
-const prop = 'prop2'
-const obj1 = { prop1: 'hello', prop2: 'world'}
-_hasProperty(ob1, prop1) // true
-const obj2 = { prop1: 'hello world' }
-_hasProperty(ob1, prop2) // false
-```
 ##### Returns
--  True if the object has the given property; otherwise, false.
+- `String`  Random string
-### dist/general/object/isObject.js
+### dist/general/mix/size.js
-#### isObject(obj)
+#### size(obj)
-Checks if the given argument is an object type
+Gets the length of the given array.
+- Useful for Object, Array and string type.
+- For `null` or `undefined` or else argument the returned value will be 0.
@@ -1949,7 +2552,7 @@ Checks if the given argument is an object type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | the variable to check | &nbsp; |
+| obj | `Any`  | Any object-type variable | &nbsp; |
@@ -1957,18 +2560,17 @@ Checks if the given argument is an object type
 ##### Returns
--  True: It is an object; False: It is not.
+- `Number`  the size of the given variable
-### dist/general/object/mapValues.js
+### dist/general/string/capitalize.js
-#### mapValues(baseObject, iteratee)
+#### capitalize(text)
-Invoke iteratee (function) for each object key-value pair
-and return a mapped object
+Upper case the first letter of a given text
@@ -1977,8 +2579,7 @@ and return a mapped object
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | Base object. | &nbsp; |
-| iteratee | `Function`  | The executed per iteration. | &nbsp; |
+| text | `String`  |  | &nbsp; |
@@ -1986,18 +2587,17 @@ and return a mapped object
 ##### Returns
-- `Object`  New mapped object.
+- `String`  a capitalized text
-### dist/general/object/mergeDeep.js
+### dist/qrvey/helpers/getColumnsLabel.js
-#### mergeDeep(obj1, obj2, settings)
+#### getColumnLabels(column)
-Merges two objects into a new one.
-The second given argument to the first given argument.
+Get an string of the properties of the given column.
@@ -2006,9 +2606,7 @@ The second given argument to the first given argument.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
-| settings |  | Object settings for this function | &nbsp; |
+| column |  | The column | &nbsp; |
@@ -2016,13 +2614,17 @@ The second given argument to the first given argument.
 ##### Returns
--  a new merged object
+-  an string with the property, aggregate or calculation label.
-#### isValid(obj1, obj2)
-Validates if the two arguments are objects
+### dist/services/api/getAllDatasets.api.js
+#### getAllDatasets(qrveyids)
+Get a dataset list from a collection of Qrvey IDs
@@ -2031,8 +2633,7 @@ Validates if the two arguments are objects
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
+| qrveyids |  | Collection of Qrvey IDs | &nbsp; |
@@ -2040,13 +2641,17 @@ Validates if the two arguments are objects
 ##### Returns
--  true: they are valid; false: they are not
+-  a promise
-#### getParamsToMergeDeep(settings)
-Validates and gets the settings with all set parameters.
+### 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
@@ -2055,7 +2660,8 @@ Validates and gets the settings with all set parameters.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | the settings object | &nbsp; |
+| config |  | Configuration | &nbsp; |
+| params |  | Object for getting precise data | &nbsp; |
@@ -2063,17 +2669,17 @@ Validates and gets the settings with all set parameters.
 ##### Returns
--  a new settings object with all set parameters.
+- `Void`
-### dist/general/object/objectCopy.js
+### dist/services/api/getDatasetColumns.api.js
-#### objectCopy(entity, cache)
+#### getDatasetColumns(qrveyid)
-Created a new reference of the given argument
+Get a dataset by Qrvey ID
@@ -2082,8 +2688,7 @@ Created a new reference of the given argument
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| entity |  | The variable to be copied | &nbsp; |
-| cache |  |  | &nbsp; |
+| qrveyid |  | The Qrvey ID | &nbsp; |
@@ -2091,45 +2696,50 @@ Created a new reference of the given argument
 ##### Returns
--  A new reference of the given argument
+-  a promise
-### dist/general/object/omit.js
+### dist/stencil/decorators/Config.js
-#### omit(obj, props)
+#### Config()
-return a new Object excluding attributes in _props_ list
+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 |  |
-| ---- | ---- | ----------- | -------- |
-| obj | `Object`  | base object | &nbsp; |
-| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
+##### Examples
+```javascript
+\ @Config() @Prop() settings;
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 ##### Returns
-- `Object`  clean object
+- `Void`
-### dist/general/object/pick.js
+### dist/typescript/decorators/Debounce.js
-#### pick(baseObject, keys)
+#### Debounce(time)
-return a new object just with attributes in _keys_ list
+(Method Decorator) Debounce Class Method
@@ -2138,8 +2748,7 @@ return a new object just with attributes in _keys_ list
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | base object | &nbsp; |
-| keys | `Array.<String>`  | list of attributes to preserve | &nbsp; |
+| time |  | (optional) deafult 500 | &nbsp; |
@@ -2147,17 +2756,17 @@ return a new object just with attributes in _keys_ list
 ##### Returns
-- `Object`  new object just with desired attributes
+- `Void`
-### dist/general/object/serialize.js
+### dist/typescript/decorators/Throttled.js
-#### serialize(obj)
+#### Throttled(time)
-serialize object to url param
+(Method Decorator) Throttled Class Method
@@ -2166,7 +2775,7 @@ serialize object to url param
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | - Object to be serialized | &nbsp; |
+| time |  | (optional) deafult 500 | &nbsp; |
@@ -2179,12 +2788,36 @@ serialize object to url param
-### dist/general/string/capitalize.js
+### dist/stencil/util/createRef.js
-#### capitalize(text)
+#### createRef()
-Upper case the first letter of a given text
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+##### Returns
+-  function - Function to use in ref prop in html elements
+### dist/stencil/util/getConfig.js
+#### getConfig(cfg)
+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
@@ -2193,7 +2826,7 @@ Upper case the first letter of a given text
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| text | `String`  |  | &nbsp; |
+| cfg |  |  | &nbsp; |
@@ -2201,17 +2834,17 @@ Upper case the first letter of a given text
 ##### Returns
-- `String`  a capitalized text
+- `Void`
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/dates/relative/helpers/formatStatement.js
-#### getColumnLabels(column)
+#### formatStatement(statement)
-Get an string of the properties of the given column.
+Build a proper relative date statement type
@@ -2220,7 +2853,7 @@ Get an string of the properties of the given column.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column | &nbsp; |
+| statement | `RelativeStatement`  |  | &nbsp; |
@@ -2228,17 +2861,17 @@ Get an string of the properties of the given column.
 ##### Returns
--  an string with the property, aggregate or calculation label.
+- `RelativeStatement`
-### dist/services/api/getAllDatasets.api.js
+### dist/dates/relative/helpers/getStatementCase.js
-#### getAllDatasets(qrveyids)
+#### getStatementCase(includeCurrent, isCalendarDate)
-Get a dataset list from a collection of Qrvey IDs
+Returns a number/constant that identifies a relative date case
@@ -2247,7 +2880,8 @@ Get a dataset list from a collection of Qrvey IDs
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs | &nbsp; |
+| includeCurrent | `boolean`  |  | &nbsp; |
+| isCalendarDate | `boolean`  |  | &nbsp; |
@@ -2255,17 +2889,17 @@ Get a dataset list from a collection of Qrvey IDs
 ##### Returns
--  a promise
+- `number`
-### dist/services/api/getAllQrveys.api.js
+### dist/dates/relative/helpers/parseDate.js
-#### getAllQrveys(config, params)
+#### parseDate(date)
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+Parses a string date and returns a dayjs date
@@ -2274,8 +2908,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | Configuration | &nbsp; |
-| params |  | Object for getting precise data | &nbsp; |
+| date | `string` `Dayjs` `Date`  |  | &nbsp; |
@@ -2283,17 +2916,18 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
-- `Void`
+- `Dayjs`  A dayjs date
-### dist/services/api/getDatasetColumns.api.js
+### dist/filters/helpers/backend/buildExpression.js
-#### getDatasetColumns(qrveyid)
+#### buildExpression(filter)
-Get a dataset by Qrvey ID
+Builds filter expression by the filter data.
+- If the resulting value array is empty the enabled property will be false.
@@ -2302,7 +2936,7 @@ Get a dataset by Qrvey ID
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID | &nbsp; |
+| filter |  | The filter to transform | &nbsp; |
@@ -2310,19 +2944,26 @@ Get a dataset by Qrvey ID
 ##### Returns
--  a promise
+-  a filter expression
-### dist/stencil/util/createRef.js
+### dist/filters/helpers/backend/buildUserFilters.js
+#### buildUserFilters(userFilters)
+Transform user Filters array into Filter Logic structure
-#### createRef()
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| userFilters |  | The filters that the user defined. | &nbsp; |
@@ -2330,21 +2971,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
 ##### Returns
--  function - Function to use in ref prop in html elements
+-  The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
-### dist/stencil/util/getConfig.js
+### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
-#### getConfig(cfg)
+#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
-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
@@ -2353,7 +2990,8 @@ try to find this string as a variable on Windows object
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  | &nbsp; |
+| aggFilters |  |  | &nbsp; |
+| summaryIndex |  |  | &nbsp; |
@@ -2361,50 +2999,44 @@ try to find this string as a variable on Windows object
 ##### Returns
-- `Void`
+-
-### dist/stencil/decorators/Config.js
+### dist/filters/helpers/backend/getBackendGroupValue.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
+#### getBackendGroupValue(filter)
+Gets a group value for the backend logic structure
+##### Parameters
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  | The filter | &nbsp; |
-```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 property
-### dist/typescript/decorators/Debounce.js
+### dist/filters/helpers/backend/getBackendProperty.js
-#### Debounce(time)
+#### getBackendProperty(filter)
-(Method Decorator) Debounce Class Method
+Gets a property for the logic structure
@@ -2413,7 +3045,7 @@ someMethod() {
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 | &nbsp; |
+| filter |  | The filter | &nbsp; |
@@ -2421,17 +3053,17 @@ someMethod() {
 ##### Returns
-- `Void`
+-  a property
-### dist/typescript/decorators/Throttled.js
+### dist/filters/helpers/backend/getBackendValidator.js
-#### Throttled(time)
+#### getBackendValidator(validator)
-(Method Decorator) Throttled Class Method
+Gets the Validator that is used in requests
@@ -2440,7 +3072,7 @@ someMethod() {
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 | &nbsp; |
+| validator |  | Filter Validator used in UI | &nbsp; |
@@ -2448,17 +3080,17 @@ someMethod() {
 ##### Returns
-- `Void`
+-  Filter Validator used in Backend
-### dist/dates/relative/helpers/formatStatement.js
+### dist/filters/helpers/backend/getBackendValues.js
-#### formatStatement(statement)
+#### getBackendValues(filter)
-Build a proper relative date statement type
+Gets the expresion values in the logic format
@@ -2467,7 +3099,7 @@ Build a proper relative date statement type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| statement | `RelativeStatement`  |  | &nbsp; |
+| filter |  | The filter structure | &nbsp; |
@@ -2475,17 +3107,13 @@ Build a proper relative date statement type
 ##### Returns
-- `RelativeStatement`
+-  A collection of backend expression value
-### dist/dates/relative/helpers/getStatementCase.js
-#### getStatementCase(includeCurrent, isCalendarDate)
+#### getResultValues(values, filter)
-Returns a number/constant that identifies a relative date case
+Gets the expression values. Depending on the column type
@@ -2494,8 +3122,8 @@ Returns a number/constant that identifies a relative date case
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| includeCurrent | `boolean`  |  | &nbsp; |
-| isCalendarDate | `boolean`  |  | &nbsp; |
+| values |  | a collection of filter values | &nbsp; |
+| filter |  | The filter structure | &nbsp; |
@@ -2503,17 +3131,13 @@ Returns a number/constant that identifies a relative date case
 ##### Returns
-- `number`
+-
-### dist/dates/relative/helpers/parseDate.js
-#### parseDate(date)
+#### getRankingValues(values, rankingGroupIndex)
-Parses a string date and returns a dayjs date
+Gets the Ranking values.
@@ -2522,7 +3146,8 @@ Parses a string date and returns a dayjs date
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date | `string` `Dayjs` `Date`  |  | &nbsp; |
+| values |  | a collection of filter values in the ranking structure | &nbsp; |
+| rankingGroupIndex |  | determine the value by this index to build and return it | &nbsp; |
@@ -2530,17 +3155,17 @@ Parses a string date and returns a dayjs date
 ##### Returns
-- `Dayjs`  A dayjs date
+-  Expression values for ranking
-### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
+### dist/filters/helpers/backend/getLogicByScopes.js
-#### getFilterBuilderGeneralConfig(config)
+#### getLogicByScopes(logics, scopes)
-Returns a filter builder config object by a any given config
+Gets the filters from logic data by Scopes/Scope IDs.
@@ -2549,7 +3174,8 @@ Returns a filter builder config object by a any given config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | any config object | &nbsp; |
+| logics |  | The logic array | &nbsp; |
+| scopes |  | The collection of Scopes/Scope IDs | &nbsp; |
@@ -2557,18 +3183,17 @@ Returns a filter builder config object by a any given config
 ##### Returns
--  The filter builder config object
+-  a new Logic array
-### dist/filters/helpers/backend/buildExpression.js
+### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
-#### buildExpression(filter)
+#### getLogicByScopesHierarchy(filterData, scopes, currentScope)
-Builds filter expression by the filter data.
-- If the resulting value array is empty the enabled property will be false.
+Gets filters from the logic by the scopes hierarchy.
@@ -2577,7 +3202,9 @@ Builds filter expression by the filter data.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter to transform | &nbsp; |
+| filterData |  |  | &nbsp; |
+| scopes |  |  | &nbsp; |
+| currentScope |  |  | &nbsp; |
@@ -2585,17 +3212,17 @@ Builds filter expression by the filter data.
 ##### Returns
--  a filter expression
+-  a new array of Logic
-### dist/filters/helpers/backend/buildUserFilters.js
+### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
-#### buildUserFilters(userFilters)
+#### getFilterBuilderGeneralConfig(config)
-Transform user Filters array into Filter Logic structure
+Returns a filter builder config object by a any given config
@@ -2604,7 +3231,7 @@ Transform user Filters array into Filter Logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| userFilters |  | The filters that the user defined. | &nbsp; |
+| config |  | any config object | &nbsp; |
@@ -2612,17 +3239,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
--  The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
+-  The filter builder config object
-### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
+### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
-#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
+#### excludeUIFiltersByAggregate(uFilters)
+Excludes Aggregate Filters in the Flattened UI Filters array
@@ -2631,8 +3258,7 @@ Transform user Filters array into Filter Logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| aggFilters |  |  | &nbsp; |
-| summaryIndex |  |  | &nbsp; |
+| uFilters |  | Collection of Flat UI Filters | &nbsp; |
@@ -2640,17 +3266,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
--
+-  a new Flat UI Filters that were excluded the aggregate filters
-### dist/filters/helpers/backend/getBackendGroupValue.js
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
-#### getBackendGroupValue(filter)
+#### excludeUIFlatFiltersByScopes(uFilters, scopes)
-Gets a group value for the backend logic structure
+Excludes and returns a UI Flat Filters without filters by the given scopes
@@ -2659,7 +3285,8 @@ Gets a group value for the backend logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
+| uFilters |  | The Flatten UI Filters | &nbsp; |
+| scopes |  | collection of scopes types | &nbsp; |
@@ -2667,17 +3294,17 @@ Gets a group value for the backend logic structure
 ##### Returns
--  a property
+-  The new array of UI Flattened filters
-### dist/filters/helpers/backend/getBackendProperty.js
+### dist/filters/helpers/ui/getFilterPropertyLabel.js
-#### getBackendProperty(filter)
+#### getFilterPropertyLabel(filter)
-Gets a property for the logic structure
+Gets the label of the filter property
@@ -2686,7 +3313,7 @@ Gets a property for the logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
+| filter |  | The UI Filter | &nbsp; |
@@ -2694,17 +3321,17 @@ Gets a property for the logic structure
 ##### Returns
--  a property
+-  a string of the filter property label
-### dist/filters/helpers/backend/getBackendValidator.js
+### dist/filters/helpers/ui/getOutputFormatByColumn.js
-#### getBackendValidator(validator)
+#### getOutputFormatByColumn(column, datasets)
-Gets the Validator that is used in requests
+Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
@@ -2713,7 +3340,8 @@ Gets the Validator that is used in requests
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | Filter Validator used in UI | &nbsp; |
+| column |  | The column | &nbsp; |
+| datasets |  | array of datasets | &nbsp; |
@@ -2721,64 +3349,74 @@ Gets the Validator that is used in requests
 ##### Returns
--  Filter Validator used in Backend
+-  The output format object
-### dist/filters/helpers/backend/getBackendValues.js
+### dist/filters/helpers/ui/getUIFlatFilterByParams.js
-#### getBackendValues(filter)
+#### getUIFlatFilterByParams()
-Gets the expresion values in the logic format
+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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter structure | &nbsp; |
+##### Returns
+-  The index of the uFilter array or the Filter object s
-##### Returns
--  A collection of backend expression value
+### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
-#### getResultValues(values, filter)
+#### getUIFlatFiltersByParams()
-Gets the expression values. Depending on the column type
+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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values | &nbsp; |
-| filter |  | The filter structure | &nbsp; |
+##### Returns
+-  The index of the uFilter array or the Filter object s
-##### Returns
--
+### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
-#### getRankingValues(values, rankingGroupIndex)
+#### getUIFlatFiltersByScopes(uFilters, scopes)
-Gets the Ranking values.
+Filters and gets a UI Flatten Filters by the given scopes
@@ -2787,8 +3425,8 @@ Gets the Ranking values.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values in the ranking structure | &nbsp; |
-| rankingGroupIndex |  | determine the value by this index to build and return it | &nbsp; |
+| uFilters |  | The Flatten UI Filters | &nbsp; |
+| scopes |  | collection of scopes types | &nbsp; |
@@ -2796,17 +3434,17 @@ Gets the Ranking values.
 ##### Returns
--  Expression values for ranking
+-  The new array of UI Flattened filters
-### dist/filters/helpers/backend/getLogicByScopes.js
+### dist/filters/helpers/ui/getUIValues.js
-#### getLogicByScopes(logics, scopes)
+#### getUIValues(filter, addEnableds, rankingGroupIndex)
-Gets the filters from logic data by Scopes/Scope IDs.
@@ -2815,8 +3453,9 @@ Gets the filters from logic data by Scopes/Scope IDs.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The logic array | &nbsp; |
-| scopes |  | The collection of Scopes/Scope IDs | &nbsp; |
+| filter |  |  | &nbsp; |
+| addEnableds |  |  | &nbsp; |
+| rankingGroupIndex |  |  | &nbsp; |
@@ -2824,17 +3463,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
 ##### Returns
--  a new Logic array
+-
-### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
+### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
-#### getLogicByScopesHierarchy(filterData, scopes, currentScope)
+#### resolveUIFlatFilterByParams(filter, params)
-Gets filters from the logic by the scopes hierarchy.
+Resolves conditions between UI flattened filter and given parameters
@@ -2843,9 +3482,8 @@ Gets filters from the logic by the scopes hierarchy.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  |  | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &nbsp; |
+| filter |  | UI Flatten Filter | &nbsp; |
+| params |  | Parameters to validate | &nbsp; |
@@ -2853,7 +3491,7 @@ Gets filters from the logic by the scopes hierarchy.
 ##### Returns
--  a new array of Logic
+-  true: the conditions are satisfied.
@@ -3682,256 +4320,4 @@ 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 | &nbsp; |
-##### 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 | &nbsp; |
-| scopes |  | collection of scopes types | &nbsp; |
-##### 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 | &nbsp; |
-##### 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 | &nbsp; |
-| datasets |  | array of datasets | &nbsp; |
-##### 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 | &nbsp; |
-| scopes |  | collection of scopes types | &nbsp; |
-##### Returns
--  The new array of UI Flattened filters
-### dist/filters/helpers/ui/getUIValues.js
-#### getUIValues(filter, addEnableds, rankingGroupIndex)
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  |  | &nbsp; |
-| addEnableds |  |  | &nbsp; |
-| rankingGroupIndex |  |  | &nbsp; |
-##### 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 | &nbsp; |
-| params |  | Parameters to validate | &nbsp; |
-##### Returns
--  true: the conditions are satisfied.
 *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*