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

@qrvey/utils 1.2.9-34 → 1.2.9-37

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

package/README.md CHANGED Viewed

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