npm - @qrvey/utils - Versions diffs - 1.2.9-31 → 1.2.9-34 - Mend

@qrvey/utils 1.2.9-31 → 1.2.9-34

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 (42) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-31*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-34*
 > 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/adapters/mdyDateToDate.js
+### dist/dates/helpers/getDateByDateFormat.js
-#### mdyDateToDate(monthYearDate, time)
+#### getDateByDateFormat(date, format, time)
-Transforms String Date from a [mm/dd/yyyy] format to Date object.
+Gets a Date Object instance by a Date format
@@ -94,8 +94,9 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
+| date |  | String with a formatted date | &nbsp; |
+| format |  | The date format | &nbsp; |
+| time |  | flag to convert the formatted date to miliseconds | &nbsp; |
@@ -103,17 +104,17 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a Date object, milisecond time or the same value if date format does not match.
-### dist/dates/adapters/monthYearToDate.js
+### dist/dates/helpers/getDateFormatByProperty.js
-#### monthYearToDate(monthYearDate, time)
+#### getDateFormatByProperty(property)
-Transforms String Date from a [Month Year] format to Date object.
+Gets the date format by the given property
@@ -122,8 +123,7 @@ Transforms String Date from a [Month Year] format to Date object.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| monthYearDate |  | String of [Month Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
+| property |  | The Column Property | &nbsp; |
@@ -131,17 +131,17 @@ Transforms String Date from a [Month Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  The date format
-### dist/dates/adapters/quarterYearToDate.js
+### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
-#### quarterYearToDate(quarterYearDate, time)
+#### getDateFormatRegularExpressionInArray(dateFormat)
-Transforms String Date from a [Quarter Year] format to Date object.
+Gets an array of regular expressions by the given date format
@@ -150,8 +150,7 @@ Transforms String Date from a [Quarter Year] format to Date object.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| quarterYearDate |  | String of [Quarter Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
+| dateFormat |  | the date format | &nbsp; |
@@ -159,17 +158,17 @@ Transforms String Date from a [Quarter Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  an array of regular expressions
-### dist/dates/adapters/weekYearToDate.js
+### dist/dates/helpers/getSeparatorByDateFormat.js
-#### weekYearToDate(date, time)
+#### getSeparatorByDateFormat(format)
-Transforms String Date from a [Week Year] format to Date object.
+Gets the separator of the date format
@@ -178,8 +177,7 @@ Transforms String Date from a [Week Year] format to Date object.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | String of [Week Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
+| format |  | the date format | &nbsp; |
@@ -187,17 +185,18 @@ Transforms String Date from a [Week Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a separator string
-### dist/dates/adapters/yearToDate.js
+### dist/dates/helpers/getWeek.js
-#### yearToDate(yearDate, time)
+#### getWeek(date)
-Transforms String Date from a [Year] format to Date object.
+Gets the week number of the year
+Additionally, the month and the year
@@ -206,8 +205,7 @@ Transforms String Date from a [Year] format to Date object.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| yearDate |  | String of [Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
+| date |  | the date object | &nbsp; |
@@ -215,17 +213,20 @@ Transforms String Date from a [Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  an object with the week, month and year.
-### dist/dates/helpers/getDateByDateFormat.js
+### dist/dates/helpers/validateDate.js
-#### getDateByDateFormat(date, format, time)
+#### validateDate(date, format)
-Gets a Date Object instance by a 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
@@ -234,9 +235,8 @@ Gets a Date Object instance by a Date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | String with a formatted date | &nbsp; |
-| format |  | The date format | &nbsp; |
-| time |  | flag to convert the formatted date to miliseconds | &nbsp; |
+| date |  | String of date | &nbsp; |
+| format |  | String of the format to validate | &nbsp; |
@@ -244,17 +244,17 @@ Gets a Date Object instance by a Date format
 ##### Returns
--  a Date object, milisecond time or the same value if date format does not match.
+-  True if it is valid or not. Undefined if date is undefined
-### dist/dates/helpers/getDateFormatByProperty.js
+### dist/dates/helpers/validateDateByDateFormat.js
-#### getDateFormatByProperty(property)
+#### validateDateByDateFormat(date, dateForma)
-Gets the date format by the given property
+Validates the given string as Date by its date format.
@@ -263,7 +263,8 @@ Gets the date format by the given property
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| property |  | The Column Property | &nbsp; |
+| date |  | a string to validate as date form | &nbsp; |
+| dateForma |  | the format of the date to validate the string | &nbsp; |
@@ -271,17 +272,17 @@ Gets the date format by the given property
 ##### Returns
--  The date format
+-  true: the string is a valida date
-### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
+### dist/dates/adapters/mdyDateToDate.js
-#### getDateFormatRegularExpressionInArray(dateFormat)
+#### mdyDateToDate(monthYearDate, time)
-Gets an array of regular expressions by the given date format
+Transforms String Date from a [mm/dd/yyyy] format to Date object.
@@ -290,7 +291,8 @@ Gets an array of regular expressions by the given date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| dateFormat |  | the date format | &nbsp; |
+| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -298,17 +300,17 @@ Gets an array of regular expressions by the given date format
 ##### Returns
--  an array of regular expressions
+-  The date object or the date in milliseconds
-### dist/dates/helpers/getSeparatorByDateFormat.js
+### dist/dates/adapters/monthYearToDate.js
-#### getSeparatorByDateFormat(format)
+#### monthYearToDate(monthYearDate, time)
-Gets the separator of the date format
+Transforms String Date from a [Month Year] format to Date object.
@@ -317,7 +319,8 @@ Gets the separator of the date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| format |  | the date format | &nbsp; |
+| monthYearDate |  | String of [Month Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -325,18 +328,17 @@ Gets the separator of the date format
 ##### Returns
--  a separator string
+-  The date object or the date in milliseconds
-### dist/dates/helpers/getWeek.js
+### dist/dates/adapters/quarterYearToDate.js
-#### getWeek(date)
+#### quarterYearToDate(quarterYearDate, time)
-Gets the week number of the year
-Additionally, the month and the year
+Transforms String Date from a [Quarter Year] format to Date object.
@@ -345,7 +347,8 @@ Additionally, the month and the year
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | the date object | &nbsp; |
+| quarterYearDate |  | String of [Quarter Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -353,20 +356,17 @@ Additionally, the month and the year
 ##### Returns
--  an object with the week, month and year.
+-  The date object or the date in milliseconds
-### dist/dates/helpers/validateDate.js
+### dist/dates/adapters/weekYearToDate.js
-#### validateDate(date, format)
+#### weekYearToDate(date, time)
-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
+Transforms String Date from a [Week Year] format to Date object.
@@ -375,8 +375,8 @@ Validate a string date depending on giving format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | String of date | &nbsp; |
-| format |  | String of the format to validate | &nbsp; |
+| date |  | String of [Week Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -384,17 +384,17 @@ Validate a string date depending on giving format
 ##### Returns
--  True if it is valid or not. Undefined if date is undefined
+-  The date object or the date in milliseconds
-### dist/dates/helpers/validateDateByDateFormat.js
+### dist/dates/adapters/yearToDate.js
-#### validateDateByDateFormat(date, dateForma)
+#### yearToDate(yearDate, time)
-Validates the given string as Date by its date format.
+Transforms String Date from a [Year] format to Date object.
@@ -403,8 +403,8 @@ Validates the given string as Date by its date format.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | a string to validate as date form | &nbsp; |
-| dateForma |  | the format of the date to validate the string | &nbsp; |
+| yearDate |  | String of [Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -412,7 +412,65 @@ Validates the given string as Date by its date format.
 ##### Returns
--  true: the string is a valida date
+-  The date object or the date in milliseconds
+### dist/dates/range/getDateRange.js
+#### getDateRange(value, dateGroupLabel, withTime)
+Get date range object from a string date value
+##### Parameters
+| 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; |
+##### 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'
+}
+// 3) Month:
+getDateRange('Oct 2020', 'MONTH');
+// Will return:
+{
+   from: '10/01/2020 00:00:00',
+   to: '10/31/2020 23:59:59'
+}
+```
+##### Returns
+- `Object`  an object with the date range with two string date properties: from and to
@@ -630,12 +688,12 @@ Output:
-### dist/dates/range/getDateRange.js
+### dist/general/array/delete.js
-#### getDateRange(value, dateGroupLabel, withTime)
+#### ArrayDelete(array, index)
-Get date range object from a string date value
+Inmutable Array Item deletion
@@ -644,56 +702,29 @@ 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; |
-##### Examples
-```javascript
-// 1) Year:
-getDateRange('2020', 'YEAR');
-// Will return:
-{
-   from: '01/01/2020 00:00:00',
-   to: '12/31/2020 23:59:59'
-}
+| array | `Array`  | a collection of items to delete | &nbsp; |
+| index | `Number`  | the position of the item to delete | &nbsp; |
-// 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'
-}
-```
 ##### Returns
-- `Object`  an object with the date range with two string date properties: from and to
+-  a new Array or the given parameter when is empty or not an array
-### dist/filters/adapters/FDToFlatUI.js
+### dist/general/array/filterNestedTree.js
-#### FDToFlatUI(filterData, datasetsInfo)
+#### filterNestedTree(arr, childArrKey, condition)
-Generates a Flattened UI filter structure from Filter Data structure.
+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
@@ -702,8 +733,9 @@ 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; |
+| 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; |
@@ -711,13 +743,17 @@ Generates a Flattened UI filter structure from Filter Data structure.
 ##### Returns
--  a flattened UI filters array
+-  array filtered
-#### FD21ToFlatUI(scopes, datasetsInfo)
-Generates a Filter Builder Structure from the Filter Data structure v2.1
+### dist/general/array/flattenDeep.js
+#### flattenDeep(arr)
+Flat deeply an array
@@ -726,8 +762,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; |
+| arr |  | Array to flat deeply | &nbsp; |
@@ -735,17 +770,17 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 ##### Returns
--  a flattened UI filters array
+-  flatten array
-### dist/filters/adapters/FDToLogic.js
+### dist/general/array/getFirstIndexFromArray.js
-#### FDToLogic(filterData)
+#### getFirstIndexFromArray(array, callback)
-Generates a Filter Logic structure from Filter Data structure.
+Gets the first index from the array by a callback condition
@@ -754,7 +789,8 @@ Generates a Filter Logic structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -762,13 +798,17 @@ Generates a Filter Logic structure from Filter Data structure.
 ##### Returns
--  a filter logic array
+-  the first index of the array. -1 when the condition is not satisfied
-#### getLogicBodyFromFD21(filterData)
-Gets the logic body
+### dist/general/array/getLastIndexFromArray.js
+#### getLastIndexFromArray(array, callback)
+Gets the last index from the array by a callback condition
@@ -777,7 +817,8 @@ Gets the logic body
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -785,17 +826,17 @@ Gets the logic body
 ##### Returns
--  a filter logic array
+-  the last index of the array. -1 when the condition is not satisfied
-### dist/filters/adapters/FDToUI.js
+### dist/general/function/debounce.js
-#### FDToUI(filterData, datasetsInfo)
+#### debounce(fn, time)
-Generates a UI filter structure from Filter Data structure.
+Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
@@ -804,8 +845,8 @@ Generates a UI filter structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
@@ -813,13 +854,17 @@ Generates a UI filter structure from Filter Data structure.
 ##### Returns
--  a UI Filters structure
+- `Function`  debounced functions
-#### FD21ToUI(scopes, section, version, datasetsInfo)
-Generates a UI filter Structure from the Filter Data structure v2.1
+### dist/general/function/throttled.js
+#### throttled(fn, time)
+Make sure to only invokes _fn_ at most once per every _time_ milliseconds
@@ -828,10 +873,8 @@ Generates a UI filter Structure from the Filter Data structure v2.1
 | 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; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
@@ -839,17 +882,18 @@ Generates a UI filter Structure from the Filter Data structure v2.1
 ##### Returns
--  a UI filter Structure
+- `Function`  throttled function
-### dist/filters/adapters/UIToFD.js
+### dist/general/object/cloneDeep.js
-#### UIToFD(filterData)
+#### cloneDeep(obj)
-Generates a Filter Data Structure structure from UI Filter Data structure.
+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
@@ -858,7 +902,7 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
+| obj |  | The object | &nbsp; |
@@ -866,13 +910,21 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 ##### Returns
--  a Filter Data structure
+-  The new reference object or the given object if the parsing is incorrect or empty
-#### UI21ToFD(uFilterData, version)
-Builds the Fitler Data structure from UI filter data
+### 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.
@@ -881,26 +933,59 @@ Builds the Fitler Data structure from UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilterData |  | The UI filter Data object | &nbsp; |
-| version |  | the version of the structure | &nbsp; |
+| 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
--
+-  the resolved value.
-### dist/filters/adapters/UIToFlatUI.js
+### dist/general/object/getAttribute.js
-#### UIToFlatUI(filterData, datasetsInfo)
+#### getAttribute(obj, key)
-Generates a Flattened UI filter structure from UI Filter Data structure.
+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
@@ -909,22 +994,33 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &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
--  a flattened UI filters array
+- `Void`
-#### UI21ToFlatUI(scopes)
-Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
+### dist/general/object/hasProperty.js
+#### _hasProperty(obj, property)
+Use the hasOwnProperty in order to verify if the given property exists in the object.
@@ -933,26 +1029,38 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &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 flattened UI filters array
+-  True if the object has the given property; otherwise, false.
-### dist/filters/adapters/adaptDateGroupingProperty.js
+### dist/general/object/isObject.js
-#### adaptDateGroupingProperty(property)
+#### isObject(obj)
-[TODO: For 2022, eliminate this adapter]
-Get the new property base on the old date grouping properties
+Checks if the given argument is an object type
@@ -961,7 +1069,7 @@ Get the new property base on the old date grouping properties
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| property |  |  | &nbsp; |
+| obj |  | the variable to check | &nbsp; |
@@ -969,17 +1077,18 @@ Get the new property base on the old date grouping properties
 ##### Returns
--
+-  True: It is an object; False: It is not.
-### dist/filters/adapters/adaptFilterData.js
+### dist/general/object/mapValues.js
-#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
+#### mapValues(baseObject, iteratee)
-Checks and adapts the v2.0 Filter Data Structure to the v2.1
+Invoke iteratee (function) for each object key-value pair
+and return a mapped object
@@ -988,9 +1097,8 @@ 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; |
+| baseObject | `Object`  | Base object. | &nbsp; |
+| iteratee | `Function`  | The executed per iteration. | &nbsp; |
@@ -998,18 +1106,18 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
 ##### Returns
--  A new filter data structure v2.1
+- `Object`  New mapped object.
-### dist/filters/adapters/adaptFilterValues.js
+### dist/general/object/mergeDeep.js
-#### adaptFilterValues(filter)
+#### mergeDeep(obj1, obj2, settings)
-[TODO: For 2022, eliminate this adapter]
-Gets an adapted filter value array. Validates the enabled property and sets
+Merges two objects into a new one.
+The second given argument to the first given argument.
@@ -1018,7 +1126,9 @@ Gets an adapted filter value array. Validates the enabled property and sets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
+| settings |  | Object settings for this function | &nbsp; |
@@ -1026,17 +1136,13 @@ Gets an adapted filter value array. Validates the enabled property and sets
 ##### Returns
--  A new value array with the filled properties.
+-  a new merged object
-### dist/filters/adapters/flatUIToFD.js
-#### flatUIToFD(uFilters, version)
+#### isValid(obj1, obj2)
-Generates a filter data structure from the flatttened UI filters.
+Validates if the two arguments are objects
@@ -1045,8 +1151,8 @@ Generates a 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; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
@@ -1054,14 +1160,13 @@ Generates a filter data structure from the flatttened UI filters.
 ##### Returns
--  a Filter Data.
+-  true: they are valid; false: they are not
-#### buildScopes(fbFilters)
+#### getParamsToMergeDeep(settings)
-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
+Validates and gets the settings with all set parameters.
@@ -1070,7 +1175,7 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| settings |  | the settings object | &nbsp; |
@@ -1078,13 +1183,17 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+-  a new settings object with all set parameters.
-#### buildScope(uFilter)
-Gets an scope structure for the filter data
+### dist/general/object/objectCopy.js
+#### objectCopy(entity, cache)
+Created a new reference of the given argument
@@ -1093,7 +1202,8 @@ Gets an scope structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| entity |  | The variable to be copied | &nbsp; |
+| cache |  |  | &nbsp; |
@@ -1101,13 +1211,17 @@ Gets an scope structure for the filter data
 ##### Returns
--  an scope structure
+-  A new reference of the given argument
-#### buildDataset(uFilter)
-Gets an dataset structure for the filter data
+### dist/general/object/omit.js
+#### omit(obj, props)
+return a new Object excluding attributes in _props_ list
@@ -1116,7 +1230,8 @@ Gets an dataset structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| obj | `Object`  | base object | &nbsp; |
+| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
@@ -1124,13 +1239,17 @@ Gets an dataset structure for the filter data
 ##### Returns
--  an dataset structure
+- `Object`  clean object
-#### buildFilter(uFilter)
-Gets an filter structure for the filter data
+### dist/general/object/pick.js
+#### pick(baseObject, keys)
+return a new object just with attributes in _keys_ list
@@ -1139,7 +1258,8 @@ Gets an filter structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| baseObject | `Object`  | base object | &nbsp; |
+| keys | `Array.<String>`  | list of attributes to preserve | &nbsp; |
@@ -1147,17 +1267,17 @@ Gets an filter structure for the filter data
 ##### Returns
--  an filter structure
+- `Object`  new object just with desired attributes
-### dist/filters/adapters/flatUIToLogic.js
+### dist/general/object/serialize.js
-#### flatUIToLogic(uFilter)
+#### serialize(obj)
-Generates a Logic structure from flattened UI filters
+serialize object to url param
@@ -1166,7 +1286,7 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | Array of flat filters from UI | &nbsp; |
+| obj |  | - Object to be serialized | &nbsp; |
@@ -1174,17 +1294,17 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+- `Void`
-### dist/filters/adapters/flatUIToOldLogic.js
+### dist/general/string/capitalize.js
-#### flatUIToOldLogic(uFilters)
+#### capitalize(text)
-Generates a Logic structure from flattened UI filters
+Upper case the first letter of a given text
@@ -1193,7 +1313,7 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flat filters from UI | &nbsp; |
+| text | `String`  |  | &nbsp; |
@@ -1201,17 +1321,18 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+- `String`  a capitalized text
-### dist/filters/adapters/flatUIToUI.js
+### dist/general/mix/compareDeep.js
-#### flatUIToUI(uFilters, version)
+#### compareDeep(object1, object2)
-Generates a UI filter data structure from the flatttened UI filters.
+Compares two objects to know if they are equals. Go across nested objects.
+Includes arrays in the comparison.
@@ -1220,8 +1341,8 @@ 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; |
+| object1 |  | First Object to compare | &nbsp; |
+| object2 |  | Second Object to compare | &nbsp; |
@@ -1229,14 +1350,17 @@ Generates a UI filter data structure from the flatttened UI filters.
 ##### Returns
--  a UI Filter Data.
+-  True: objects are equal. False: Objects are not equal. Undefined: invalid
-#### 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
+### dist/general/mix/getTag.js
+#### getTag(value)
+Gets the `toStringTag` of `value`.
@@ -1245,7 +1369,7 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| value |  | The value to query. | &nbsp; |
@@ -1253,13 +1377,17 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+- `string`  Returns the `toStringTag`.
-#### buildScope(uFilter)
-Gets an scope structure for the UI filter data
+### dist/general/mix/importScripts.js
+#### importScripts(scripts)
+Import a set of external Scripts given the URL in both serie and cascade way
@@ -1268,21 +1396,54 @@ Gets an scope structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| scripts | `Array.<String>` `Array.<Object>`  | can be an array of string or an array of object with the follow structure: | &nbsp; |
+| scripts.url | `String`  | CDN URL | &nbsp; |
+| scripts.namespace | `String` `Function`  | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
+| scripts.type | `String`  | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
+| scripts.noModule | `Boolean`  | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
+| scripts.dependencies | `Array.<Object>`  | an array with the same structure to load in cascade mode | &nbsp; |
+##### Examples
+```javascript
+// 1) Simple script (paralell loading)
+importScripts(['http://myscript.js', 'http://another.js']);
+// 2) Loading `.js` and `.esm.js` script (parallel loading)
+importScripts([
+  { url: 'http://myscript.esm.js', type: 'module' },
+  { url: 'http://myscript.js', noModule: true }
+]);
+// 3) import dependent scripts (cascade)
+importScripts([
+  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
+]);
+// 4) mix
+importScripts([
+  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
+  { url: 'http://another.esm.js', type: 'module' },
+  { url: 'http://another.js', noModule: true },
+  'http://simplescript.js'
+]);
+```
 ##### Returns
--  an scope structure
+- `Promise`  Promise when all script have been loaded
-#### buildDataset(uFilter)
+#### loadScript(url, type, noModule)
-Gets an dataset structure for the UI filter data
+Creates the script element and appends to document.head
+return a Promise that is resolved when the script is loaded
@@ -1291,7 +1452,9 @@ Gets an dataset structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| url | `String`  | Cdn Url | &nbsp; |
+| type | `String`  | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
+| noModule | `boolean`  | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
@@ -1299,13 +1462,17 @@ Gets an dataset structure for the UI filter data
 ##### Returns
--  an dataset structure
+- `Void`
-#### buildFilter(uFilter)
-Gets an filter structure for the UI filter data
+### dist/general/mix/isEmpty.js
+#### isEmpty(variable, includeFalsy)
+Validates if the given argument is empty
@@ -1314,7 +1481,8 @@ Gets an filter structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| variable |  | the given variable | &nbsp; |
+| includeFalsy |  | flag to determine include the falsy variables into the validation | &nbsp; |
@@ -1322,17 +1490,19 @@ Gets an filter structure for the UI filter data
 ##### Returns
--  an filter structure
+-  true: the given argument is empty; false: is not.
-### dist/filters/adapters/logicToFD.js
+### dist/general/mix/isNaNV2.js
-#### logicToFD(filterData, version)
+#### isNaNV2(variable)
-Generates a filter data structure from the old logic structure (v2.0).
+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.
@@ -1341,8 +1511,7 @@ 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; |
+| variable |  | the variable to validate | &nbsp; |
@@ -1350,17 +1519,18 @@ Generates a filter data structure from the old logic structure (v2.0).
 ##### Returns
--  a Filter Data.
+-  True if variable is a NaN or false otherwise
-### dist/filters/adapters/logicToFlatUI.js
+### dist/general/mix/isNull.js
-#### logicToFlatUI(logics)
+#### isNull(arg)
-Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
+return if a given variable is either `null` or `undefined`
+useful to avoid falsify validating Number Zero (0)
@@ -1369,7 +1539,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; |
+| arg | `any`  |  | &nbsp; |
@@ -1377,13 +1547,19 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 ##### Returns
--  The Flattened UI Filters array
+- `Boolean`
-#### getFilter(filters, filter, getIndex)
-Get the filter or the index of the given array, validating an old filter structure.
+### 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.
@@ -1392,9 +1568,8 @@ 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; |
+| 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; |
@@ -1402,13 +1577,19 @@ Get the filter or the index of the given array, validating an old filter structu
 ##### Returns
--  the index or the UI filter object
+- `String`  Random string
-#### refineRankingValues(values, uiValues)
-Refines the values of the Ranking column type.
+### 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.
@@ -1417,8 +1598,7 @@ 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; |
+| obj | `Any`  | Any object-type variable | &nbsp; |
@@ -1426,17 +1606,17 @@ Refines the values of the Ranking column type.
 ##### Returns
--  the array of Ranking values
+- `Number`  the size of the given variable
-### dist/filters/adapters/logicToUI.js
+### dist/filters/adapters/FDToFlatUI.js
-#### logicToUI(uFilters, datasetsInfo)
+#### FDToFlatUI(filterData, datasetsInfo)
-Generates a UI filter structure from the old logic structure (v2.0).
+Generates a Flattened UI filter structure from Filter Data structure.
@@ -1445,7 +1625,7 @@ Generates a UI filter structure from the old logic structure (v2.0).
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of filters from old logic structure | &nbsp; |
+| filterData |  | The filter data object. | &nbsp; |
 | datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -1454,17 +1634,41 @@ Generates a UI filter structure from the old logic structure (v2.0).
 ##### Returns
--  a UI Filter Data.
+-  a flattened UI filters array
+#### FD21ToFlatUI(scopes, datasetsInfo)
-### dist/filters/adapters/transformFilters.js
+Generates a Filter Builder Structure from the Filter Data structure v2.1
-#### transformFilters(oldFiltersObj, section)
-Transform the old filters structure into the new one
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| scopes |  | The filter scope section | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
+##### Returns
+-  a flattened UI filters array
+### dist/filters/adapters/FDToLogic.js
+#### FDToLogic(filterData)
+Generates a Filter Logic structure from Filter Data structure.
@@ -1473,97 +1677,72 @@ 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; |
+| filterData |  | The filter data object. | &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
-  }
-};
+-  a filter logic array
-const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
-```
-##### Returns
+#### getLogicBodyFromFD21(filterData)
+Gets the logic body
-- `Object`  an object with the new filters structure
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filterData |  | The filter data object | &nbsp; |
-### dist/filters/classes/FilterInputErrorHandler.js
-#### new FilterInputErrorHandler()
+##### Returns
+-  a filter logic array
+### dist/filters/adapters/FDToUI.js
-##### Returns
+#### FDToUI(filterData, datasetsInfo)
+Generates a UI filter structure from Filter Data structure.
-- `Void`
+##### Parameters
-### dist/filters/helpers/applyHierarchyForAggFilters.js
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
-#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
-[TODO: Make a proper description for this function]
+##### Returns
+-  a UI Filters structure
+#### FD21ToUI(scopes, section, version, datasetsInfo)
+Generates a UI filter Structure from the Filter Data structure v2.1
@@ -1572,9 +1751,10 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &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; |
@@ -1582,17 +1762,17 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 ##### Returns
--
+-  a UI filter Structure
-### dist/filters/helpers/getAvailableScopes.js
+### dist/filters/adapters/UIToFD.js
-#### getAvailableScopes(config)
+#### UIToFD(filterData)
-Gets Scopes/Scope IDs by given IDs
+Generates a Filter Data Structure structure from UI Filter Data structure.
@@ -1601,7 +1781,7 @@ Gets Scopes/Scope IDs by given IDs
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | given Differnts IDs in order set a available scope | &nbsp; |
+| filterData |  | The UI filter data object. | &nbsp; |
@@ -1609,17 +1789,13 @@ Gets Scopes/Scope IDs by given IDs
 ##### Returns
--  a Scopes/Scope IDs array
+-  a Filter Data structure
-### dist/filters/helpers/getAvailableScopesIDsByConfig.js
-#### getAvailableScopesIDsByConfig(config)
+#### UI21ToFD(uFilterData, version)
-Gets the Scopes IDS for the Available Scope function by any config
+Builds the Fitler Data structure from UI filter data
@@ -1628,7 +1804,8 @@ Gets the Scopes IDS for the Available Scope function by any config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | any config | &nbsp; |
+| uFilterData |  | The UI filter Data object | &nbsp; |
+| version |  | the version of the structure | &nbsp; |
@@ -1636,17 +1813,17 @@ Gets the Scopes IDS for the Available Scope function by any config
 ##### Returns
--  a Available Scope IDS config
+-
-### dist/filters/helpers/getScopesByHierarchy.js
+### dist/filters/adapters/UIToFlatUI.js
-#### getScopesByHierarchy(scopes, currentScope)
+#### UIToFlatUI(filterData, datasetsInfo)
-[TODO: Make a description for this]
+Generates a Flattened UI filter structure from UI Filter Data structure.
@@ -1655,8 +1832,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; |
+| filterData |  | The UI filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
@@ -1664,17 +1841,13 @@ Gets the Scopes IDS for the Available Scope function by any config
 ##### Returns
--  A new array of Scopes/Scope IDs
+-  a flattened UI filters array
-### dist/general/array/delete.js
-#### ArrayDelete(array, index)
+#### UI21ToFlatUI(scopes)
-Inmutable Array Item deletion
+Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
@@ -1683,8 +1856,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; |
+| scopes |  | The filter scope section | &nbsp; |
@@ -1692,20 +1864,18 @@ Inmutable Array Item deletion
 ##### Returns
--  a new Array or the given parameter when is empty or not an array
+-  a flattened UI filters array
-### dist/general/array/filterNestedTree.js
+### dist/filters/adapters/adaptDateGroupingProperty.js
-#### filterNestedTree(arr, childArrKey, condition)
+#### adaptDateGroupingProperty(property)
-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
+[TODO: For 2022, eliminate this adapter]
+Get the new property base on the old date grouping properties
@@ -1714,9 +1884,7 @@ 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; |
+| property |  |  | &nbsp; |
@@ -1724,17 +1892,17 @@ Filters a nested tree array by a custom condition on the last child node
 ##### Returns
--  array filtered
+-
-### dist/general/array/flattenDeep.js
+### dist/filters/adapters/adaptFilterData.js
-#### flattenDeep(arr)
+#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
-Flat deeply an array
+Checks and adapts the v2.0 Filter Data Structure to the v2.1
@@ -1743,7 +1911,9 @@ Flat deeply an array
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply | &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; |
@@ -1751,17 +1921,17 @@ Flat deeply an array
 ##### Returns
--  flatten array
+-  A new filter data structure v2.1
-### dist/general/array/getFirstIndexFromArray.js
+### dist/filters/adapters/flatUIToFD.js
-#### getFirstIndexFromArray(array, callback)
+#### flatUIToFD(uFilters, version)
-Gets the first index from the array by a callback condition
+Generates a filter data structure from the flatttened UI filters.
@@ -1770,8 +1940,8 @@ Gets the first index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
@@ -1779,17 +1949,14 @@ 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
+-  a Filter Data.
-### dist/general/array/getLastIndexFromArray.js
-#### getLastIndexFromArray(array, callback)
+#### buildScopes(fbFilters)
-Gets the last index from the array by a callback condition
+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
@@ -1798,8 +1965,7 @@ Gets the last index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
@@ -1807,17 +1973,13 @@ 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
+-  an array of scopes structure.
-### dist/general/function/debounce.js
-#### debounce(fn, time)
+#### buildScope(uFilter)
-Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
+Gets an scope structure for the filter data
@@ -1826,8 +1988,7 @@ 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; |
+| uFilter |  | UI structure filter | &nbsp; |
@@ -1835,17 +1996,36 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
 ##### Returns
-- `Function`  debounced functions
+-  an scope structure
+#### buildDataset(uFilter)
-### dist/general/function/throttled.js
+Gets an dataset structure for the filter data
-#### throttled(fn, time)
-Make sure to only invokes _fn_ at most once per every _time_ milliseconds
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
+##### Returns
+-  an dataset structure
+#### buildFilter(uFilter)
+Gets an filter structure for the filter data
@@ -1854,8 +2034,7 @@ 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; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -1863,18 +2042,18 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 ##### Returns
-- `Function`  throttled function
+-  an filter structure
-### dist/general/mix/compareDeep.js
+### dist/filters/adapters/adaptFilterValues.js
-#### compareDeep(object1, object2)
+#### adaptFilterValues(filter)
-Compares two objects to know if they are equals. Go across nested objects.
-Includes arrays in the comparison.
+[TODO: For 2022, eliminate this adapter]
+Gets an adapted filter value array. Validates the enabled property and sets
@@ -1883,8 +2062,7 @@ Includes arrays in the comparison.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| object1 |  | First Object to compare | &nbsp; |
-| object2 |  | Second Object to compare | &nbsp; |
+| filter |  | The filter | &nbsp; |
@@ -1892,17 +2070,17 @@ Includes arrays in the comparison.
 ##### Returns
--  True: objects are equal. False: Objects are not equal. Undefined: invalid
+-  A new value array with the filled properties.
-### dist/general/mix/getTag.js
+### dist/filters/adapters/flatUIToLogic.js
-#### getTag(value)
+#### flatUIToLogic(uFilter)
-Gets the `toStringTag` of `value`.
+Generates a Logic structure from flattened UI filters
@@ -1911,7 +2089,7 @@ Gets the `toStringTag` of `value`.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value |  | The value to query. | &nbsp; |
+| uFilter |  | Array of flat filters from UI | &nbsp; |
@@ -1919,17 +2097,17 @@ Gets the `toStringTag` of `value`.
 ##### Returns
-- `string`  Returns the `toStringTag`.
+-  The logic structure
-### dist/general/mix/importScripts.js
+### dist/filters/adapters/flatUIToOldLogic.js
-#### importScripts(scripts)
+#### flatUIToOldLogic(uFilters)
-Import a set of external Scripts given the URL in both serie and cascade way
+Generates a Logic structure from flattened UI filters
@@ -1938,65 +2116,7 @@ Import a set of external Scripts given the URL in both serie and cascade way
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scripts | `Array.<String>` `Array.<Object>`  | can be an array of string or an array of object with the follow structure: | &nbsp; |
-| scripts.url | `String`  | CDN URL | &nbsp; |
-| scripts.namespace | `String` `Function`  | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
-| scripts.type | `String`  | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
-| scripts.noModule | `Boolean`  | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
-| scripts.dependencies | `Array.<Object>`  | an array with the same structure to load in cascade mode | &nbsp; |
-##### Examples
-```javascript
-// 1) Simple script (paralell loading)
-importScripts(['http://myscript.js', 'http://another.js']);
-// 2) Loading `.js` and `.esm.js` script (parallel loading)
-importScripts([
-  { url: 'http://myscript.esm.js', type: 'module' },
-  { url: 'http://myscript.js', noModule: true }
-]);
-// 3) import dependent scripts (cascade)
-importScripts([
-  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
-]);
-// 4) mix
-importScripts([
-  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
-  { url: 'http://another.esm.js', type: 'module' },
-  { url: 'http://another.js', noModule: true },
-  'http://simplescript.js'
-]);
-```
-##### Returns
-- `Promise`  Promise when all script have been loaded
-#### loadScript(url, type, noModule)
-Creates the script element and appends to document.head
-return a Promise that is resolved when the script is loaded
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| url | `String`  | Cdn Url | &nbsp; |
-| type | `String`  | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
-| noModule | `boolean`  | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
+| uFilters |  | Array of flat filters from UI | &nbsp; |
@@ -2004,47 +2124,17 @@ return a Promise that is resolved when the script is loaded
 ##### Returns
-- `Void`
-### dist/general/mix/isEmpty.js
-#### isEmpty(variable, includeFalsy)
-Validates if the given argument is empty
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| variable |  | the given variable | &nbsp; |
-| includeFalsy |  | flag to determine include the falsy variables into the validation | &nbsp; |
-##### Returns
--  true: the given argument is empty; false: is not.
+-  The logic structure
-### dist/general/mix/isNaNV2.js
+### dist/filters/adapters/flatUIToUI.js
-#### isNaNV2(variable)
+#### flatUIToUI(uFilters, version)
-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.
+Generates a UI filter data structure from the flatttened UI filters.
@@ -2053,7 +2143,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| variable |  | the variable to validate | &nbsp; |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
@@ -2061,18 +2152,14 @@ Validates if variable is null, undefined, or an empty string, also, the function
 ##### Returns
--  True if variable is a NaN or false otherwise
+-  a UI Filter Data.
-### dist/general/mix/isNull.js
-#### isNull(arg)
+#### buildScopes(fbFilters)
-return if a given variable is either `null` or `undefined`
-useful to avoid falsify validating Number Zero (0)
+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
@@ -2081,7 +2168,7 @@ useful to avoid falsify validating Number Zero (0)
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arg | `any`  |  | &nbsp; |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
@@ -2089,19 +2176,13 @@ useful to avoid falsify validating Number Zero (0)
 ##### Returns
-- `Boolean`
+-  an array of scopes structure.
-### dist/general/mix/randomId.js
-#### randomId(length, exclude)
+#### buildScope(uFilter)
-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.
+Gets an scope structure for the UI filter data
@@ -2110,8 +2191,7 @@ Creates a random string
 | 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; |
+| uFilter |  | UI structure filter | &nbsp; |
@@ -2119,19 +2199,13 @@ Creates a random string
 ##### Returns
-- `String`  Random string
+-  an scope structure
-### dist/general/mix/size.js
-#### size(obj)
+#### buildDataset(uFilter)
-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.
+Gets an dataset structure for the UI filter data
@@ -2140,7 +2214,7 @@ Gets the length of the given array.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `Any`  | Any object-type variable | &nbsp; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -2148,18 +2222,13 @@ Gets the length of the given array.
 ##### Returns
-- `Number`  the size of the given variable
+-  an dataset structure
-### dist/general/object/cloneDeep.js
-#### cloneDeep(obj)
+#### buildFilter(uFilter)
-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
+Gets an filter structure for the UI filter data
@@ -2168,7 +2237,7 @@ Not to use this function with inner objects and functions
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | The object | &nbsp; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -2176,21 +2245,17 @@ Not to use this function with inner objects and functions
 ##### Returns
--  The new reference object or the given object if the parsing is incorrect or empty
+-  an filter structure
-### dist/general/object/get.js
+### dist/filters/adapters/logicToFD.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.
+#### logicToFD(filterData, version)
-Empty arrays and empty objects are returned but the defaultValue is not
-Undefined and null values will return the defaultValue.
+Generates a filter data structure from the old logic structure (v2.0).
@@ -2199,59 +2264,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; |
+| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &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.
+-  a Filter Data.
-### dist/general/object/getAttribute.js
+### dist/filters/adapters/logicToFlatUI.js
-#### getAttribute(obj, key)
+#### logicToFlatUI(logics)
-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
+Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
@@ -2260,33 +2292,21 @@ 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; |
+| logics |  | The old logic structure (v2.0) | &nbsp; |
-##### Examples
-```javascript
-getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-```
 ##### Returns
-- `Void`
+-  The Flattened UI Filters array
-### dist/general/object/hasProperty.js
-#### _hasProperty(obj, property)
+#### getFilter(filters, filter, getIndex)
-Use the hasOwnProperty in order to verify if the given property exists in the object.
+Get the filter or the index of the given array, validating an old filter structure.
@@ -2295,38 +2315,23 @@ 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
+| 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; |
-```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.
+-  the index or the UI filter object
-### dist/general/object/isObject.js
-#### isObject(obj)
+#### refineRankingValues(values, uiValues)
-Checks if the given argument is an object type
+Refines the values of the Ranking column type.
@@ -2335,7 +2340,8 @@ Checks if the given argument is an object type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | the variable to check | &nbsp; |
+| values |  | the Array of Ranking values | &nbsp; |
+| uiValues |  | Object with additional info about the values of the filter. | &nbsp; |
@@ -2343,18 +2349,17 @@ Checks if the given argument is an object type
 ##### Returns
--  True: It is an object; False: It is not.
+-  the array of Ranking values
-### dist/general/object/mapValues.js
+### dist/filters/adapters/logicToUI.js
-#### mapValues(baseObject, iteratee)
+#### logicToUI(uFilters, datasetsInfo)
-Invoke iteratee (function) for each object key-value pair
-and return a mapped object
+Generates a UI filter structure from the old logic structure (v2.0).
@@ -2363,8 +2368,8 @@ and return a mapped object
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | Base object. | &nbsp; |
-| iteratee | `Function`  | The executed per iteration. | &nbsp; |
+| uFilters |  | Array of filters from old logic structure | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -2372,43 +2377,17 @@ and return a mapped object
 ##### Returns
-- `Object`  New mapped object.
-### dist/general/object/mergeDeep.js
-#### mergeDeep(obj1, obj2, settings)
-Merges two objects into a new one.
-The second given argument to the first given argument.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
-| settings |  | Object settings for this function | &nbsp; |
+-  a UI Filter Data.
-##### Returns
--  a new merged object
+### dist/filters/adapters/transformFilters.js
-#### isValid(obj1, obj2)
+#### transformFilters(oldFiltersObj, section)
-Validates if the two arguments are objects
+Transform the old filters structure into the new one
@@ -2417,59 +2396,79 @@ Validates if the two arguments are objects
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
-##### Returns
--  true: they are valid; false: they are not
-#### getParamsToMergeDeep(settings)
-Validates and gets the settings with all set parameters.
+| 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; |
-##### Parameters
+##### Examples
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| settings |  | the settings object | &nbsp; |
+```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
--  a new settings object with all set parameters.
+- `Object`  an object with the new filters structure
-### dist/general/object/objectCopy.js
-#### objectCopy(entity, cache)
+### dist/filters/classes/FilterInputErrorHandler.js
-Created a new reference of the given argument
+#### new FilterInputErrorHandler()
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| entity |  | The variable to be copied | &nbsp; |
-| cache |  |  | &nbsp; |
@@ -2477,17 +2476,17 @@ Created a new reference of the given argument
 ##### Returns
--  A new reference of the given argument
+- `Void`
-### dist/general/object/omit.js
+### dist/filters/helpers/applyHierarchyForAggFilters.js
-#### omit(obj, props)
+#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
-return a new Object excluding attributes in _props_ list
+[TODO: Make a proper description for this function]
@@ -2496,8 +2495,9 @@ return a new Object excluding attributes in _props_ list
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `Object`  | base object | &nbsp; |
-| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
+| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
+| scopes |  |  | &nbsp; |
+| currentScope |  |  | &nbsp; |
@@ -2505,17 +2505,17 @@ return a new Object excluding attributes in _props_ list
 ##### Returns
-- `Object`  clean object
+-
-### dist/general/object/pick.js
+### dist/filters/helpers/getAvailableScopes.js
-#### pick(baseObject, keys)
+#### getAvailableScopes(config)
-return a new object just with attributes in _keys_ list
+Gets Scopes/Scope IDs by given IDs
@@ -2524,8 +2524,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; |
+| config |  | given Differnts IDs in order set a available scope | &nbsp; |
@@ -2533,17 +2532,17 @@ return a new object just with attributes in _keys_ list
 ##### Returns
-- `Object`  new object just with desired attributes
+-  a Scopes/Scope IDs array
-### dist/general/object/serialize.js
+### dist/filters/helpers/getAvailableScopesIDsByConfig.js
-#### serialize(obj)
+#### getAvailableScopesIDsByConfig(config)
-serialize object to url param
+Gets the Scopes IDS for the Available Scope function by any config
@@ -2552,7 +2551,7 @@ serialize object to url param
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | - Object to be serialized | &nbsp; |
+| config |  | any config | &nbsp; |
@@ -2560,17 +2559,17 @@ serialize object to url param
 ##### Returns
-- `Void`
+-  a Available Scope IDS config
-### dist/general/string/capitalize.js
+### dist/filters/helpers/getScopesByHierarchy.js
-#### capitalize(text)
+#### getScopesByHierarchy(scopes, currentScope)
-Upper case the first letter of a given text
+[TODO: Make a description for this]
@@ -2579,7 +2578,8 @@ Upper case the first letter of a given text
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| text | `String`  |  | &nbsp; |
+| scopes |  | the collection of Scopes/Scope IDs | &nbsp; |
+| currentScope |  | Current scope type | &nbsp; |
@@ -2587,17 +2587,17 @@ Upper case the first letter of a given text
 ##### Returns
-- `String`  a capitalized text
+-  A new array of Scopes/Scope IDs
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/services/api/getAllDatasets.api.js
-#### getColumnLabels(column)
+#### getAllDatasets(config, pickDatasets)
-Get an string of the properties of the given column.
+Get a dataset list from a collection of Qrvey IDs
@@ -2606,7 +2606,8 @@ Get an string of the properties of the given column.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column | &nbsp; |
+| config |  | the widget config. Includes the appid and others configuration properties | &nbsp; |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request | &nbsp; |
@@ -2614,18 +2615,17 @@ Get an string of the properties of the given column.
 ##### Returns
--  an string with the property, aggregate or calculation label.
+-  a promise
-### dist/qrvey/helpers/getValueWithSuffixes.js
+### dist/services/api/getAllQrveys.api.js
-#### getValueWithSuffixes(value, suffixes)
+#### getAllQrveys(config, params)
-Get a string value with suffixes if available.
-Add suffix into the value string. Prioritized for numeric values.
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
@@ -2634,8 +2634,8 @@ Add suffix into the value string. Prioritized for numeric values.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value |  | a number or string | &nbsp; |
-| suffixes |  | An object with singular or plural suffix string. | &nbsp; |
+| config |  | Configuration | &nbsp; |
+| params |  | Object for getting precise data | &nbsp; |
@@ -2643,17 +2643,17 @@ Add suffix into the value string. Prioritized for numeric values.
 ##### Returns
--  a string value with suffix
+- `Void`
-### dist/qrvey/helpers/transformValue.js
+### dist/services/api/getDatasetColumns.api.js
-#### transformValue(value, settings)
+#### getDatasetColumns(qrveyid)
-Transforms a value depending of localization/globalization and extras settings.
+Get a dataset by Qrvey ID
@@ -2662,8 +2662,7 @@ Transforms a value depending of localization/globalization and extras settings.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value |  | A value to transform | &nbsp; |
-| settings |  | The settings of the transformValue function | &nbsp; |
+| qrveyid |  | The Qrvey ID | &nbsp; |
@@ -2671,13 +2670,17 @@ Transforms a value depending of localization/globalization and extras settings.
 ##### Returns
--  A transformed value
+-  a promise
-#### getOutputFormat(settings)
-Gets the outputformat settings
+### dist/qrvey/helpers/getColumnsLabel.js
+#### getColumnLabels(column)
+Get an string of the properties of the given column.
@@ -2686,7 +2689,7 @@ Gets the outputformat settings
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | The settings of the transformValue function | &nbsp; |
+| column |  | The column | &nbsp; |
@@ -2694,13 +2697,18 @@ Gets the outputformat settings
 ##### Returns
--  the outputformat settings
+-  an string with the property, aggregate or calculation label.
-#### getFormatConfig(settings)
-Gets the format config
+### dist/qrvey/helpers/getValueWithSuffixes.js
+#### getValueWithSuffixes(value, suffixes)
+Get a string value with suffixes if available.
+Add suffix into the value string. Prioritized for numeric values.
@@ -2709,7 +2717,8 @@ Gets the format config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | The settings of the transformValue function | &nbsp; |
+| value |  | a number or string | &nbsp; |
+| suffixes |  | An object with singular or plural suffix string. | &nbsp; |
@@ -2717,17 +2726,17 @@ Gets the format config
 ##### Returns
--  the format config
+-  a string value with suffix
-### dist/services/api/getAllDatasets.api.js
+### dist/qrvey/helpers/transformValue.js
-#### getAllDatasets(config, pickDatasets)
+#### transformValue(value, settings)
-Get a dataset list from a collection of Qrvey IDs
+Transforms a value depending of localization/globalization and extras settings.
@@ -2736,8 +2745,8 @@ Get a dataset list from a collection of Qrvey IDs
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | the widget config. Includes the appid and others configuration properties | &nbsp; |
-| pickDatasets |  | Collection of Qrvey IDs for filtering the request | &nbsp; |
+| value |  | A value to transform | &nbsp; |
+| settings |  | The settings of the transformValue function | &nbsp; |
@@ -2745,17 +2754,13 @@ Get a dataset list from a collection of Qrvey IDs
 ##### Returns
--  a promise
+-  A transformed value
-### dist/services/api/getAllQrveys.api.js
-#### getAllQrveys(config, params)
+#### getOutputFormat(settings)
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+Gets the outputformat settings
@@ -2764,8 +2769,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; |
+| settings |  | The settings of the transformValue function | &nbsp; |
@@ -2773,17 +2777,13 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
-- `Void`
+-  the outputformat settings
-### dist/services/api/getDatasetColumns.api.js
-#### getDatasetColumns(qrveyid)
+#### getFormatConfig(settings)
-Get a dataset by Qrvey ID
+Gets the format config
@@ -2792,7 +2792,7 @@ Get a dataset by Qrvey ID
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID | &nbsp; |
+| settings |  | The settings of the transformValue function | &nbsp; |
@@ -2800,7 +2800,7 @@ Get a dataset by Qrvey ID
 ##### Returns
--  a promise
+-  the format config
@@ -2889,12 +2889,12 @@ try to find this string as a variable on Windows object
-### dist/typescript/decorators/Throttled.js
+### dist/typescript/decorators/Debounce.js
-#### Throttled(time)
+#### Debounce(time)
-(Method Decorator) Throttled Class Method
+(Method Decorator) Debounce Class Method
@@ -2916,12 +2916,12 @@ try to find this string as a variable on Windows object
-### dist/typescript/decorators/Debounce.js
+### dist/typescript/decorators/Throttled.js
-#### Debounce(time)
+#### Throttled(time)
-(Method Decorator) Debounce Class Method
+(Method Decorator) Throttled Class Method
@@ -3025,33 +3025,6 @@ Parses a string date and returns a dayjs date
-### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
-#### getFilterBuilderGeneralConfig(config)
-Returns a filter builder config object by a any given config
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | any config object | &nbsp; |
-##### Returns
--  The filter builder config object
 ### dist/filters/helpers/backend/buildExpression.js
@@ -3348,12 +3321,12 @@ Gets filters from the logic by the scopes hierarchy.
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
-#### areFiltersEquals(filter1, filter2)
+#### getFilterBuilderGeneralConfig(config)
-Validates if both filters are the same
+Returns a filter builder config object by a any given config
@@ -3362,8 +3335,7 @@ Validates if both filters are the same
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 | &nbsp; |
-| filter2 |  | filter 2 | &nbsp; |
+| config |  | any config object | &nbsp; |
@@ -3371,7 +3343,7 @@ Validates if both filters are the same
 ##### Returns
--  true: the filters are equal; false: the filters are NOT equal
+-  The filter builder config object
@@ -3403,6 +3375,34 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
+### dist/filters/helpers/common/areFiltersEquals.js
+#### areFiltersEquals(filter1, filter2)
+Validates if both filters are the same
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter1 |  | filter 1 | &nbsp; |
+| filter2 |  | filter 2 | &nbsp; |
+##### Returns
+-  true: the filters are equal; false: the filters are NOT equal
 ### dist/filters/helpers/common/excludeFiltersByParams.js
@@ -3817,12 +3817,12 @@ Validates if the given validator is a Between type
-### dist/filters/helpers/common/isDateDistinctProperty.js
+### dist/filters/helpers/common/isInValidator.js
-#### isDateDistinctProperty(column, property)
+#### isInValidator(validator)
-Determines if the filter column and property is a distinct group dates type
+Validates if the given validator is a In type
@@ -3831,8 +3831,7 @@ Determines if the filter column and property is a distinct group dates type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column | &nbsp; |
-| property |  | The filter property | &nbsp; |
+| validator |  | The validator | &nbsp; |
@@ -3840,17 +3839,17 @@ Determines if the filter column and property is a distinct group dates type
 ##### Returns
--  True if the given property is included from distinct group dates type
+-  true: it is a In validator; false: it is not a In validator
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/isDateDistinctProperty.js
-#### isInValidator(validator)
+#### isDateDistinctProperty(column, property)
-Validates if the given validator is a In type
+Determines if the filter column and property is a distinct group dates type
@@ -3859,7 +3858,8 @@ Validates if the given validator is a In type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator | &nbsp; |
+| column |  | The filter column | &nbsp; |
+| property |  | The filter property | &nbsp; |
@@ -3867,7 +3867,7 @@ Validates if the given validator is a In type
 ##### Returns
--  true: it is a In validator; false: it is not a In validator
+-  True if the given property is included from distinct group dates type
@@ -4082,10 +4082,10 @@ Gets a new value structure array by merging two value structures
-### dist/filters/helpers/common/resolveDatasetConditions.js
+### dist/filters/helpers/common/resolveFilterConditions.js
-#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
+#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
 Resolves the conditions by given params
@@ -4096,8 +4096,8 @@ Resolves the conditions by given params
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The dataset structure | &nbsp; |
-| params |  | given parameters to validate the dataset | &nbsp; |
+| filter |  | The filter | &nbsp; |
+| params |  | given parameters to validate the filter | &nbsp; |
 | letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
 | letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
@@ -4112,10 +4112,10 @@ Resolves the conditions by given params
-### dist/filters/helpers/common/resolveFilterConditions.js
+### dist/filters/helpers/common/resolveDatasetConditions.js
-#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
+#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
 Resolves the conditions by given params
@@ -4126,8 +4126,8 @@ Resolves the conditions by given params
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
-| params |  | given parameters to validate the filter | &nbsp; |
+| filter |  | The dataset structure | &nbsp; |
+| params |  | given parameters to validate the dataset | &nbsp; |
 | letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
 | letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
@@ -4199,12 +4199,12 @@ Excludes Aggregate Filters in the Flattened UI Filters array
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+### dist/filters/helpers/ui/getFilterPropertyLabel.js
-#### excludeUIFlatFiltersByScopes(uFilters, scopes)
+#### getFilterPropertyLabel(filter)
-Excludes and returns a UI Flat Filters without filters by the given scopes
+Gets the label of the filter property
@@ -4213,8 +4213,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters | &nbsp; |
-| scopes |  | collection of scopes types | &nbsp; |
+| filter |  | The UI Filter | &nbsp; |
@@ -4222,17 +4221,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 ##### Returns
--  The new array of UI Flattened filters
+-  a string of the filter property label
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
-#### getFilterPropertyLabel(filter)
+#### excludeUIFlatFiltersByScopes(uFilters, scopes)
-Gets the label of the filter property
+Excludes and returns a UI Flat Filters without filters by the given scopes
@@ -4241,7 +4240,8 @@ Gets the label of the filter property
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter | &nbsp; |
+| uFilters |  | The Flatten UI Filters | &nbsp; |
+| scopes |  | collection of scopes types | &nbsp; |
@@ -4249,7 +4249,7 @@ Gets the label of the filter property
 ##### Returns
--  a string of the filter property label
+-  The new array of UI Flattened filters