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

@qrvey/utils 1.2.9-5 → 1.2.9-9

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 (126) 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-9*
 > Helper, Utils for all Qrvey Projects
@@ -80,22 +80,14 @@ Get a text and evaluate if it matchs with a token box label.
-### dist/dates/adapters/mdyDateToDate.js
-#### mdyDateToDate(monthYearDate, time)
+### dist/filters/classes/FilterInputErrorHandler.js
-Transforms String Date from a [mm/dd/yyyy] format to Date object.
+#### new FilterInputErrorHandler()
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -103,17 +95,17 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+- `Void`
-### dist/dates/adapters/monthYearToDate.js
+### dist/filters/adapters/FDToLogic.js
-#### monthYearToDate(monthYearDate, time)
+#### FDToLogic(filterData)
-Transforms String Date from a [Month Year] format to Date object.
+Generates a Filter Logic structure from Filter Data structure.
@@ -122,8 +114,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; |
+| filterData |  | The filter data object. | &nbsp; |
@@ -131,17 +122,13 @@ Transforms String Date from a [Month Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a filter logic array
-### dist/dates/adapters/quarterYearToDate.js
-#### quarterYearToDate(quarterYearDate, time)
+#### getLogicBodyFromFD21(filterData)
-Transforms String Date from a [Quarter Year] format to Date object.
+Gets the logic body
@@ -150,8 +137,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 +145,17 @@ 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
+### dist/filters/adapters/FDToUI.js
-#### weekYearToDate(date, time)
+#### FDToUI(filterData, datasetsInfo)
-Transforms String Date from a [Week Year] format to Date object.
+Generates a UI filter structure from Filter Data structure.
@@ -178,8 +164,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; |
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -187,17 +173,13 @@ Transforms String Date from a [Week Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a UI Filters structure
-### dist/dates/adapters/yearToDate.js
-#### yearToDate(yearDate, time)
+#### FD21ToUI(scopes, section, version, datasetsInfo)
-Transforms String Date from a [Year] format to Date object.
+Generates a UI filter Structure from the Filter Data structure v2.1
@@ -206,8 +188,10 @@ 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; |
+| 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; |
@@ -215,17 +199,17 @@ Transforms String Date from a [Year] format to Date object.
 ##### Returns
--  The date object or the date in milliseconds
+-  a UI filter Structure
-### dist/dates/helpers/getDateByDateFormat.js
+### dist/filters/adapters/UIToFD.js
-#### getDateByDateFormat(date, format, time)
+#### UIToFD(filterData)
-Gets a Date Object instance by a Date format
+Generates a Filter Data Structure structure from UI Filter Data structure.
@@ -234,9 +218,7 @@ 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; |
+| filterData |  | The UI filter data object. | &nbsp; |
@@ -244,17 +226,13 @@ 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 Filter Data structure
-### dist/dates/helpers/getDateFormatByProperty.js
-#### getDateFormatByProperty(property)
+#### UI21ToFD(uFilterData, version)
-Gets the date format by the given property
+Builds the Fitler Data structure from UI filter data
@@ -263,7 +241,8 @@ Gets the date format by the given property
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| property |  | The Column Property | &nbsp; |
+| uFilterData |  | The UI filter Data object | &nbsp; |
+| version |  | the version of the structure | &nbsp; |
@@ -271,17 +250,17 @@ Gets the date format by the given property
 ##### Returns
--  The date format
+-
-### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
+### dist/filters/adapters/UIToFlatUI.js
-#### getDateFormatRegularExpressionInArray(dateFormat)
+#### UIToFlatUI(filterData, datasetsInfo)
-Gets an array of regular expressions by the given date format
+Generates a Flattened UI filter structure from UI Filter Data structure.
@@ -290,7 +269,8 @@ Gets an array of regular expressions by the given date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| dateFormat |  | the date format | &nbsp; |
+| filterData |  | The UI filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
@@ -298,17 +278,13 @@ Gets an array of regular expressions by the given date format
 ##### Returns
--  an array of regular expressions
+-  a flattened UI filters array
-### dist/dates/helpers/getSeparatorByDateFormat.js
-#### getSeparatorByDateFormat(format)
+#### UI21ToFlatUI(scopes)
-Gets the separator of the date format
+Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
@@ -317,7 +293,7 @@ Gets the separator of the date format
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| format |  | the date format | &nbsp; |
+| scopes |  | The filter scope section | &nbsp; |
@@ -325,18 +301,18 @@ Gets the separator of the date format
 ##### Returns
--  a separator string
+-  a flattened UI filters array
-### dist/dates/helpers/getWeek.js
+### dist/filters/adapters/adaptDateGroupingProperty.js
-#### getWeek(date)
+#### adaptDateGroupingProperty(property)
-Gets the week number of the year
-Additionally, the month and the year
+[TODO: For 2022, eliminate this adapter]
+Get the new property base on the old date grouping properties
@@ -345,7 +321,7 @@ Additionally, the month and the year
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date |  | the date object | &nbsp; |
+| property |  |  | &nbsp; |
@@ -353,20 +329,17 @@ Additionally, the month and the year
 ##### Returns
--  an object with the week, month and year.
+-
-### dist/dates/helpers/validateDate.js
+### dist/filters/adapters/adaptFilterData.js
-#### validateDate(date, format)
+#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
-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
+Checks and adapts the v2.0 Filter Data Structure to the v2.1
@@ -375,8 +348,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; |
+| 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; |
@@ -384,17 +358,18 @@ Validate a string date depending on giving format
 ##### Returns
--  True if it is valid or not. Undefined if date is undefined
+-  A new filter data structure v2.1
-### dist/dates/helpers/validateDateByDateFormat.js
+### dist/filters/adapters/adaptFilterValues.js
-#### validateDateByDateFormat(date, dateForma)
+#### adaptFilterValues(filter)
-Validates the given string as Date by its date format.
+[TODO: For 2022, eliminate this adapter]
+Gets an adapted filter value array. Validates the enabled property and sets
@@ -403,8 +378,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; |
+| filter |  | The filter | &nbsp; |
@@ -412,17 +386,17 @@ Validates the given string as Date by its date format.
 ##### Returns
--  true: the string is a valida date
+-  A new value array with the filled properties.
-### dist/dates/range/getDateRange.js
+### dist/filters/adapters/FDToFlatUI.js
-#### getDateRange(value, dateGroupLabel, withTime)
+#### FDToFlatUI(filterData, datasetsInfo)
-Get date range object from a string date value
+Generates a Flattened UI filter structure from Filter Data structure.
@@ -431,58 +405,32 @@ Get date range object from a string date value
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value | `String`  | string date value | &nbsp; |
-| dateGroupLabel | `String`  | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
-| withTime | `Boolean`  | determines if the date range will include time. Default is true | &nbsp; |
-##### Examples
-```javascript
-// 1) Year:
-getDateRange('2020', 'YEAR');
-// Will return:
-{
-   from: '01/01/2020 00:00:00',
-   to: '12/31/2020 23:59:59'
-}
+| filterData |  | The filter data object. | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
-// 2) Quarter:
-getDateRange('Q3 2020', 'QUARTER');
-// Will return:
-{
-   from: '07/01/2020 00:00:00',
-   to: '09/30/2020 23:59:59'
-}
-// 3) Month:
-getDateRange('Oct 2020', 'MONTH');
-// Will return:
-{
-   from: '10/01/2020 00:00:00',
-   to: '10/31/2020 23:59:59'
-}
-```
 ##### Returns
-- `Object`  an object with the date range with two string date properties: from and to
+-  a flattened UI filters array
+#### FD21ToFlatUI(scopes, datasetsInfo)
-### dist/dates/relative/Adapter.js
+Generates a Filter Builder Structure from the Filter Data structure v2.1
-#### value()
-Resolves statement and returns statement value
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| scopes |  | The filter scope section | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -490,63 +438,74 @@ Resolves statement and returns statement value
 ##### Returns
-- `AbsoluteRange` `string`
+-  a flattened UI filters array
-#### valueAsAnchor()
-Resolves statement as an anchor
+### dist/filters/adapters/flatUIToFD.js
+#### flatUIToFD(uFilters, version)
+Generates a filter data structure from the flatttened UI filters.
-##### Returns
+##### Parameters
-- `string`
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
-#### _statementToRange()  *private method*
-Convert verbal statement to range value
+##### Returns
+-  a Filter Data.
+#### buildScopes(fbFilters)
-##### Returns
+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
-- `AbsoluteRange`
+##### Parameters
-#### _resolveAsThis()  *private method*
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
-Apply 'this' cursor logic to statement
+##### Returns
+-  an array of scopes structure.
-##### Returns
-- `AbsoluteStatement`
+#### buildScope(uFilter)
+Gets an scope structure for the filter data
-#### _resolveAsTheLast()  *private method*
-Apply 'the last' cursor logic to statement
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uFilter |  | UI structure filter | &nbsp; |
@@ -554,39 +513,22 @@ Apply 'the last' cursor logic to statement
 ##### Returns
-- `AbsoluteStatement`
+-  an scope structure
-#### _resolveAsTheNext()  *private method*
-Apply 'the next' cursor logic to statement
+#### buildDataset(uFilter)
+Gets an dataset structure for the filter data
-##### Returns
-- `AbsoluteStatement`
-#### replaceNowToken(value, now)
-Replace '@now' token inside a string
-##### Parameters
+##### Parameters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| value | `string`  |  | &nbsp; |
-| now | `Date`  |  | &nbsp; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -594,13 +536,13 @@ Replace '@now' token inside a string
 ##### Returns
-- `string`
+-  an dataset structure
-#### convertRelativeToAbsolute(args)
+#### buildFilter(uFilter)
-Returns a range object (date) from a group of statement params
+Gets an filter structure for the filter data
@@ -609,45 +551,25 @@ Returns a range object (date) from a group of statement params
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| args | `RelativeToAbsoluteStruct`  |  | &nbsp; |
+| uFilter |  | a UI structure filter | &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`
+-  an filter structure
-### dist/dates/relative/relative.js
+### dist/filters/adapters/flatUIToLogic.js
-#### resolveRelative(statements, clock)
+#### flatUIToLogic(uFilter)
-Resolve a list of relative statements according to operator
+Generates a Logic structure from flattened UI filters
@@ -656,68 +578,25 @@ Resolve a list of relative statements according to operator
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
-| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
-##### Examples
+| uFilter |  | Array of flat filters from UI | &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;`
-### dist/filters/adapters/FDToFlatUI.js
-#### FDToFlatUI(filterData, datasetsInfo)
-Generates a Flattened UI filter structure from Filter Data structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
+-  The logic structure
-##### Returns
--  a flattened UI filters array
+### dist/filters/adapters/flatUIToOldLogic.js
-#### FD21ToFlatUI(scopes, datasetsInfo)
+#### flatUIToOldLogic(uFilters)
-Generates a Filter Builder Structure from the Filter Data structure v2.1
+Generates a Logic structure from flattened UI filters
@@ -726,8 +605,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; |
+| uFilters |  | Array of flat filters from UI | &nbsp; |
@@ -735,17 +613,17 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 ##### Returns
--  a flattened UI filters array
+-  The logic structure
-### dist/filters/adapters/FDToLogic.js
+### dist/filters/adapters/flatUIToUI.js
-#### FDToLogic(filterData)
+#### flatUIToUI(uFilters, version)
-Generates a Filter Logic structure from Filter Data structure.
+Generates a UI filter data structure from the flatttened UI filters.
@@ -754,7 +632,8 @@ Generates a Filter Logic structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
+| uFilters |  | Array of flattened filters from UI | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
@@ -762,13 +641,14 @@ Generates a Filter Logic structure from Filter Data structure.
 ##### Returns
--  a filter logic array
+-  a UI Filter Data.
-#### getLogicBodyFromFD21(filterData)
+#### buildScopes(fbFilters)
-Gets the logic body
+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
@@ -777,7 +657,7 @@ Gets the logic body
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
+| fbFilters |  | Array of flat filters from UI | &nbsp; |
@@ -785,17 +665,13 @@ Gets the logic body
 ##### Returns
--  a filter logic array
+-  an array of scopes structure.
-### dist/filters/adapters/FDToUI.js
-#### FDToUI(filterData, datasetsInfo)
+#### buildScope(uFilter)
-Generates a UI filter structure from Filter Data structure.
+Gets an scope structure for the UI filter data
@@ -804,8 +680,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; |
+| uFilter |  | UI structure filter | &nbsp; |
@@ -813,13 +688,13 @@ Generates a UI filter structure from Filter Data structure.
 ##### Returns
--  a UI Filters structure
+-  an scope structure
-#### FD21ToUI(scopes, section, version, datasetsInfo)
+#### buildDataset(uFilter)
-Generates a UI filter Structure from the Filter Data structure v2.1
+Gets an dataset structure for the UI filter data
@@ -828,10 +703,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; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -839,17 +711,13 @@ Generates a UI filter Structure from the Filter Data structure v2.1
 ##### Returns
--  a UI filter Structure
+-  an dataset structure
-### dist/filters/adapters/UIToFD.js
-#### UIToFD(filterData)
+#### buildFilter(uFilter)
-Generates a Filter Data Structure structure from UI Filter Data structure.
+Gets an filter structure for the UI filter data
@@ -858,7 +726,7 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
+| uFilter |  | a UI structure filter | &nbsp; |
@@ -866,13 +734,17 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
 ##### Returns
--  a Filter Data structure
+-  an filter structure
-#### UI21ToFD(uFilterData, version)
-Builds the Fitler Data structure from UI filter data
+### dist/filters/adapters/logicToFD.js
+#### logicToFD(filterData, version)
+Generates a filter data structure from the old logic structure (v2.0).
@@ -881,8 +753,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; |
+| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
+| version |  | Tag for the version of the filter data structure | &nbsp; |
@@ -890,17 +762,17 @@ Builds the Fitler Data structure from UI filter data
 ##### Returns
--
+-  a Filter Data.
-### dist/filters/adapters/UIToFlatUI.js
+### dist/filters/adapters/logicToFlatUI.js
-#### UIToFlatUI(filterData, datasetsInfo)
+#### logicToFlatUI(logics)
-Generates a Flattened UI filter structure from UI Filter Data structure.
+Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
@@ -909,8 +781,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; |
+| logics |  | The old logic structure (v2.0) | &nbsp; |
@@ -918,13 +789,13 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
 ##### Returns
--  a flattened UI filters array
+-  The Flattened UI Filters array
-#### UI21ToFlatUI(scopes)
+#### getFilter(filters, filter, getIndex)
-Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
+Get the filter or the index of the given array, validating an old filter structure.
@@ -933,7 +804,9 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &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; |
@@ -941,18 +814,13 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
 ##### Returns
--  a flattened UI filters array
+-  the index or the UI filter object
-### dist/filters/adapters/adaptDateGroupingProperty.js
-#### adaptDateGroupingProperty(property)
+#### refineRankingValues(values, uiValues)
-[TODO: For 2022, eliminate this adapter]
-Get the new property base on the old date grouping properties
+Refines the values of the Ranking column type.
@@ -961,7 +829,8 @@ Get the new property base on the old date grouping properties
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| property |  |  | &nbsp; |
+| values |  | the Array of Ranking values | &nbsp; |
+| uiValues |  | Object with additional info about the values of the filter. | &nbsp; |
@@ -969,17 +838,17 @@ Get the new property base on the old date grouping properties
 ##### Returns
--
+-  the array of Ranking values
-### dist/filters/adapters/adaptFilterData.js
+### dist/filters/adapters/logicToUI.js
-#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
+#### logicToUI(uFilters, datasetsInfo)
-Checks and adapts the v2.0 Filter Data Structure to the v2.1
+Generates a UI filter structure from the old logic structure (v2.0).
@@ -988,9 +857,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; |
+| uFilters |  | Array of filters from old logic structure | &nbsp; |
+| datasetsInfo |  | Collection of datasets information | &nbsp; |
@@ -998,18 +866,17 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
 ##### Returns
--  A new filter data structure v2.1
+-  a UI Filter Data.
-### dist/filters/adapters/adaptFilterValues.js
+### dist/filters/adapters/transformFilters.js
-#### adaptFilterValues(filter)
+#### transformFilters(oldFiltersObj, section)
-[TODO: For 2022, eliminate this adapter]
-Gets an adapted filter value array. Validates the enabled property and sets
+Transform the old filters structure into the new one
@@ -1018,50 +885,77 @@ Gets an adapted filter value array. Validates the enabled property and sets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
-##### Returns
--  A new value array with the filled properties.
+| 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; |
-### dist/filters/adapters/flatUIToFD.js
-#### flatUIToFD(uFilters, version)
-Generates a filter data structure from the flatttened UI filters.
+##### 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
+  }
+};
-##### Parameters
+const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
+```
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flattened filters from UI | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
+##### Returns
+- `Object`  an object with the new filters structure
-##### Returns
--  a Filter Data.
+### dist/filters/helpers/applyHierarchyForAggFilters.js
-#### buildScopes(fbFilters)
+#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
-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
+[TODO: Make a proper description for this function]
@@ -1070,7 +964,9 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
+| scopes |  |  | &nbsp; |
+| currentScope |  |  | &nbsp; |
@@ -1078,13 +974,17 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+-
-#### buildScope(uFilter)
-Gets an scope structure for the filter data
+### dist/filters/helpers/getAvailableScopes.js
+#### getAvailableScopes(config)
+Gets Scopes/Scope IDs by given IDs
@@ -1093,7 +993,7 @@ Gets an scope structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| config |  | given Differnts IDs in order set a available scope | &nbsp; |
@@ -1101,13 +1001,17 @@ Gets an scope structure for the filter data
 ##### Returns
--  an scope structure
+-  a Scopes/Scope IDs array
-#### buildDataset(uFilter)
-Gets an dataset structure for the filter data
+### dist/filters/helpers/getAvailableScopesIDsByConfig.js
+#### getAvailableScopesIDsByConfig(config)
+Gets the Scopes IDS for the Available Scope function by any config
@@ -1116,7 +1020,7 @@ Gets an dataset structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| config |  | any config | &nbsp; |
@@ -1124,13 +1028,17 @@ Gets an dataset structure for the filter data
 ##### Returns
--  an dataset structure
+-  a Available Scope IDS config
-#### buildFilter(uFilter)
-Gets an filter structure for the filter data
+### dist/filters/helpers/getScopesByHierarchy.js
+#### getScopesByHierarchy(scopes, currentScope)
+[TODO: Make a description for this]
@@ -1139,7 +1047,8 @@ Gets an filter structure for the filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| scopes |  | the collection of Scopes/Scope IDs | &nbsp; |
+| currentScope |  | Current scope type | &nbsp; |
@@ -1147,17 +1056,17 @@ Gets an filter structure for the filter data
 ##### Returns
--  an filter structure
+-  A new array of Scopes/Scope IDs
-### dist/filters/adapters/flatUIToLogic.js
+### dist/general/function/debounce.js
-#### flatUIToLogic(uFilter)
+#### debounce(fn, time)
-Generates a Logic structure from flattened UI filters
+Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
@@ -1166,7 +1075,8 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | Array of flat filters from UI | &nbsp; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
@@ -1174,17 +1084,17 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+- `Function`  debounced functions
-### dist/filters/adapters/flatUIToOldLogic.js
+### dist/general/function/throttled.js
-#### flatUIToOldLogic(uFilters)
+#### throttled(fn, time)
-Generates a Logic structure from flattened UI filters
+Make sure to only invokes _fn_ at most once per every _time_ milliseconds
@@ -1193,7 +1103,8 @@ Generates a Logic structure from flattened UI filters
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flat filters from UI | &nbsp; |
+| fn | `Function`  | original Function | &nbsp; |
+| time | `Number`  | default 500ms | &nbsp; |
@@ -1201,17 +1112,17 @@ Generates a Logic structure from flattened UI filters
 ##### Returns
--  The logic structure
+- `Function`  throttled function
-### dist/filters/adapters/flatUIToUI.js
+### dist/general/array/delete.js
-#### flatUIToUI(uFilters, version)
+#### ArrayDelete(array, index)
-Generates a UI filter data structure from the flatttened UI filters.
+Inmutable Array Item deletion
@@ -1220,8 +1131,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; |
+| array | `Array`  | a collection of items to delete | &nbsp; |
+| index | `Number`  | the position of the item to delete | &nbsp; |
@@ -1229,14 +1140,17 @@ Generates a UI filter data structure from the flatttened UI filters.
 ##### Returns
--  a UI Filter Data.
+-  a new Array or the given parameter when is empty or not an array
-#### 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/array/flattenDeep.js
+#### flattenDeep(arr)
+Flat deeply an array
@@ -1245,7 +1159,7 @@ Also, adds and organizes filters by datasets
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
+| arr |  | Array to flat deeply | &nbsp; |
@@ -1253,13 +1167,17 @@ Also, adds and organizes filters by datasets
 ##### Returns
--  an array of scopes structure.
+-  flatten array
-#### buildScope(uFilter)
-Gets an scope structure for the UI filter data
+### dist/general/array/getFirstIndexFromArray.js
+#### getFirstIndexFromArray(array, callback)
+Gets the first index from the array by a callback condition
@@ -1268,7 +1186,8 @@ Gets an scope structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -1276,13 +1195,17 @@ Gets an scope structure for the UI filter data
 ##### Returns
--  an scope structure
+-  the first index of the array. -1 when the condition is not satisfied
-#### buildDataset(uFilter)
-Gets an dataset structure for the UI filter data
+### dist/general/array/getLastIndexFromArray.js
+#### getLastIndexFromArray(array, callback)
+Gets the last index from the array by a callback condition
@@ -1291,7 +1214,8 @@ Gets an dataset structure for the UI filter data
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
+| array |  |  | &nbsp; |
+| callback |  | function callback | &nbsp; |
@@ -1299,13 +1223,20 @@ Gets an dataset structure for the UI filter data
 ##### Returns
--  an dataset structure
+-  the last index of the array. -1 when the condition is not satisfied
-#### buildFilter(uFilter)
-Gets an filter structure for the 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
@@ -1314,7 +1245,9 @@ Gets an filter structure for the UI 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; |
@@ -1322,17 +1255,18 @@ Gets an filter structure for the UI filter data
 ##### Returns
--  an filter structure
+-  array filtered
-### dist/filters/adapters/logicToFD.js
+### dist/general/mix/compareDeep.js
-#### logicToFD(filterData, version)
+#### compareDeep(object1, object2)
-Generates a filter data structure from the old logic structure (v2.0).
+Compares two objects to know if they are equals. Go across nested objects.
+Includes arrays in the comparison.
@@ -1341,8 +1275,8 @@ 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; |
+| object1 |  | First Object to compare | &nbsp; |
+| object2 |  | Second Object to compare | &nbsp; |
@@ -1350,17 +1284,17 @@ Generates a filter data structure from the old logic structure (v2.0).
 ##### Returns
--  a Filter Data.
+-  True: objects are equal. False: Objects are not equal. Undefined: invalid
-### dist/filters/adapters/logicToFlatUI.js
+### dist/general/mix/importScripts.js
-#### logicToFlatUI(logics)
+#### importScripts(scripts)
-Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
+Import a set of external Scripts given the URL in both serie and cascade way
@@ -1369,46 +1303,54 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The old logic structure (v2.0) | &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']);
--  The Flattened UI Filters array
+// 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'
+]);
+```
-#### getFilter(filters, filter, getIndex)
-Get the filter or the index of the given array, validating an old filter structure.
+##### Returns
+- `Promise`  Promise when all script have been loaded
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filters |  | The array of UI filters | &nbsp; |
-| filter |  | The old logic structure filter | &nbsp; |
-| getIndex |  | Determines if the index or returns the UI filter object | &nbsp; |
+#### loadScript(url, type, noModule)
-##### Returns
--  the index or the UI filter object
-#### refineRankingValues(values, uiValues)
-Refines the values of the Ranking column type.
+Creates the script element and appends to document.head
+return a Promise that is resolved when the script is loaded
@@ -1417,8 +1359,9 @@ 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; |
+| 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; |
@@ -1426,17 +1369,17 @@ Refines the values of the Ranking column type.
 ##### Returns
--  the array of Ranking values
+- `Void`
-### dist/filters/adapters/logicToUI.js
+### dist/general/mix/getTag.js
-#### logicToUI(uFilters, datasetsInfo)
+#### getTag(value)
-Generates a UI filter structure from the old logic structure (v2.0).
+Gets the `toStringTag` of `value`.
@@ -1445,8 +1388,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; |
+| value |  | The value to query. | &nbsp; |
@@ -1454,17 +1396,17 @@ Generates a UI filter structure from the old logic structure (v2.0).
 ##### Returns
--  a UI Filter Data.
+- `string`  Returns the `toStringTag`.
-### dist/filters/adapters/transformFilters.js
+### dist/general/mix/isEmpty.js
-#### transformFilters(oldFiltersObj, section)
+#### isEmpty(variable, includeFalsy)
-Transform the old filters structure into the new one
+Validates if the given argument is empty
@@ -1473,79 +1415,37 @@ 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; |
+| variable |  | the given variable | &nbsp; |
+| includeFalsy |  | flag to determine include the falsy variables into the validation | &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
+-  true: the given argument is empty; false: is not.
-- `Object`  an object with the new filters structure
+### dist/general/mix/isNaNV2.js
-### dist/filters/classes/FilterInputErrorHandler.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.
-#### new FilterInputErrorHandler()
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| variable |  | the variable to validate | &nbsp; |
@@ -1553,17 +1453,18 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 ##### Returns
-- `Void`
+-  True if variable is a NaN or false otherwise
-### dist/filters/helpers/applyHierarchyForAggFilters.js
+### dist/general/mix/isNull.js
-#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
+#### isNull(arg)
-[TODO: Make a proper description for this function]
+return if a given variable is either `null` or `undefined`
+useful to avoid falsify validating Number Zero (0)
@@ -1572,9 +1473,7 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &nbsp; |
+| arg | `any`  |  | &nbsp; |
@@ -1582,17 +1481,19 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 ##### Returns
--
+- `Boolean`
-### dist/filters/helpers/getAvailableScopes.js
+### dist/general/mix/randomId.js
-#### getAvailableScopes(config)
+#### randomId(length, exclude)
-Gets Scopes/Scope IDs by given IDs
+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.
@@ -1601,7 +1502,8 @@ Gets Scopes/Scope IDs by given IDs
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | given Differnts IDs in order set a available scope | &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; |
@@ -1609,17 +1511,19 @@ Gets Scopes/Scope IDs by given IDs
 ##### Returns
--  a Scopes/Scope IDs array
+- `String`  Random string
-### dist/filters/helpers/getAvailableScopesIDsByConfig.js
+### dist/general/mix/size.js
-#### getAvailableScopesIDsByConfig(config)
+#### size(obj)
-Gets the Scopes IDS for the Available Scope function by any config
+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.
@@ -1628,7 +1532,7 @@ Gets the Scopes IDS for the Available Scope function by any config
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | any config | &nbsp; |
+| obj | `Any`  | Any object-type variable | &nbsp; |
@@ -1636,17 +1540,18 @@ Gets the Scopes IDS for the Available Scope function by any config
 ##### Returns
--  a Available Scope IDS config
+- `Number`  the size of the given variable
-### dist/filters/helpers/getScopesByHierarchy.js
+### dist/general/object/cloneDeep.js
-#### getScopesByHierarchy(scopes, currentScope)
+#### cloneDeep(obj)
-[TODO: Make a description for this]
+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
@@ -1655,8 +1560,7 @@ 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 |  | The object | &nbsp; |
@@ -1664,17 +1568,21 @@ Gets the Scopes IDS for the Available Scope function by any config
 ##### Returns
--  A new array of Scopes/Scope IDs
+-  The new reference object or the given object if the parsing is incorrect or empty
-### dist/general/array/delete.js
+### dist/general/object/get.js
-#### ArrayDelete(array, index)
+#### _get(baseObject, path, defaultValue)
-Inmutable Array Item deletion
+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.
@@ -1683,29 +1591,59 @@ 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; |
+| 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 new Array or the given parameter when is empty or not an array
+-  the resolved value.
-### dist/general/array/filterNestedTree.js
+### dist/general/object/getAttribute.js
-#### filterNestedTree(arr, childArrKey, condition)
+#### getAttribute(obj, key)
-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
+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
@@ -1714,27 +1652,33 @@ 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; |
+| 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
--  array filtered
+- `Void`
-### dist/general/array/flattenDeep.js
+### dist/general/object/hasProperty.js
-#### flattenDeep(arr)
+#### _hasProperty(obj, property)
-Flat deeply an array
+Use the hasOwnProperty in order to verify if the given property exists in the object.
@@ -1743,25 +1687,38 @@ Flat deeply an array
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply | &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
--  flatten array
+-  True if the object has the given property; otherwise, false.
-### dist/general/array/getFirstIndexFromArray.js
+### dist/general/object/isObject.js
-#### getFirstIndexFromArray(array, callback)
+#### isObject(obj)
-Gets the first index from the array by a callback condition
+Checks if the given argument is an object type
@@ -1770,8 +1727,7 @@ Gets the first index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| obj |  | the variable to check | &nbsp; |
@@ -1779,17 +1735,18 @@ 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: It is an object; False: It is not.
-### dist/general/array/getLastIndexFromArray.js
+### dist/general/object/mapValues.js
-#### getLastIndexFromArray(array, callback)
+#### mapValues(baseObject, iteratee)
-Gets the last index from the array by a callback condition
+Invoke iteratee (function) for each object key-value pair
+and return a mapped object
@@ -1798,8 +1755,8 @@ Gets the last index from the array by a callback condition
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
+| baseObject | `Object`  | Base object. | &nbsp; |
+| iteratee | `Function`  | The executed per iteration. | &nbsp; |
@@ -1807,17 +1764,18 @@ 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
+- `Object`  New mapped object.
-### dist/general/function/debounce.js
+### dist/general/object/mergeDeep.js
-#### debounce(fn, time)
+#### mergeDeep(obj1, obj2, settings)
-Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
+Merges two objects into a new one.
+The second given argument to the first given argument.
@@ -1826,8 +1784,9 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
+| settings |  | Object settings for this function | &nbsp; |
@@ -1835,17 +1794,13 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
 ##### Returns
-- `Function`  debounced functions
+-  a new merged object
-### dist/general/function/throttled.js
-#### throttled(fn, time)
+#### isValid(obj1, obj2)
-Make sure to only invokes _fn_ at most once per every _time_ milliseconds
+Validates if the two arguments are objects
@@ -1854,27 +1809,22 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
-##### Returns
-- `Function`  throttled function
+##### Returns
+-  true: they are valid; false: they are not
-### dist/general/object/cloneDeep.js
-#### cloneDeep(obj)
+#### getParamsToMergeDeep(settings)
-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
+Validates and gets the settings with all set parameters.
@@ -1883,7 +1833,7 @@ Not to use this function with inner objects and functions
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | The object | &nbsp; |
+| settings |  | the settings object | &nbsp; |
@@ -1891,21 +1841,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
+-  a new settings object with all set parameters.
-### dist/general/object/get.js
+### dist/general/object/objectCopy.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.
+#### objectCopy(entity, cache)
-Empty arrays and empty objects are returned but the defaultValue is not
-Undefined and null values will return the defaultValue.
+Created a new reference of the given argument
@@ -1914,59 +1860,26 @@ Undefined and null values will return the defaultValue.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject |  | The object to query | &nbsp; |
-| path |  | The string path or collection of string paths of the property to get. | &nbsp; |
-| defaultValue |  | The value returned for undefined resolved values. | &nbsp; |
+| entity |  | The variable to be copied | &nbsp; |
+| cache |  |  | &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 new reference of the given argument
-### dist/general/object/getAttribute.js
+### dist/general/object/omit.js
-#### getAttribute(obj, key)
+#### omit(obj, props)
-Searchs for properties in different case styles such as: lower, upper, camel and pascal
-- To optimize the searching, it is required a key in a snake_case style
-- List of cases that do not match
--- From lower to snake case
--- From upper to snake case
--- From lower to camel case
--- From upper to camel case
--- From lower to pascal case
--- From upper to pascal case
+return a new Object excluding attributes in _props_ list
@@ -1975,33 +1888,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; |
+| obj | `Object`  | base object | &nbsp; |
+| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
-##### Examples
-```javascript
-getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-```
 ##### Returns
-- `Void`
+- `Object`  clean object
-### dist/general/object/hasProperty.js
+### dist/general/object/pick.js
-#### _hasProperty(obj, property)
+#### pick(baseObject, keys)
-Use the hasOwnProperty in order to verify if the given property exists in the object.
+return a new object just with attributes in _keys_ list
@@ -2010,38 +1916,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
+| baseObject | `Object`  | base object | &nbsp; |
+| keys | `Array.<String>`  | list of attributes to preserve | &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.
+- `Object`  new object just with desired attributes
-### dist/general/object/isObject.js
+### dist/general/object/serialize.js
-#### isObject(obj)
+#### serialize(obj)
-Checks if the given argument is an object type
+serialize object to url param
@@ -2050,7 +1944,7 @@ Checks if the given argument is an object type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | the variable to check | &nbsp; |
+| obj |  | - Object to be serialized | &nbsp; |
@@ -2058,18 +1952,17 @@ Checks if the given argument is an object type
 ##### Returns
--  True: It is an object; False: It is not.
+- `Void`
-### dist/general/object/mapValues.js
+### dist/general/string/capitalize.js
-#### mapValues(baseObject, iteratee)
+#### capitalize(text)
-Invoke iteratee (function) for each object key-value pair
-and return a mapped object
+Upper case the first letter of a given text
@@ -2078,8 +1971,7 @@ and return a mapped object
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | Base object. | &nbsp; |
-| iteratee | `Function`  | The executed per iteration. | &nbsp; |
+| text | `String`  |  | &nbsp; |
@@ -2087,18 +1979,17 @@ and return a mapped object
 ##### Returns
-- `Object`  New mapped object.
+- `String`  a capitalized text
-### dist/general/object/mergeDeep.js
+### dist/dates/helpers/getDateByDateFormat.js
-#### mergeDeep(obj1, obj2, settings)
+#### getDateByDateFormat(date, format, time)
-Merges two objects into a new one.
-The second given argument to the first given argument.
+Gets a Date Object instance by a Date format
@@ -2107,9 +1998,9 @@ 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; |
+| date |  | String with a formatted date | &nbsp; |
+| format |  | The date format | &nbsp; |
+| time |  | flag to convert the formatted date to miliseconds | &nbsp; |
@@ -2117,13 +2008,17 @@ The second given argument to the first given argument.
 ##### Returns
--  a new merged object
+-  a Date object, milisecond time or the same value if date format does not match.
-#### isValid(obj1, obj2)
-Validates if the two arguments are objects
+### dist/dates/helpers/getDateFormatByProperty.js
+#### getDateFormatByProperty(property)
+Gets the date format by the given property
@@ -2132,8 +2027,7 @@ Validates if the two arguments are objects
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
+| property |  | The Column Property | &nbsp; |
@@ -2141,13 +2035,17 @@ Validates if the two arguments are objects
 ##### Returns
--  true: they are valid; false: they are not
+-  The date format
-#### getParamsToMergeDeep(settings)
-Validates and gets the settings with all set parameters.
+### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
+#### getDateFormatRegularExpressionInArray(dateFormat)
+Gets an array of regular expressions by the given date format
@@ -2156,7 +2054,7 @@ Validates and gets the settings with all set parameters.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | the settings object | &nbsp; |
+| dateFormat |  | the date format | &nbsp; |
@@ -2164,17 +2062,17 @@ Validates and gets the settings with all set parameters.
 ##### Returns
--  a new settings object with all set parameters.
+-  an array of regular expressions
-### dist/general/object/objectCopy.js
+### dist/dates/helpers/getSeparatorByDateFormat.js
-#### objectCopy(entity, cache)
+#### getSeparatorByDateFormat(format)
-Created a new reference of the given argument
+Gets the separator of the date format
@@ -2183,8 +2081,7 @@ Created a new reference of the given argument
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| entity |  | The variable to be copied | &nbsp; |
-| cache |  |  | &nbsp; |
+| format |  | the date format | &nbsp; |
@@ -2192,17 +2089,18 @@ Created a new reference of the given argument
 ##### Returns
--  A new reference of the given argument
+-  a separator string
-### dist/general/object/omit.js
+### dist/dates/helpers/getWeek.js
-#### omit(obj, props)
+#### getWeek(date)
-return a new Object excluding attributes in _props_ list
+Gets the week number of the year
+Additionally, the month and the year
@@ -2211,8 +2109,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; |
+| date |  | the date object | &nbsp; |
@@ -2220,17 +2117,20 @@ return a new Object excluding attributes in _props_ list
 ##### Returns
-- `Object`  clean object
+-  an object with the week, month and year.
-### dist/general/object/pick.js
+### dist/dates/helpers/validateDate.js
-#### pick(baseObject, keys)
+#### validateDate(date, format)
-return a new object just with attributes in _keys_ list
+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
@@ -2239,8 +2139,8 @@ 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 |  | String of date | &nbsp; |
+| format |  | String of the format to validate | &nbsp; |
@@ -2248,17 +2148,17 @@ return a new object just with attributes in _keys_ list
 ##### Returns
-- `Object`  new object just with desired attributes
+-  True if it is valid or not. Undefined if date is undefined
-### dist/general/object/serialize.js
+### dist/dates/helpers/validateDateByDateFormat.js
-#### serialize(obj)
+#### validateDateByDateFormat(date, dateForma)
-serialize object to url param
+Validates the given string as Date by its date format.
@@ -2267,7 +2167,8 @@ serialize object to url param
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj |  | - Object to be serialized | &nbsp; |
+| date |  | a string to validate as date form | &nbsp; |
+| dateForma |  | the format of the date to validate the string | &nbsp; |
@@ -2275,18 +2176,17 @@ serialize object to url param
 ##### Returns
-- `Void`
+-  true: the string is a valida date
-### dist/general/mix/compareDeep.js
+### dist/dates/relative/relative.js
-#### compareDeep(object1, object2)
+#### resolveRelative(statements, clock)
-Compares two objects to know if they are equals. Go across nested objects.
-Includes arrays in the comparison.
+Resolve a list of relative statements according to operator
@@ -2295,35 +2195,46 @@ Includes arrays in the comparison.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| object1 |  | First Object to compare | &nbsp; |
-| object2 |  | Second Object to compare | &nbsp; |
+| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
+| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
-##### Returns
+##### Examples
+```javascript
+Input:
+{
+ "cursor": "the_next",
+ "unit": "year",
+ "number": 1,
+ "includeCurrent": false,
+ "isCalendarDate": false,
+ "anchor": "03/05/2021"
+}
--  True: objects are equal. False: Objects are not equal. Undefined: invalid
+Output:
+{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
+```
+##### Returns
-### dist/general/mix/getTag.js
+- `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
-#### getTag(value)
-Gets the `toStringTag` of `value`.
+### dist/dates/relative/Adapter.js
+#### value()
+Resolves statement and returns statement value
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| value |  | The value to query. | &nbsp; |
@@ -2331,132 +2242,93 @@ Gets the `toStringTag` of `value`.
 ##### Returns
-- `string`  Returns the `toStringTag`.
+- `AbsoluteRange` `string`
+#### valueAsAnchor()
-### dist/general/mix/importScripts.js
+Resolves statement as an anchor
-#### importScripts(scripts)
-Import a set of external Scripts given the URL in both serie and cascade way
+##### Returns
-##### 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; |
+- `string`
+#### _statementToRange()  *private method*
-##### Examples
+Convert verbal statement to range 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
+- `AbsoluteRange`
-#### loadScript(url, type, noModule)
+#### _resolveAsThis()  *private method*
-Creates the script element and appends to document.head
-return a Promise that is resolved when the script is loaded
+Apply 'this' cursor logic to statement
-##### 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; |
+##### Returns
+- `AbsoluteStatement`
-##### Returns
-- `Void`
+#### _resolveAsTheLast()  *private method*
+Apply 'the last' cursor logic to statement
-### dist/general/mix/isEmpty.js
-#### isEmpty(variable, includeFalsy)
-Validates if the given argument is empty
+##### Returns
+- `AbsoluteStatement`
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| variable |  | the given variable | &nbsp; |
-| includeFalsy |  | flag to determine include the falsy variables into the validation | &nbsp; |
+#### _resolveAsTheNext()  *private method*
+Apply 'the next' cursor logic to statement
-##### Returns
--  true: the given argument is empty; false: is not.
+##### Returns
+- `AbsoluteStatement`
-### dist/general/mix/isNaNV2.js
-#### isNaNV2(variable)
+#### replaceNowToken(value, now)
-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.
+Replace '@now' token inside a string
@@ -2465,7 +2337,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| variable |  | the variable to validate | &nbsp; |
+| value | `string`  |  | &nbsp; |
+| now | `Date`  |  | &nbsp; |
@@ -2473,18 +2346,13 @@ Validates if variable is null, undefined, or an empty string, also, the function
 ##### Returns
--  True if variable is a NaN or false otherwise
+- `string`
-### dist/general/mix/isNull.js
-#### isNull(arg)
+#### convertRelativeToAbsolute(args)
-return if a given variable is either `null` or `undefined`
-useful to avoid falsify validating Number Zero (0)
+Returns a range object (date) from a group of statement params
@@ -2493,27 +2361,45 @@ useful to avoid falsify validating Number Zero (0)
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arg | `any`  |  | &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
-- `Boolean`
+- `string`
-### dist/general/mix/size.js
+### dist/dates/range/getDateRange.js
-#### size(obj)
+#### getDateRange(value, dateGroupLabel, withTime)
-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.
+Get date range object from a string date value
@@ -2522,27 +2408,56 @@ Gets the length of the given array.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `Any`  | Any object-type variable | &nbsp; |
+| value | `String`  | string date value | &nbsp; |
+| dateGroupLabel | `String`  | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
+| withTime | `Boolean`  | determines if the date range will include time. Default is true | &nbsp; |
+##### Examples
+```javascript
+// 1) Year:
+getDateRange('2020', 'YEAR');
+// Will return:
+{
+   from: '01/01/2020 00:00:00',
+   to: '12/31/2020 23:59:59'
+}
+// 2) Quarter:
+getDateRange('Q3 2020', 'QUARTER');
+// Will return:
+{
+   from: '07/01/2020 00:00:00',
+   to: '09/30/2020 23:59:59'
+}
+// 3) Month:
+getDateRange('Oct 2020', 'MONTH');
+// Will return:
+{
+   from: '10/01/2020 00:00:00',
+   to: '10/31/2020 23:59:59'
+}
+```
 ##### Returns
-- `Number`  the size of the given variable
+- `Object`  an object with the date range with two string date properties: from and to
-### dist/general/mix/randomId.js
+### dist/dates/adapters/monthYearToDate.js
-#### randomId(length, exclude)
+#### monthYearToDate(monthYearDate, time)
-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.
+Transforms String Date from a [Month Year] format to Date object.
@@ -2551,8 +2466,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; |
+| monthYearDate |  | String of [Month Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -2560,17 +2475,17 @@ Creates a random string
 ##### Returns
-- `String`  Random string
+-  The date object or the date in milliseconds
-### dist/general/string/capitalize.js
+### dist/dates/adapters/quarterYearToDate.js
-#### capitalize(text)
+#### quarterYearToDate(quarterYearDate, time)
-Upper case the first letter of a given text
+Transforms String Date from a [Quarter Year] format to Date object.
@@ -2579,7 +2494,8 @@ Upper case the first letter of a given text
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| text | `String`  |  | &nbsp; |
+| quarterYearDate |  | String of [Quarter Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -2587,17 +2503,17 @@ Upper case the first letter of a given text
 ##### Returns
-- `String`  a capitalized text
+-  The date object or the date in milliseconds
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/dates/adapters/weekYearToDate.js
-#### getColumnLabels(column)
+#### weekYearToDate(date, time)
-Get an string of the properties of the given column.
+Transforms String Date from a [Week Year] format to Date object.
@@ -2606,7 +2522,8 @@ Get an string of the properties of the given column.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column | &nbsp; |
+| date |  | String of [Week Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
@@ -2614,74 +2531,73 @@ Get an string of the properties of the given column.
 ##### Returns
--  an string with the property, aggregate or calculation label.
+-  The date object or the date in milliseconds
-### dist/stencil/decorators/Config.js
+### dist/dates/adapters/mdyDateToDate.js
-#### Config()
-Stencil.js - Prop Decorator
-Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
-But for this, is required ask for a property in `snake_case` style
+#### mdyDateToDate(monthYearDate, time)
+Transforms String Date from a [mm/dd/yyyy] format to Date object.
+##### Parameters
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-```javascript
-\ @Config() @Prop() settings;
-someMethod() {
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-}
-```
 ##### Returns
-- `Void`
+-  The date object or the date in milliseconds
-### dist/stencil/util/createRef.js
+### dist/dates/adapters/yearToDate.js
-#### createRef()
+#### yearToDate(yearDate, time)
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+Transforms String Date from a [Year] format to Date object.
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| yearDate |  | String of [Year] date | &nbsp; |
+| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
 ##### Returns
--  function - Function to use in ref prop in html elements
+-  The date object or the date in milliseconds
-### dist/stencil/util/getConfig.js
+### dist/qrvey/helpers/getColumnsLabel.js
-#### getConfig(cfg)
+#### getColumnLabels(column)
-verify the Config object type and try to return a parsed Object
-- In case _cfg_ is a string, first try to make a JSON parse in other case
-try to find this string as a variable on Windows object
-- If _cfg_ is a fuction, tis is invoked and parsed
-- Finally, if is an object, _cfg_ is inmediatly returned
+Get an string of the properties of the given column.
@@ -2690,7 +2606,7 @@ try to find this string as a variable on Windows object
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  | &nbsp; |
+| column |  | The column | &nbsp; |
@@ -2698,7 +2614,7 @@ try to find this string as a variable on Windows object
 ##### Returns
-- `Void`
+-  an string with the property, aggregate or calculation label.
@@ -2785,21 +2701,14 @@ Get a dataset by Qrvey ID
-### dist/typescript/decorators/Debounce.js
-#### Debounce(time)
-(Method Decorator) Debounce Class Method
+### dist/stencil/util/createRef.js
+#### createRef()
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 | &nbsp; |
@@ -2807,17 +2716,21 @@ Get a dataset by Qrvey ID
 ##### Returns
-- `Void`
+-  function - Function to use in ref prop in html elements
-### dist/typescript/decorators/Throttled.js
+### dist/stencil/util/getConfig.js
-#### Throttled(time)
+#### getConfig(cfg)
-(Method Decorator) Throttled Class Method
+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
@@ -2826,7 +2739,7 @@ Get a dataset by Qrvey ID
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 | &nbsp; |
+| cfg |  |  | &nbsp; |
@@ -2839,39 +2752,45 @@ Get a dataset by Qrvey ID
-### dist/dates/relative/helpers/formatStatement.js
+### dist/stencil/decorators/Config.js
-#### formatStatement(statement)
+#### Config()
-Build a proper relative date statement type
+Stencil.js - Prop Decorator
+Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
+But for this, is required ask for a property in `snake_case` style
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| statement | `RelativeStatement`  |  | &nbsp; |
+##### Examples
+```javascript
+\ @Config() @Prop() settings;
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 ##### Returns
-- `RelativeStatement`
+- `Void`
-### dist/dates/relative/helpers/getStatementCase.js
+### dist/typescript/decorators/Debounce.js
-#### getStatementCase(includeCurrent, isCalendarDate)
+#### Debounce(time)
-Returns a number/constant that identifies a relative date case
+(Method Decorator) Debounce Class Method
@@ -2880,8 +2799,7 @@ Returns a number/constant that identifies a relative date case
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| includeCurrent | `boolean`  |  | &nbsp; |
-| isCalendarDate | `boolean`  |  | &nbsp; |
+| time |  | (optional) deafult 500 | &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/typescript/decorators/Throttled.js
-#### parseDate(date)
+#### Throttled(time)
-Parses a string date and returns a dayjs date
+(Method Decorator) Throttled Class Method
@@ -2908,7 +2826,7 @@ Parses a string date and returns a dayjs date
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| date | `string` `Dayjs` `Date`  |  | &nbsp; |
+| time |  | (optional) deafult 500 | &nbsp; |
@@ -2916,7 +2834,7 @@ Parses a string date and returns a dayjs date
 ##### Returns
-- `Dayjs`  A dayjs date
+- `Void`
@@ -3058,6 +2976,33 @@ Gets a group value for the backend logic structure
+### dist/filters/helpers/backend/getBackendProperty.js
+#### getBackendProperty(filter)
+Gets a property for the logic structure
+##### Parameters
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  | The filter | &nbsp; |
+##### Returns
+-  a property
 ### dist/filters/helpers/backend/getBackendValidator.js
@@ -3160,12 +3105,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 +3119,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 +3128,7 @@ Gets a property for the logic structure
 ##### Returns
--  a property
+-  a new Logic array
@@ -3216,12 +3162,12 @@ Gets filters from the logic by the scopes hierarchy.
-### dist/filters/helpers/backend/getLogicByScopes.js
+### dist/filters/helpers/common/areFiltersEquals.js
-#### getLogicByScopes(logics, scopes)
+#### areFiltersEquals(filter1, filter2)
-Gets the filters from logic data by Scopes/Scope IDs.
+Validates if both filters are the same
@@ -3230,8 +3176,8 @@ 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; |
+| filter1 |  | filter 1 | &nbsp; |
+| filter2 |  | filter 2 | &nbsp; |
@@ -3239,7 +3185,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
 ##### Returns
--  a new Logic array
+-  true: the filters are equal; false: the filters are NOT equal
@@ -3271,12 +3217,21 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
-#### areFiltersEquals(filter1, filter2)
+#### excludeFiltersByParams(filterData, params)
-Validates if both filters are the same
+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
@@ -3285,8 +3240,8 @@ Validates if both filters are the same
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 | &nbsp; |
-| filter2 |  | filter 2 | &nbsp; |
+| filterData |  | The Filter Data or the UI Filter Data | &nbsp; |
+| params |  | given parameters to validate the filter data | &nbsp; |
@@ -3294,7 +3249,7 @@ Validates if both filters are the same
 ##### Returns
--  true: the filters are equal; false: the filters are NOT equal
+-  a new Filter object structure
@@ -3327,43 +3282,6 @@ Excludes and returns a filter data without filters by the given scopes
-### dist/filters/helpers/common/excludeFiltersByParams.js
-#### excludeFiltersByParams(filterData, params)
-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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data or the UI Filter Data | &nbsp; |
-| params |  | given parameters to validate the filter data | &nbsp; |
-##### Returns
--  a new Filter object structure
 ### dist/filters/helpers/common/getFilterColumnLabel.js
@@ -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/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
+### 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`
 *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*