npm - @qrvey/utils - Versions diffs - 1.2.9-5 → 1.2.9-6 - Mend

@qrvey/utils 1.2.9-5 → 1.2.9-6

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

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-5*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-6*
 > 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/filters/adapters/FDToFlatUI.js
-#### mdyDateToDate(monthYearDate, time)
+#### FDToFlatUI(filterData, datasetsInfo)
-Transforms String Date from a [mm/dd/yyyy] format to Date object.
+Generates a Flattened UI filter structure from Filter Data structure.
@@ -94,8 +94,8 @@ 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; |
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -103,17 +103,13 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a flattened UI filters array
-### dist/dates/adapters/monthYearToDate.js
-#### monthYearToDate(monthYearDate, time)
+#### FD21ToFlatUI(scopes, datasetsInfo)
-Transforms String Date from a [Month Year] format to Date object.
+Generates a Filter Builder Structure from the Filter Data structure v2.1
@@ -122,8 +118,8 @@ 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; |
+| scopes |  | The filter scope section | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -131,17 +127,17 @@ Transforms String Date from a [Month Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a flattened UI filters array
-### dist/dates/adapters/quarterYearToDate.js
+### dist/filters/adapters/FDToLogic.js
-#### quarterYearToDate(quarterYearDate, time)
+#### FDToLogic(filterData)
-Transforms String Date from a [Quarter Year] format to Date object.
+Generates a Filter Logic structure from Filter Data structure.
@@ -150,8 +146,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; |
+| filterData |  | The filter data object. | &nbsp; |
@@ -159,17 +154,13 @@ Transforms String Date from a [Quarter Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a filter logic array
-### dist/dates/adapters/weekYearToDate.js
-#### weekYearToDate(date, time)
+#### getLogicBodyFromFD21(filterData)
-Transforms String Date from a [Week Year] format to Date object.
+Gets the logic body
@@ -178,8 +169,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; |
+| filterData |  | The filter data object | &nbsp; |
@@ -187,17 +177,17 @@ Transforms String Date from a [Week Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a filter logic array
-### dist/dates/adapters/yearToDate.js
+### dist/filters/adapters/FDToUI.js
-#### yearToDate(yearDate, time)
+#### FDToUI(filterData, datasetsInfo)
-Transforms String Date from a [Year] format to Date object.
+Generates a UI filter structure from Filter Data structure.
@@ -206,8 +196,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; |
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -215,17 +205,13 @@ Transforms String Date from a [Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a UI Filters structure
-### dist/dates/helpers/getDateByDateFormat.js
-#### getDateByDateFormat(date, format, time)
+#### FD21ToUI(scopes, section, version, datasetsInfo)
-Gets a Date Object instance by a Date format
+Generates a UI filter Structure from the Filter Data structure v2.1
@@ -234,9 +220,10 @@ 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; |
+| 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; |
@@ -244,17 +231,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.
+-  a UI filter Structure
-### dist/dates/helpers/getDateFormatByProperty.js
+### dist/filters/adapters/UIToFD.js
-#### getDateFormatByProperty(property)
+#### UIToFD(filterData)
-Gets the date format by the given property
+Generates a Filter Data Structure structure from UI Filter Data structure.
@@ -263,7 +250,7 @@ Gets the date format by the given property
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| property |  | The Column Property | &nbsp; |
+| filterData |  | The UI filter data object. | &nbsp; |
@@ -271,17 +258,13 @@ Gets the date format by the given property
 ##### Returns
--  The date format
+-  a Filter Data structure
-### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
-#### getDateFormatRegularExpressionInArray(dateFormat)
+#### UI21ToFD(uFilterData, version)
-Gets an array of regular expressions by the given date format
+Builds the Fitler Data structure from UI filter data
@@ -290,7 +273,8 @@ Gets an array of regular expressions by the given date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| dateFormat |  | the date format | &nbsp; |
+| uFilterData |  | The UI filter Data object | &nbsp; |
+| version |  | the version of the structure | &nbsp; |
@@ -298,17 +282,17 @@ Gets an array of regular expressions by the given date format
 ##### Returns
--  an array of regular expressions
+-
-### dist/dates/helpers/getSeparatorByDateFormat.js
+### dist/filters/adapters/UIToFlatUI.js
-#### getSeparatorByDateFormat(format)
+#### UIToFlatUI(filterData, datasetsInfo)
-Gets the separator of the date format
+Generates a Flattened UI filter structure from UI Filter Data structure.
@@ -317,7 +301,8 @@ Gets the separator of the date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| format |  | the date format | &nbsp; |
+| filterData |  | The UI filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
@@ -325,18 +310,13 @@ Gets the separator of the date format
 ##### Returns
--  a separator string
+-  a flattened UI filters array
-### dist/dates/helpers/getWeek.js
-#### getWeek(date)
+#### UI21ToFlatUI(scopes)
-Gets the week number of the year
-Additionally, the month and the year
+Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
@@ -345,7 +325,7 @@ Additionally, the month and the year
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | the date object | &nbsp; |
+| scopes |  | The filter scope section | &nbsp; |
@@ -353,20 +333,18 @@ Additionally, the month and the year
 ##### Returns
--  an object with the week, month and year.
+-  a flattened UI filters array
-### dist/dates/helpers/validateDate.js
+### dist/filters/adapters/adaptDateGroupingProperty.js
-#### validateDate(date, format)
+#### adaptDateGroupingProperty(property)
-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
+[TODO: For 2022, eliminate this adapter]
+Get the new property base on the old date grouping properties
@@ -375,8 +353,7 @@ Validate a string date depending on giving format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | String of date | &nbsp; |
-| format |  | String of the format to validate | &nbsp; |
+| property |  |  | &nbsp; |
@@ -384,17 +361,17 @@ Validate a string date depending on giving format
 ##### Returns
--  True if it is valid or not. Undefined if date is undefined
+-
-### dist/dates/helpers/validateDateByDateFormat.js
+### dist/filters/adapters/adaptFilterData.js
-#### validateDateByDateFormat(date, dateForma)
+#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
-Validates the given string as Date by its date format.
+Checks and adapts the v2.0 Filter Data Structure to the v2.1
@@ -403,8 +380,9 @@ 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; |
+| 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; |
@@ -412,17 +390,18 @@ Validates the given string as Date by its date format.
 ##### Returns
--  true: the string is a valida date
+-  A new filter data structure v2.1
-### dist/dates/range/getDateRange.js
+### dist/filters/adapters/adaptFilterValues.js
-#### getDateRange(value, dateGroupLabel, withTime)
+#### adaptFilterValues(filter)
-Get date range object from a string date value
+[TODO: For 2022, eliminate this adapter]
+Gets an adapted filter value array. Validates the enabled property and sets
@@ -431,74 +410,59 @@ 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; |
+| filter |  | The filter | &nbsp; |
-##### Examples
+##### Returns
-```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'
-}
+-  A new value array with the filled properties.
-// 3) Month:
-getDateRange('Oct 2020', 'MONTH');
-// Will return:
-{
-   from: '10/01/2020 00:00:00',
-   to: '10/31/2020 23:59:59'
-}
-```
-##### Returns
+### dist/filters/adapters/flatUIToFD.js
-- `Object`  an object with the date range with two string date properties: from and to
+#### flatUIToFD(uFilters, version)
+Generates a filter data structure from the flatttened UI filters.
-### dist/dates/relative/Adapter.js
-#### value()
+##### Parameters
-Resolves statement and returns statement value
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
+##### Returns
-##### Returns
+-  a Filter Data.
-- `AbsoluteRange` `string`
+#### 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
-#### valueAsAnchor()
-Resolves statement as an anchor
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
@@ -506,77 +470,86 @@ Resolves statement as an anchor
 ##### Returns
-- `string`
+-  an array of scopes structure.
-#### _statementToRange()  *private method*
+#### buildScope(uFilter)
-Convert verbal statement to range value
+Gets an scope structure for the filter data
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | UI structure filter | &nbsp; |
-##### Returns
-- `AbsoluteRange`
+##### Returns
-#### _resolveAsThis()  *private method*
+-  an scope structure
-Apply 'this' cursor logic to statement
+#### buildDataset(uFilter)
+Gets an dataset structure for the filter data
-##### Returns
+##### Parameters
-- `AbsoluteStatement`
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
-#### _resolveAsTheLast()  *private method*
-Apply 'the last' cursor logic to statement
+##### Returns
+-  an dataset structure
+#### buildFilter(uFilter)
-##### Returns
+Gets an filter structure for the filter data
-- `AbsoluteStatement`
+##### Parameters
-#### _resolveAsTheNext()  *private method*
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | a UI structure filter | &nbsp; |
-Apply 'the next' cursor logic to statement
+##### Returns
+-  an filter structure
-##### Returns
-- `AbsoluteStatement`
+### dist/filters/adapters/flatUIToLogic.js
-#### replaceNowToken(value, now)
+#### flatUIToLogic(uFilter)
-Replace '@now' token inside a string
+Generates a Logic structure from flattened UI filters
@@ -585,8 +558,7 @@ Replace '@now' token inside a string
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value | `string`  |  | &nbsp; |
-| now | `Date`  |  | &nbsp; |
+| uFilter |  | Array of flat filters from UI | &nbsp; |
@@ -594,60 +566,44 @@ Replace '@now' token inside a string
 ##### Returns
-- `string`
+-  The logic structure
-#### convertRelativeToAbsolute(args)
-Returns a range object (date) from a group of statement params
+### dist/filters/adapters/flatUIToOldLogic.js
+#### flatUIToOldLogic(uFilters)
+Generates a Logic structure from flattened UI filters
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| args | `RelativeToAbsoluteStruct`  |  | &nbsp; |
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Array of flat filters from UI | &nbsp; |
-##### Examples
-```javascript
-pivot = '2021-03-03T12:30:40'
-unit = month
-steps = 2
-setTo = END
-resolverAsCalendar: true
-=> Returns  '2021-05-31T23:59:59'
-```
-```javascript
-pivot = '2021-03-03T12:30:40'
-unit = month
-steps = -2
-setTo = START
-resolverAsCalendar: false
-=> Returns '2021-01-03T00:00:00'
-```
 ##### Returns
-- `string`
+-  The logic structure
-### dist/dates/relative/relative.js
+### dist/filters/adapters/flatUIToUI.js
-#### resolveRelative(statements, clock)
+#### flatUIToUI(uFilters, version)
-Resolve a list of relative statements according to operator
+Generates a UI filter data structure from the flatttened UI filters.
@@ -656,44 +612,23 @@ Resolve a list of relative statements according to operator
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
-| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
-##### Examples
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
-```javascript
-Input:
-{
- "cursor": "the_next",
- "unit": "year",
- "number": 1,
- "includeCurrent": false,
- "isCalendarDate": false,
- "anchor": "03/05/2021"
-}
-Output:
-{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
-```
 ##### Returns
-- `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
+-  a UI Filter Data.
-### dist/filters/adapters/FDToFlatUI.js
-#### FDToFlatUI(filterData, datasetsInfo)
+#### buildScopes(fbFilters)
-Generates a Flattened UI filter structure from Filter Data structure.
+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
@@ -702,8 +637,7 @@ Generates a Flattened UI filter structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
@@ -711,13 +645,13 @@ Generates a Flattened UI filter structure from Filter Data structure.
 ##### Returns
--  a flattened UI filters array
+-  an array of scopes structure.
-#### FD21ToFlatUI(scopes, datasetsInfo)
+#### buildScope(uFilter)
-Generates a Filter Builder Structure from the Filter Data structure v2.1
+Gets an scope structure for the UI filter data
@@ -726,8 +660,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; |
+| uFilter |  | UI structure filter | &nbsp; |
@@ -735,17 +668,13 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 ##### Returns
--  a flattened UI filters array
+-  an scope structure
-### dist/filters/adapters/FDToLogic.js
-#### FDToLogic(filterData)
+#### buildDataset(uFilter)
-Generates a Filter Logic structure from Filter Data structure.
+Gets an dataset structure for the UI filter data
@@ -754,7 +683,7 @@ Generates a Filter Logic structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -762,13 +691,13 @@ Generates a Filter Logic structure from Filter Data structure.
 ##### Returns
--  a filter logic array
+-  an dataset structure
-#### getLogicBodyFromFD21(filterData)
+#### buildFilter(uFilter)
-Gets the logic body
+Gets an filter structure for the UI filter data
@@ -777,7 +706,7 @@ Gets the logic body
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -785,17 +714,17 @@ Gets the logic body
 ##### Returns
--  a filter logic array
+-  an filter structure
-### dist/filters/adapters/FDToUI.js
+### dist/filters/adapters/logicToFD.js
-#### FDToUI(filterData, datasetsInfo)
+#### logicToFD(filterData, version)
-Generates a UI filter structure from Filter Data structure.
+Generates a filter data structure from the old logic structure (v2.0).
@@ -804,8 +733,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; |
+| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
@@ -813,13 +742,17 @@ Generates a UI filter structure from Filter Data structure.
 ##### Returns
--  a UI Filters structure
+-  a Filter Data.
-#### FD21ToUI(scopes, section, version, datasetsInfo)
-Generates a UI filter Structure from the Filter Data structure v2.1
+### dist/filters/adapters/logicToFlatUI.js
+#### logicToFlatUI(logics)
+Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
@@ -828,10 +761,7 @@ 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; |
+| logics |  | The old logic structure (v2.0) | &nbsp; |
@@ -839,17 +769,13 @@ Generates a UI filter Structure from the Filter Data structure v2.1
 ##### Returns
--  a UI filter Structure
+-  The Flattened UI Filters array
-### dist/filters/adapters/UIToFD.js
-#### UIToFD(filterData)
+#### getFilter(filters, filter, getIndex)
-Generates a Filter Data Structure structure from UI Filter Data structure.
+Get the filter or the index of the given array, validating an old filter structure.
@@ -858,7 +784,9 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &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; |
@@ -866,13 +794,13 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 ##### Returns
--  a Filter Data structure
+-  the index or the UI filter object
-#### UI21ToFD(uFilterData, version)
+#### refineRankingValues(values, uiValues)
-Builds the Fitler Data structure from UI filter data
+Refines the values of the Ranking column type.
@@ -881,8 +809,8 @@ 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; |
+| values |  | the Array of Ranking values | &nbsp; |
+| uiValues |  | Object with additional info about the values of the filter. | &nbsp; |
@@ -890,17 +818,17 @@ Builds the Fitler Data structure from UI filter data
 ##### Returns
--
+-  the array of Ranking values
-### dist/filters/adapters/UIToFlatUI.js
+### dist/filters/adapters/logicToUI.js
-#### UIToFlatUI(filterData, datasetsInfo)
+#### logicToUI(uFilters, datasetsInfo)
-Generates a Flattened UI filter structure from UI Filter Data structure.
+Generates a UI filter structure from the old logic structure (v2.0).
@@ -909,8 +837,8 @@ 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; |
+| uFilters |  | Array of filters from old logic structure | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -918,13 +846,17 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
 ##### Returns
--  a flattened UI filters array
+-  a UI Filter Data.
-#### UI21ToFlatUI(scopes)
-Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
+### dist/filters/adapters/transformFilters.js
+#### transformFilters(oldFiltersObj, section)
+Transform the old filters structure into the new one
@@ -933,53 +865,97 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &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; |
-##### Returns
+##### Examples
+```javascript
--  a flattened UI filters array
+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
-### dist/filters/adapters/adaptDateGroupingProperty.js
+- `Object`  an object with the new filters structure
-#### adaptDateGroupingProperty(property)
-[TODO: For 2022, eliminate this adapter]
-Get the new property base on the old date grouping properties
+### dist/filters/classes/FilterInputErrorHandler.js
-##### Parameters
+#### new FilterInputErrorHandler()
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| property |  |  | &nbsp; |
-##### Returns
--
+##### Returns
+- `Void`
-### dist/filters/adapters/adaptFilterData.js
-#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
-Checks and adapts the v2.0 Filter Data Structure to the v2.1
+### dist/filters/helpers/applyHierarchyForAggFilters.js
+#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
+[TODO: Make a proper description for this function]
@@ -988,9 +964,9 @@ 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; |
+| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
+| scopes |  |  | &nbsp; |
+| currentScope |  |  | &nbsp; |
@@ -998,18 +974,17 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
 ##### Returns
--  A new filter data structure v2.1
+-
-### dist/filters/adapters/adaptFilterValues.js
+### dist/filters/helpers/getAvailableScopes.js
-#### adaptFilterValues(filter)
+#### getAvailableScopes(config)
-[TODO: For 2022, eliminate this adapter]
-Gets an adapted filter value array. Validates the enabled property and sets
+Gets Scopes/Scope IDs by given IDs
@@ -1018,7 +993,7 @@ Gets an adapted filter value array. Validates the enabled property and sets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
+| config |  | given Differnts IDs in order set a available scope | &nbsp; |
@@ -1026,17 +1001,17 @@ Gets an adapted filter value array. Validates the enabled property and sets
 ##### Returns
--  A new value array with the filled properties.
+-  a Scopes/Scope IDs array
-### dist/filters/adapters/flatUIToFD.js
+### dist/filters/helpers/getAvailableScopesIDsByConfig.js
-#### flatUIToFD(uFilters, version)
+#### getAvailableScopesIDsByConfig(config)
-Generates a filter data structure from the flatttened UI filters.
+Gets the Scopes IDS for the Available Scope function by any config
@@ -1045,8 +1020,7 @@ 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; |
+| config |  | any config | &nbsp; |
@@ -1054,14 +1028,17 @@ Generates a filter data structure from the flatttened UI filters.
 ##### Returns
--  a Filter Data.
+-  a Available Scope IDS config
-#### buildScopes(fbFilters)
-Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
-Also, adds and organizes filters by datasets
+### dist/filters/helpers/getScopesByHierarchy.js
+#### getScopesByHierarchy(scopes, currentScope)
+[TODO: Make a description for this]
@@ -1070,7 +1047,8 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| scopes |  | the collection of Scopes/Scope IDs | &nbsp; |
+| currentScope |  | Current scope type | &nbsp; |
@@ -1078,13 +1056,17 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+-  A new array of Scopes/Scope IDs
-#### buildScope(uFilter)
-Gets an scope structure for the filter data
+### dist/general/array/delete.js
+#### ArrayDelete(array, index)
+Inmutable Array Item deletion
@@ -1093,7 +1075,8 @@ Gets an scope structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| array | `Array`  | a collection of items to delete | &nbsp; |
+| index | `Number`  | the position of the item to delete | &nbsp; |
@@ -1101,13 +1084,20 @@ Gets an scope structure for the filter data
 ##### Returns
--  an scope structure
+-  a new Array or the given parameter when is empty or not an array
-#### buildDataset(uFilter)
-Gets an dataset structure for the 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
@@ -1116,7 +1106,9 @@ Gets an dataset structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &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; |
@@ -1124,13 +1116,17 @@ Gets an dataset structure for the filter data
 ##### Returns
--  an dataset structure
+-  array filtered
-#### buildFilter(uFilter)
-Gets an filter structure for the filter data
+### dist/general/array/flattenDeep.js
+#### flattenDeep(arr)
+Flat deeply an array
@@ -1139,7 +1135,7 @@ Gets an filter structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| arr |  | Array to flat deeply | &nbsp; |
@@ -1147,17 +1143,17 @@ Gets an filter structure for the filter data
 ##### Returns
--  an filter structure
+-  flatten array
-### dist/filters/adapters/flatUIToLogic.js
+### dist/general/array/getFirstIndexFromArray.js
-#### flatUIToLogic(uFilter)
+#### getFirstIndexFromArray(array, callback)
-Generates a Logic structure from flattened UI filters
+Gets the first index from the array by a callback condition
@@ -1166,7 +1162,8 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | Array of flat filters from UI | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -1174,17 +1171,17 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+-  the first index of the array. -1 when the condition is not satisfied
-### dist/filters/adapters/flatUIToOldLogic.js
+### dist/general/array/getLastIndexFromArray.js
-#### flatUIToOldLogic(uFilters)
+#### getLastIndexFromArray(array, callback)
-Generates a Logic structure from flattened UI filters
+Gets the last index from the array by a callback condition
@@ -1193,7 +1190,8 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flat filters from UI | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -1201,17 +1199,17 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+-  the last index of the array. -1 when the condition is not satisfied
-### dist/filters/adapters/flatUIToUI.js
+### dist/general/function/debounce.js
-#### flatUIToUI(uFilters, version)
+#### debounce(fn, time)
-Generates a UI filter data structure from the flatttened UI filters.
+Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
@@ -1220,8 +1218,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; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
@@ -1229,14 +1227,17 @@ Generates a UI filter data structure from the flatttened UI filters.
 ##### Returns
--  a UI Filter Data.
+- `Function`  debounced functions
-#### 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/function/throttled.js
+#### throttled(fn, time)
+Make sure to only invokes _fn_ at most once per every _time_ milliseconds
@@ -1245,7 +1246,8 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
@@ -1253,13 +1255,18 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+- `Function`  throttled function
-#### buildScope(uFilter)
-Gets an scope structure for the UI filter data
+### 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.
@@ -1268,7 +1275,8 @@ Gets an scope structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| object1 |  | First Object to compare | &nbsp; |
+| object2 |  | Second Object to compare | &nbsp; |
@@ -1276,13 +1284,17 @@ Gets an scope structure for the UI filter data
 ##### Returns
--  an scope structure
+-  True: objects are equal. False: Objects are not equal. Undefined: invalid
-#### buildDataset(uFilter)
-Gets an dataset structure for the UI filter data
+### dist/general/mix/getTag.js
+#### getTag(value)
+Gets the `toStringTag` of `value`.
@@ -1291,7 +1303,7 @@ Gets an dataset structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| value |  | The value to query. | &nbsp; |
@@ -1299,13 +1311,17 @@ Gets an dataset structure for the UI filter data
 ##### Returns
--  an dataset structure
+- `string`  Returns the `toStringTag`.
-#### buildFilter(uFilter)
-Gets an filter 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
@@ -1314,25 +1330,54 @@ Gets an filter structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a 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; |
-##### Returns
+##### Examples
+```javascript
+// 1) Simple script (paralell loading)
+importScripts(['http://myscript.js', 'http://another.js']);
--  an filter structure
+// 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
-### dist/filters/adapters/logicToFD.js
+- `Promise`  Promise when all script have been loaded
-#### logicToFD(filterData, version)
-Generates a filter data structure from the old logic structure (v2.0).
+#### loadScript(url, type, noModule)
+Creates the script element and appends to document.head
+return a Promise that is resolved when the script is loaded
@@ -1341,8 +1386,9 @@ Generates a filter data structure from the old logic structure (v2.0).
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
+| 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; |
@@ -1350,17 +1396,17 @@ Generates a filter data structure from the old logic structure (v2.0).
 ##### Returns
--  a Filter Data.
+- `Void`
-### dist/filters/adapters/logicToFlatUI.js
+### dist/general/mix/isEmpty.js
-#### logicToFlatUI(logics)
+#### isEmpty(variable, includeFalsy)
-Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
+Validates if the given argument is empty
@@ -1369,7 +1415,8 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The old logic structure (v2.0) | &nbsp; |
+| variable |  | the given variable | &nbsp; |
+| includeFalsy |  | flag to determine include the falsy variables into the validation | &nbsp; |
@@ -1377,13 +1424,19 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 ##### Returns
--  The Flattened UI Filters array
+-  true: the given argument is empty; false: is not.
-#### getFilter(filters, filter, getIndex)
-Get the filter or the index of the given array, validating an old filter structure.
+### dist/general/mix/isNaNV2.js
+#### isNaNV2(variable)
+Validates if the recieved number is NaN type.
+This function recieves any variable but will return false.
+Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
@@ -1392,9 +1445,7 @@ 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; |
+| variable |  | the variable to validate | &nbsp; |
@@ -1402,13 +1453,18 @@ Get the filter or the index of the given array, validating an old filter structu
 ##### Returns
--  the index or the UI filter object
+-  True if variable is a NaN or false otherwise
-#### refineRankingValues(values, uiValues)
-Refines the values of the Ranking column type.
+### dist/general/mix/isNull.js
+#### isNull(arg)
+return if a given variable is either `null` or `undefined`
+useful to avoid falsify validating Number Zero (0)
@@ -1417,8 +1473,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; |
+| arg | `any`  |  | &nbsp; |
@@ -1426,17 +1481,19 @@ Refines the values of the Ranking column type.
 ##### Returns
--  the array of Ranking values
+- `Boolean`
-### dist/filters/adapters/logicToUI.js
+### dist/general/mix/randomId.js
-#### logicToUI(uFilters, datasetsInfo)
+#### randomId(length, exclude)
-Generates a UI filter structure from the old logic structure (v2.0).
+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.
@@ -1445,8 +1502,8 @@ Generates a UI filter structure from the old logic structure (v2.0).
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of filters from old logic structure | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+| 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; |
@@ -1454,17 +1511,19 @@ Generates a UI filter structure from the old logic structure (v2.0).
 ##### Returns
--  a UI Filter Data.
+- `String`  Random string
-### dist/filters/adapters/transformFilters.js
+### dist/general/mix/size.js
-#### transformFilters(oldFiltersObj, section)
+#### size(obj)
-Transform the old filters structure into the new one
+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.
@@ -1473,79 +1532,34 @@ 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; |
+| obj | `Any`  | Any object-type variable | &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
-##### Returns
+- `Number`  the size of the given variable
-- `Object`  an object with the new filters structure
+### dist/general/string/capitalize.js
-### dist/filters/classes/FilterInputErrorHandler.js
+#### capitalize(text)
+Upper case the first letter of a given text
-#### new FilterInputErrorHandler()
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| text | `String`  |  | &nbsp; |
@@ -1553,17 +1567,18 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 ##### Returns
-- `Void`
+- `String`  a capitalized text
-### dist/filters/helpers/applyHierarchyForAggFilters.js
+### dist/general/object/cloneDeep.js
-#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
+#### cloneDeep(obj)
-[TODO: Make a proper description for this function]
+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
@@ -1572,9 +1587,7 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &nbsp; |
+| obj |  | The object | &nbsp; |
@@ -1582,17 +1595,21 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 ##### Returns
--
+-  The new reference object or the given object if the parsing is incorrect or empty
-### dist/filters/helpers/getAvailableScopes.js
+### dist/general/object/get.js
-#### getAvailableScopes(config)
+#### _get(baseObject, path, defaultValue)
-Gets Scopes/Scope IDs by given IDs
+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.
@@ -1601,25 +1618,59 @@ Gets Scopes/Scope IDs by given IDs
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | given Differnts IDs in order set a available scope | &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 Scopes/Scope IDs array
+-  the resolved value.
-### dist/filters/helpers/getAvailableScopesIDsByConfig.js
+### dist/general/object/getAttribute.js
-#### getAvailableScopesIDsByConfig(config)
+#### getAttribute(obj, key)
-Gets the Scopes IDS for the Available Scope function by any config
+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
@@ -1628,25 +1679,33 @@ Gets the Scopes IDS for the Available Scope function by any config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | any config | &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 Available Scope IDS config
+- `Void`
-### dist/filters/helpers/getScopesByHierarchy.js
+### dist/general/object/hasProperty.js
-#### getScopesByHierarchy(scopes, currentScope)
+#### _hasProperty(obj, property)
-[TODO: Make a description for this]
+Use the hasOwnProperty in order to verify if the given property exists in the object.
@@ -1655,26 +1714,38 @@ 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`  | 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 new array of Scopes/Scope IDs
+-  True if the object has the given property; otherwise, false.
-### dist/general/array/delete.js
+### dist/general/object/isObject.js
-#### ArrayDelete(array, index)
+#### isObject(obj)
-Inmutable Array Item deletion
+Checks if the given argument is an object type
@@ -1683,8 +1754,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; |
+| obj |  | the variable to check | &nbsp; |
@@ -1692,20 +1762,18 @@ Inmutable Array Item deletion
 ##### Returns
--  a new Array or the given parameter when is empty or not an array
+-  True: It is an object; False: It is not.
-### dist/general/array/filterNestedTree.js
+### dist/general/object/mapValues.js
-#### filterNestedTree(arr, childArrKey, condition)
+#### mapValues(baseObject, iteratee)
-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
+Invoke iteratee (function) for each object key-value pair
+and return a mapped object
@@ -1714,9 +1782,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; |
+| baseObject | `Object`  | Base object. | &nbsp; |
+| iteratee | `Function`  | The executed per iteration. | &nbsp; |
@@ -1724,17 +1791,18 @@ Filters a nested tree array by a custom condition on the last child node
 ##### Returns
--  array filtered
+- `Object`  New mapped object.
-### dist/general/array/flattenDeep.js
+### dist/general/object/mergeDeep.js
-#### flattenDeep(arr)
+#### mergeDeep(obj1, obj2, settings)
-Flat deeply an array
+Merges two objects into a new one.
+The second given argument to the first given argument.
@@ -1743,7 +1811,9 @@ Flat deeply an array
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
+| settings |  | Object settings for this function | &nbsp; |
@@ -1751,17 +1821,13 @@ Flat deeply an array
 ##### Returns
--  flatten array
+-  a new merged object
-### dist/general/array/getFirstIndexFromArray.js
-#### getFirstIndexFromArray(array, callback)
+#### isValid(obj1, obj2)
-Gets the first index from the array by a callback condition
+Validates if the two arguments are objects
@@ -1770,8 +1836,8 @@ Gets the first index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
@@ -1779,17 +1845,13 @@ 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
+-  true: they are valid; false: they are not
-### dist/general/array/getLastIndexFromArray.js
-#### getLastIndexFromArray(array, callback)
+#### getParamsToMergeDeep(settings)
-Gets the last index from the array by a callback condition
+Validates and gets the settings with all set parameters.
@@ -1798,8 +1860,7 @@ Gets the last index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| settings |  | the settings object | &nbsp; |
@@ -1807,17 +1868,17 @@ 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 new settings object with all set parameters.
-### dist/general/function/debounce.js
+### dist/general/object/objectCopy.js
-#### debounce(fn, time)
+#### objectCopy(entity, cache)
-Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
+Created a new reference of the given argument
@@ -1826,8 +1887,8 @@ 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; |
+| entity |  | The variable to be copied | &nbsp; |
+| cache |  |  | &nbsp; |
@@ -1835,17 +1896,17 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
 ##### Returns
-- `Function`  debounced functions
+-  A new reference of the given argument
-### dist/general/function/throttled.js
+### dist/general/object/omit.js
-#### throttled(fn, time)
+#### omit(obj, props)
-Make sure to only invokes _fn_ at most once per every _time_ milliseconds
+return a new Object excluding attributes in _props_ list
@@ -1854,8 +1915,8 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
+| obj | `Object`  | base object | &nbsp; |
+| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
@@ -1863,18 +1924,17 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 ##### Returns
-- `Function`  throttled function
+- `Object`  clean object
-### dist/general/object/cloneDeep.js
+### dist/general/object/pick.js
-#### cloneDeep(obj)
+#### pick(baseObject, keys)
-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
+return a new object just with attributes in _keys_ list
@@ -1883,7 +1943,8 @@ Not to use this function with inner objects and functions
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | The object | &nbsp; |
+| baseObject | `Object`  | base object | &nbsp; |
+| keys | `Array.<String>`  | list of attributes to preserve | &nbsp; |
@@ -1891,21 +1952,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
+- `Object`  new object just with desired attributes
-### dist/general/object/get.js
+### dist/general/object/serialize.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.
+#### serialize(obj)
-Empty arrays and empty objects are returned but the defaultValue is not
-Undefined and null values will return the defaultValue.
+serialize object to url param
@@ -1914,59 +1971,25 @@ 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; |
+| obj |  | - Object to be serialized | &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.
+- `Void`
-### dist/general/object/getAttribute.js
+### dist/dates/adapters/mdyDateToDate.js
-#### getAttribute(obj, key)
+#### mdyDateToDate(monthYearDate, time)
-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
+Transforms String Date from a [mm/dd/yyyy] format to Date object.
@@ -1975,33 +1998,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; |
+| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Examples
-```javascript
-getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-```
 ##### Returns
-- `Void`
+-  The date object or the date in milliseconds
-### dist/general/object/hasProperty.js
+### dist/dates/adapters/monthYearToDate.js
-#### _hasProperty(obj, property)
+#### monthYearToDate(monthYearDate, time)
-Use the hasOwnProperty in order to verify if the given property exists in the object.
+Transforms String Date from a [Month Year] format to Date object.
@@ -2010,38 +2026,26 @@ 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
+| monthYearDate |  | String of [Month Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &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 date object or the date in milliseconds
-### dist/general/object/isObject.js
+### dist/dates/adapters/quarterYearToDate.js
-#### isObject(obj)
+#### quarterYearToDate(quarterYearDate, time)
-Checks if the given argument is an object type
+Transforms String Date from a [Quarter Year] format to Date object.
@@ -2050,7 +2054,8 @@ Checks if the given argument is an object type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | the variable to check | &nbsp; |
+| quarterYearDate |  | String of [Quarter Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -2058,18 +2063,17 @@ Checks if the given argument is an object type
 ##### Returns
--  True: It is an object; False: It is not.
+-  The date object or the date in milliseconds
-### dist/general/object/mapValues.js
+### dist/dates/adapters/weekYearToDate.js
-#### mapValues(baseObject, iteratee)
+#### weekYearToDate(date, time)
-Invoke iteratee (function) for each object key-value pair
-and return a mapped object
+Transforms String Date from a [Week Year] format to Date object.
@@ -2078,8 +2082,8 @@ and return a mapped object
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | Base object. | &nbsp; |
-| iteratee | `Function`  | The executed per iteration. | &nbsp; |
+| date |  | String of [Week Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -2087,18 +2091,17 @@ and return a mapped object
 ##### Returns
-- `Object`  New mapped object.
+-  The date object or the date in milliseconds
-### dist/general/object/mergeDeep.js
+### dist/dates/adapters/yearToDate.js
-#### mergeDeep(obj1, obj2, settings)
+#### yearToDate(yearDate, time)
-Merges two objects into a new one.
-The second given argument to the first given argument.
+Transforms String Date from a [Year] format to Date object.
@@ -2107,9 +2110,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; |
+| yearDate |  | String of [Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -2117,13 +2119,17 @@ The second given argument to the first given argument.
 ##### Returns
--  a new merged object
+-  The date object or the date in milliseconds
-#### isValid(obj1, obj2)
-Validates if the two arguments are objects
+### dist/dates/helpers/getDateByDateFormat.js
+#### getDateByDateFormat(date, format, time)
+Gets a Date Object instance by a Date format
@@ -2132,8 +2138,9 @@ Validates if the two arguments are objects
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
+| date |  | String with a formatted date | &nbsp; |
+| format |  | The date format | &nbsp; |
+| time |  | flag to convert the formatted date to miliseconds | &nbsp; |
@@ -2141,13 +2148,17 @@ Validates if the two arguments are objects
 ##### Returns
--  true: they are valid; false: they are not
+-  a Date object, milisecond time or the same value if date format does not match.
-#### getParamsToMergeDeep(settings)
-Validates and gets the settings with all set parameters.
+### dist/dates/helpers/getDateFormatByProperty.js
+#### getDateFormatByProperty(property)
+Gets the date format by the given property
@@ -2156,7 +2167,7 @@ Validates and gets the settings with all set parameters.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | the settings object | &nbsp; |
+| property |  | The Column Property | &nbsp; |
@@ -2164,17 +2175,17 @@ Validates and gets the settings with all set parameters.
 ##### Returns
--  a new settings object with all set parameters.
+-  The date format
-### dist/general/object/objectCopy.js
+### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
-#### objectCopy(entity, cache)
+#### getDateFormatRegularExpressionInArray(dateFormat)
-Created a new reference of the given argument
+Gets an array of regular expressions by the given date format
@@ -2183,8 +2194,7 @@ Created a new reference of the given argument
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| entity |  | The variable to be copied | &nbsp; |
-| cache |  |  | &nbsp; |
+| dateFormat |  | the date format | &nbsp; |
@@ -2192,17 +2202,17 @@ Created a new reference of the given argument
 ##### Returns
--  A new reference of the given argument
+-  an array of regular expressions
-### dist/general/object/omit.js
+### dist/dates/helpers/getSeparatorByDateFormat.js
-#### omit(obj, props)
+#### getSeparatorByDateFormat(format)
-return a new Object excluding attributes in _props_ list
+Gets the separator of the date format
@@ -2211,8 +2221,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; |
+| format |  | the date format | &nbsp; |
@@ -2220,17 +2229,18 @@ return a new Object excluding attributes in _props_ list
 ##### Returns
-- `Object`  clean object
+-  a separator string
-### dist/general/object/pick.js
+### dist/dates/helpers/getWeek.js
-#### pick(baseObject, keys)
+#### getWeek(date)
-return a new object just with attributes in _keys_ list
+Gets the week number of the year
+Additionally, the month and the year
@@ -2239,8 +2249,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; |
+| date |  | the date object | &nbsp; |
@@ -2248,17 +2257,20 @@ return a new object just with attributes in _keys_ list
 ##### Returns
-- `Object`  new object just with desired attributes
+-  an object with the week, month and year.
-### dist/general/object/serialize.js
+### dist/dates/helpers/validateDate.js
-#### serialize(obj)
+#### validateDate(date, format)
-serialize object to url param
+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
@@ -2267,7 +2279,8 @@ serialize object to url param
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | - Object to be serialized | &nbsp; |
+| date |  | String of date | &nbsp; |
+| format |  | String of the format to validate | &nbsp; |
@@ -2275,18 +2288,17 @@ serialize object to url param
 ##### Returns
-- `Void`
+-  True if it is valid or not. Undefined if date is undefined
-### dist/general/mix/compareDeep.js
+### dist/dates/helpers/validateDateByDateFormat.js
-#### compareDeep(object1, object2)
+#### validateDateByDateFormat(date, dateForma)
-Compares two objects to know if they are equals. Go across nested objects.
-Includes arrays in the comparison.
+Validates the given string as Date by its date format.
@@ -2295,8 +2307,8 @@ Includes arrays in the comparison.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| object1 |  | First Object to compare | &nbsp; |
-| object2 |  | Second Object to compare | &nbsp; |
+| date |  | a string to validate as date form | &nbsp; |
+| dateForma |  | the format of the date to validate the string | &nbsp; |
@@ -2304,17 +2316,17 @@ Includes arrays in the comparison.
 ##### Returns
--  True: objects are equal. False: Objects are not equal. Undefined: invalid
+-  true: the string is a valida date
-### dist/general/mix/getTag.js
+### dist/dates/range/getDateRange.js
-#### getTag(value)
+#### getDateRange(value, dateGroupLabel, withTime)
-Gets the `toStringTag` of `value`.
+Get date range object from a string date value
@@ -2323,92 +2335,74 @@ Gets the `toStringTag` of `value`.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value |  | The value to query. | &nbsp; |
-##### Returns
+| 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; |
-- `string`  Returns the `toStringTag`.
+##### Examples
+```javascript
+// 1) Year:
+getDateRange('2020', 'YEAR');
+// Will return:
+{
+   from: '01/01/2020 00:00:00',
+   to: '12/31/2020 23:59:59'
+}
-### dist/general/mix/importScripts.js
+// 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'
+}
+```
-#### importScripts(scripts)
-Import a set of external Scripts given the URL in both serie and cascade way
+##### Returns
+- `Object`  an object with the date range with two string date properties: from and to
-##### Parameters
-| 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; |
+### dist/dates/relative/Adapter.js
+#### value()
-##### Examples
+Resolves statement and returns statement value
-```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)
+- `AbsoluteRange` `string`
-Creates the script element and appends to document.head
-return a Promise that is resolved when the script is loaded
+#### valueAsAnchor()
+Resolves statement as an anchor
-##### 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; |
@@ -2416,27 +2410,15 @@ return a Promise that is resolved when the script is loaded
 ##### Returns
-- `Void`
-### dist/general/mix/isEmpty.js
-#### isEmpty(variable, includeFalsy)
+- `string`
-Validates if the given argument is empty
+#### _statementToRange()  *private method*
+Convert verbal statement to range value
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| variable |  | the given variable | &nbsp; |
-| includeFalsy |  | flag to determine include the falsy variables into the validation | &nbsp; |
@@ -2444,56 +2426,47 @@ Validates if the given argument is empty
 ##### Returns
--  true: the given argument is empty; false: is not.
+- `AbsoluteRange`
+#### _resolveAsThis()  *private method*
-### dist/general/mix/isNaNV2.js
+Apply 'this' cursor logic to statement
-#### isNaNV2(variable)
-Validates if the recieved number is NaN type.
-This function recieves any variable but will return false.
-Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
+##### Returns
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| variable |  | the variable to validate | &nbsp; |
+- `AbsoluteStatement`
+#### _resolveAsTheLast()  *private method*
-##### Returns
+Apply 'the last' cursor logic to statement
--  True if variable is a NaN or false otherwise
-### dist/general/mix/isNull.js
+##### Returns
-#### isNull(arg)
+- `AbsoluteStatement`
-return if a given variable is either `null` or `undefined`
-useful to avoid falsify validating Number Zero (0)
+#### _resolveAsTheNext()  *private method*
+Apply 'the next' cursor logic to statement
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| arg | `any`  |  | &nbsp; |
@@ -2501,19 +2474,13 @@ useful to avoid falsify validating Number Zero (0)
 ##### Returns
-- `Boolean`
+- `AbsoluteStatement`
-### dist/general/mix/size.js
-#### size(obj)
+#### replaceNowToken(value, now)
-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.
+Replace '@now' token inside a string
@@ -2522,7 +2489,8 @@ Gets the length of the given array.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `Any`  | Any object-type variable | &nbsp; |
+| value | `string`  |  | &nbsp; |
+| now | `Date`  |  | &nbsp; |
@@ -2530,19 +2498,13 @@ Gets the length of the given array.
 ##### Returns
-- `Number`  the size of the given variable
+- `string`
-### dist/general/mix/randomId.js
-#### randomId(length, exclude)
+#### convertRelativeToAbsolute(args)
-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.
+Returns a range object (date) from a group of statement params
@@ -2551,26 +2513,45 @@ 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; |
+| args | `RelativeToAbsoluteStruct`  |  | &nbsp; |
+##### Examples
+```javascript
+pivot = '2021-03-03T12:30:40'
+unit = month
+steps = 2
+setTo = END
+resolverAsCalendar: true
+=> Returns  '2021-05-31T23:59:59'
+```
+```javascript
+pivot = '2021-03-03T12:30:40'
+unit = month
+steps = -2
+setTo = START
+resolverAsCalendar: false
+=> Returns '2021-01-03T00:00:00'
+```
 ##### Returns
-- `String`  Random string
+- `string`
-### dist/general/string/capitalize.js
+### dist/dates/relative/relative.js
-#### capitalize(text)
+#### resolveRelative(statements, clock)
-Upper case the first letter of a given text
+Resolve a list of relative statements according to operator
@@ -2579,15 +2560,34 @@ Upper case the first letter of a given text
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| text | `String`  |  | &nbsp; |
+| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
+| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
+##### Examples
+```javascript
+Input:
+{
+ "cursor": "the_next",
+ "unit": "year",
+ "number": 1,
+ "includeCurrent": false,
+ "isCalendarDate": false,
+ "anchor": "03/05/2021"
+}
+Output:
+{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
+```
 ##### Returns
-- `String`  a capitalized text
+- `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
@@ -2680,90 +2680,8 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
 verify the Config object type and try to return a parsed Object
 - In case _cfg_ is a string, first try to make a JSON parse in other case
 try to find this string as a variable on Windows object
-- If _cfg_ is a fuction, tis is invoked and parsed
-- Finally, if is an object, _cfg_ is inmediatly returned
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| cfg |  |  | &nbsp; |
-##### Returns
-- `Void`
-### dist/services/api/getAllDatasets.api.js
-#### getAllDatasets(qrveyids)
-Get a dataset list from a collection of Qrvey IDs
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs | &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
+- If _cfg_ is a fuction, tis is invoked and parsed
+- Finally, if is an object, _cfg_ is inmediatly returned
@@ -2772,7 +2690,7 @@ Get a dataset by Qrvey ID
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID | &nbsp; |
+| cfg |  |  | &nbsp; |
@@ -2780,7 +2698,7 @@ Get a dataset by Qrvey ID
 ##### Returns
--  a promise
+- `Void`
@@ -2839,12 +2757,12 @@ Get a dataset by Qrvey ID
-### dist/dates/relative/helpers/formatStatement.js
+### dist/services/api/getAllDatasets.api.js
-#### formatStatement(statement)
+#### getAllDatasets(qrveyids)
-Build a proper relative date statement type
+Get a dataset list from a collection of Qrvey IDs
@@ -2853,7 +2771,7 @@ Build a proper relative date statement type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| statement | `RelativeStatement`  |  | &nbsp; |
+| qrveyids |  | Collection of Qrvey IDs | &nbsp; |
@@ -2861,17 +2779,17 @@ Build a proper relative date statement type
 ##### Returns
-- `RelativeStatement`
+-  a promise
-### dist/dates/relative/helpers/getStatementCase.js
+### dist/services/api/getAllQrveys.api.js
-#### getStatementCase(includeCurrent, isCalendarDate)
+#### getAllQrveys(config, params)
-Returns a number/constant that identifies a relative date case
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
@@ -2880,8 +2798,8 @@ Returns a number/constant that identifies a relative date case
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| includeCurrent | `boolean`  |  | &nbsp; |
-| isCalendarDate | `boolean`  |  | &nbsp; |
+| config |  | Configuration | &nbsp; |
+| params |  | Object for getting precise data | &nbsp; |
@@ -2889,17 +2807,17 @@ Returns a number/constant that identifies a relative date case
 ##### Returns
-- `number`
+- `Void`
-### dist/dates/relative/helpers/parseDate.js
+### dist/services/api/getDatasetColumns.api.js
-#### parseDate(date)
+#### getDatasetColumns(qrveyid)
-Parses a string date and returns a dayjs date
+Get a dataset by Qrvey ID
@@ -2908,7 +2826,7 @@ Parses a string date and returns a dayjs date
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date | `string` `Dayjs` `Date`  |  | &nbsp; |
+| qrveyid |  | The Qrvey ID | &nbsp; |
@@ -2916,17 +2834,18 @@ Parses a string date and returns a dayjs date
 ##### Returns
-- `Dayjs`  A dayjs date
+-  a promise
-### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
+### dist/filters/helpers/backend/buildExpression.js
-#### getFilterBuilderGeneralConfig(config)
+#### buildExpression(filter)
-Returns a filter builder config object by a any given config
+Builds filter expression by the filter data.
+- If the resulting value array is empty the enabled property will be false.
@@ -2935,7 +2854,7 @@ Returns a filter builder config object by a any given config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | any config object | &nbsp; |
+| filter |  | The filter to transform | &nbsp; |
@@ -2943,18 +2862,17 @@ Returns a filter builder config object by a any given config
 ##### Returns
--  The filter builder config object
+-  a filter expression
-### dist/filters/helpers/backend/buildExpression.js
+### dist/filters/helpers/backend/buildUserFilters.js
-#### buildExpression(filter)
+#### buildUserFilters(userFilters)
-Builds filter expression by the filter data.
-- If the resulting value array is empty the enabled property will be false.
+Transform user Filters array into Filter Logic structure
@@ -2963,7 +2881,7 @@ Builds filter expression by the filter data.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter to transform | &nbsp; |
+| userFilters |  | The filters that the user defined. | &nbsp; |
@@ -2971,17 +2889,17 @@ Builds filter expression by the filter data.
 ##### Returns
--  a filter expression
+-  The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
-### dist/filters/helpers/backend/buildUserFilters.js
+### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
-#### buildUserFilters(userFilters)
+#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
-Transform user Filters array into Filter Logic structure
@@ -2990,7 +2908,8 @@ Transform user Filters array into Filter Logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| userFilters |  | The filters that the user defined. | &nbsp; |
+| aggFilters |  |  | &nbsp; |
+| summaryIndex |  |  | &nbsp; |
@@ -2998,17 +2917,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
--  The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
+-
-### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
+### dist/filters/helpers/backend/getBackendGroupValue.js
-#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
+#### getBackendGroupValue(filter)
+Gets a group value for the backend logic structure
@@ -3017,8 +2936,7 @@ Transform user Filters array into Filter Logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| aggFilters |  |  | &nbsp; |
-| summaryIndex |  |  | &nbsp; |
+| filter |  | The filter | &nbsp; |
@@ -3026,17 +2944,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
--
+-  a property
-### dist/filters/helpers/backend/getBackendGroupValue.js
+### dist/filters/helpers/backend/getBackendProperty.js
-#### getBackendGroupValue(filter)
+#### getBackendProperty(filter)
-Gets a group value for the backend logic structure
+Gets a property for the logic structure
@@ -3160,12 +3078,12 @@ Gets the Ranking values.
-### dist/filters/helpers/backend/getBackendProperty.js
+### dist/filters/helpers/backend/getLogicByScopes.js
-#### getBackendProperty(filter)
+#### getLogicByScopes(logics, scopes)
-Gets a property for the logic structure
+Gets the filters from logic data by Scopes/Scope IDs.
@@ -3174,7 +3092,8 @@ Gets a property for the logic structure
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
+| logics |  | The logic array | &nbsp; |
+| scopes |  | The collection of Scopes/Scope IDs | &nbsp; |
@@ -3182,7 +3101,7 @@ Gets a property for the logic structure
 ##### Returns
--  a property
+-  a new Logic array
@@ -3216,12 +3135,12 @@ Gets filters from the logic by the scopes hierarchy.
-### dist/filters/helpers/backend/getLogicByScopes.js
+### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
-#### getLogicByScopes(logics, scopes)
+#### getFilterBuilderGeneralConfig(config)
-Gets the filters from logic data by Scopes/Scope IDs.
+Returns a filter builder config object by a any given config
@@ -3230,8 +3149,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The logic array | &nbsp; |
-| scopes |  | The collection of Scopes/Scope IDs | &nbsp; |
+| config |  | any config object | &nbsp; |
@@ -3239,17 +3157,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
 ##### Returns
--  a new Logic array
+-  The filter builder config object
-### 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
@@ -3258,7 +3176,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; |
@@ -3266,17 +3185,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.
@@ -3285,8 +3204,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; |
@@ -3294,17 +3212,26 @@ 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
-### dist/filters/helpers/common/excludeFiltersByScopes.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
-#### excludeFiltersByScopes(filterData, scopes)
+#### excludeFiltersByParams(filterData, params)
-Excludes and returns a filter data without filters by the given scopes
+Excludes filters from the given Filters.
+The validation to filter the stored filter is depending on:
+- Column
+- Qrvey ID
+- Scope type
+- Scope ID
+- Panel ID
+- Validator type
+- Property type
+- Enabled flags
@@ -3313,8 +3240,8 @@ Excludes and returns a filter data without filters by the given scopes
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data | &nbsp; |
-| scopes |  | collection of scopes to be as filtering parameters | &nbsp; |
+| filterData |  | The Filter Data or the UI Filter Data | &nbsp; |
+| params |  | given parameters to validate the filter data | &nbsp; |
@@ -3322,26 +3249,17 @@ Excludes and returns a filter data without filters by the given scopes
 ##### Returns
--  The new Filter Data without filters by the given scopes.
+-  a new Filter object structure
-### dist/filters/helpers/common/excludeFiltersByParams.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
-#### excludeFiltersByParams(filterData, params)
+#### excludeFiltersByScopes(filterData, scopes)
-Excludes filters from the given Filters.
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-- Enabled flags
+Excludes and returns a filter data without filters by the given scopes
@@ -3350,8 +3268,8 @@ The validation to filter the stored filter is depending on:
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data or the UI Filter Data | &nbsp; |
-| params |  | given parameters to validate the filter data | &nbsp; |
+| filterData |  | The Filter Data | &nbsp; |
+| scopes |  | collection of scopes to be as filtering parameters | &nbsp; |
@@ -3359,7 +3277,7 @@ The validation to filter the stored filter is depending on:
 ##### Returns
--  a new Filter object structure
+-  The new Filter Data without filters by the given scopes.
@@ -4320,4 +4238,86 @@ Resolves conditions between UI flattened filter and given parameters
+### dist/dates/relative/helpers/formatStatement.js
+#### formatStatement(statement)
+Build a proper relative date statement type
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| statement | `RelativeStatement`  |  | &nbsp; |
+##### Returns
+- `RelativeStatement`
+### dist/dates/relative/helpers/getStatementCase.js
+#### getStatementCase(includeCurrent, isCalendarDate)
+Returns a number/constant that identifies a relative date case
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| includeCurrent | `boolean`  |  | &nbsp; |
+| isCalendarDate | `boolean`  |  | &nbsp; |
+##### Returns
+- `number`
+### dist/dates/relative/helpers/parseDate.js
+#### parseDate(date)
+Parses a string date and returns a dayjs date
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| date | `string` `Dayjs` `Date`  |  | &nbsp; |
+##### Returns
+- `Dayjs`  A dayjs date
 *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*