@qrvey/utils 1.2.4-18 → 1.2.4-19

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-18*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-19*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -108,12 +108,12 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
 
 
 
-### dist/dates/adapters/monthYearToDate.js
+### dist/dates/adapters/quarterYearToDate.js
 
 
-#### monthYearToDate(monthYearDate, time) 
+#### quarterYearToDate(quarterYearDate, time) 
 
-Transforms String Date from a [Month Year] format to Date object.
+Transforms String Date from a [Quarter Year] format to Date object.
 
 
 
@@ -122,7 +122,7 @@ Transforms String Date from a [Month Year] format to Date object.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| monthYearDate |  | String of [Month Year] date |   |
+| quarterYearDate |  | String of [Quarter Year] date |   |
 | time |  | Flag to parse the object date to milliseconds. |   |
 
 
@@ -136,12 +136,12 @@ Transforms String Date from a [Month Year] format to Date object.
 
 
 
-### dist/dates/adapters/quarterYearToDate.js
+### dist/dates/adapters/monthYearToDate.js
 
 
-#### quarterYearToDate(quarterYearDate, time) 
+#### monthYearToDate(monthYearDate, time) 
 
-Transforms String Date from a [Quarter Year] format to Date object.
+Transforms String Date from a [Month Year] format to Date object.
 
 
 
@@ -150,7 +150,7 @@ Transforms String Date from a [Quarter Year] format to Date object.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| quarterYearDate |  | String of [Quarter Year] date |   |
+| monthYearDate |  | String of [Month Year] date |   |
 | time |  | Flag to parse the object date to milliseconds. |   |
 
 
@@ -1327,12 +1327,12 @@ Gets an filter structure for the UI filter data
 
 
 
-### dist/filters/adapters/logicToFD.js
+### dist/filters/adapters/logicToFlatUI.js
 
 
-#### logicToFD(filterData, version) 
+#### logicToFlatUI(logics) 
 
-Generates a filter data structure from the old logic structure (v2.0).
+Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 
 
 
@@ -1341,8 +1341,7 @@ Generates a filter data structure from the old logic structure (v2.0).
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The old filter data structure with logic (v2.0) |   |
-| version |  | Tag for the version of the filter data structure |   |
+| logics |  | The old logic structure (v2.0) |   |
 
 
 
@@ -1350,17 +1349,13 @@ Generates a filter data structure from the old logic structure (v2.0).
 ##### Returns
 
 
--  a Filter Data.
-
-
-
+-  The Flattened UI Filters array
 
-### dist/filters/adapters/logicToFlatUI.js
 
 
-#### logicToFlatUI(logics) 
+#### getFilter(filters, filter, getIndex) 
 
-Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
+Get the filter or the index of the given array, validating an old filter structure.
 
 
 
@@ -1369,7 +1364,9 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The old logic structure (v2.0) |   |
+| filters |  | The array of UI filters |   |
+| filter |  | The old logic structure filter |   |
+| getIndex |  | Determines if the index or returns the UI filter object |   |
 
 
 
@@ -1377,13 +1374,13 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
 ##### Returns
 
 
--  The Flattened UI Filters array
+-  the index or the UI filter object
 
 
 
-#### getFilter(filters, filter, getIndex) 
+#### refineRankingValues(values, uiValues) 
 
-Get the filter or the index of the given array, validating an old filter structure.
+Refines the values of the Ranking column type.
 
 
 
@@ -1392,9 +1389,8 @@ Get the filter or the index of the given array, validating an old filter structu
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filters |  | The array of UI filters |   |
-| filter |  | The old logic structure filter |   |
-| getIndex |  | Determines if the index or returns the UI filter object |   |
+| values |  | the Array of Ranking values |   |
+| uiValues |  | Object with additional info about the values of the filter. |   |
 
 
 
@@ -1402,13 +1398,17 @@ Get the filter or the index of the given array, validating an old filter structu
 ##### Returns
 
 
--  the index or the UI filter object
+-  the array of Ranking values
 
 
 
-#### refineRankingValues(values, uiValues) 
 
-Refines the values of the Ranking column type.
+### dist/filters/adapters/logicToFD.js
+
+
+#### logicToFD(filterData, version) 
+
+Generates a filter data structure from the old logic structure (v2.0).
 
 
 
@@ -1417,8 +1417,8 @@ Refines the values of the Ranking column type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| values |  | the Array of Ranking values |   |
-| uiValues |  | Object with additional info about the values of the filter. |   |
+| filterData |  | The old filter data structure with logic (v2.0) |   |
+| version |  | Tag for the version of the filter data structure |   |
 
 
 
@@ -1426,7 +1426,7 @@ Refines the values of the Ranking column type.
 ##### Returns
 
 
--  the array of Ranking values
+-  a Filter Data.
 
 
 
@@ -1729,12 +1729,12 @@ Filters a nested tree array by a custom condition on the last child node
 
 
 
-### dist/general/array/getFirstIndexFromArray.js
+### dist/general/array/flattenDeep.js
 
 
-#### getFirstIndexFromArray(array, callback) 
+#### flattenDeep(arr) 
 
-Gets the first index from the array by a callback condition
+Flat deeply an array
 
 
 
@@ -1743,8 +1743,7 @@ Gets the first index from the array by a callback condition
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  |   |
-| callback |  | function callback |   |
+| arr |  | Array to flat deeply |   |
 
 
 
@@ -1752,17 +1751,17 @@ Gets the first index from the array by a callback condition
 ##### Returns
 
 
--  the first index of the array. -1 when the condition is not satisfied
+-  flatten array
 
 
 
 
-### dist/general/array/flattenDeep.js
+### dist/general/array/getFirstIndexFromArray.js
 
 
-#### flattenDeep(arr) 
+#### getFirstIndexFromArray(array, callback) 
 
-Flat deeply an array
+Gets the first index from the array by a callback condition
 
 
 
@@ -1771,7 +1770,8 @@ Flat deeply an array
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply |   |
+| array |  |  |   |
+| callback |  | function callback |   |
 
 
 
@@ -1779,7 +1779,7 @@ Flat deeply an array
 ##### Returns
 
 
--  flatten array
+-  the first index of the array. -1 when the condition is not satisfied
 
 
 
@@ -2592,69 +2592,66 @@ Upper case the first letter of a given text
 
 
 
-### dist/stencil/decorators/Config.js
+### dist/qrvey/helpers/getColumnsLabel.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
+#### getColumnLabels(column) 
 
+Get an string of the properties of the given column.
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| column |  | The column |   |
 
-```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`
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/stencil/util/createRef.js
+### dist/services/api/getAllDatasets.api.js
 
 
-#### createRef() 
+#### getAllDatasets(qrveyids) 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+Get a dataset list from a collection of Qrvey IDs
 
 
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| qrveyids |  | Collection of Qrvey IDs |   |
+
+
 
 
 ##### Returns
 
 
--  function - Function to use in ref prop in html elements
+-  a promise
 
 
 
 
-### dist/stencil/util/getConfig.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### getConfig(cfg) 
+#### getAllQrveys(config, params) 
 
-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
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
@@ -2663,7 +2660,8 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
 
 
@@ -2676,12 +2674,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/services/api/getAllDatasets.api.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getAllDatasets(qrveyids) 
+#### getDatasetColumns(qrveyid) 
 
-Get a dataset list from a collection of Qrvey IDs
+Get a dataset by Qrvey ID
 
 
 
@@ -2690,7 +2688,7 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2703,24 +2701,29 @@ Get a dataset list from a collection of Qrvey IDs
 
 
 
-### dist/services/api/getAllQrveys.api.js
+### dist/stencil/decorators/Config.js
 
 
-#### getAllQrveys(config, params) 
+#### Config() 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+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 |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
 
+##### 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
@@ -2731,21 +2734,14 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 
 
 
-### dist/services/api/getDatasetColumns.api.js
-
-
-#### getDatasetColumns(qrveyid) 
-
-Get a dataset by Qrvey ID
+### dist/stencil/util/createRef.js
 
 
+#### createRef() 
 
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2753,17 +2749,21 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
+-  function - Function to use in ref prop in html elements
 
 
 
 
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/stencil/util/getConfig.js
 
 
-#### getColumnLabels(column) 
+#### getConfig(cfg) 
 
-Get an string of the properties of the given 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
 
 
 
@@ -2772,7 +2772,7 @@ Get an string of the properties of the given column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
+| cfg |  |  |   |
 
 
 
@@ -2780,7 +2780,7 @@ Get an string of the properties of the given column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+- `Void`
 
 
 
@@ -2921,33 +2921,6 @@ Parses a string date and returns a dayjs date
 
 
 
-### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
-
-
-#### getFilterBuilderGeneralConfig(config) 
-
-Returns a filter builder config object by a any given config
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | any config object |   |
-
-
-
-
-##### Returns
-
-
--  The filter builder config object
-
-
-
-
 ### dist/filters/helpers/backend/buildExpression.js
 
 
@@ -3031,12 +3004,12 @@ Transform user Filters array into Filter Logic structure
 
 
 
-### dist/filters/helpers/backend/getBackendProperty.js
+### dist/filters/helpers/backend/getBackendGroupValue.js
 
 
-#### getBackendProperty(filter) 
+#### getBackendGroupValue(filter) 
 
-Gets a property for the logic structure
+Gets a group value for the backend logic structure
 
 
 
@@ -3058,12 +3031,12 @@ Gets a property for the logic structure
 
 
 
-### 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
 
 
 
@@ -3187,6 +3160,34 @@ Gets the Ranking values.
 
 
 
+### dist/filters/helpers/backend/getLogicByScopes.js
+
+
+#### getLogicByScopes(logics, scopes) 
+
+Gets the filters from logic data by Scopes/Scope IDs.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| logics |  | The logic array |   |
+| scopes |  | The collection of Scopes/Scope IDs |   |
+
+
+
+
+##### Returns
+
+
+-  a new Logic array
+
+
+
+
 ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
 
 
@@ -3216,12 +3217,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 +3231,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The logic array |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| config |  | any config object |   |
 
 
 
@@ -3239,7 +3239,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Logic array
+-  The filter builder config object
 
 
 
@@ -3418,12 +3418,23 @@ Gets the Filter Label + Column label
 
 
 
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
+### dist/filters/helpers/common/getFilterid.js
 
 
-#### getFiltersByAggregateColumn(filterData) 
+#### getFilterid(filter) 
 
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
+Get the Filter ID by the filter structure
+The order of the epression ID is:
+- Scope Type
+- scopeid
+- qrveyid
+- panelid
+- columnid
+- validator
+- property
+- Column Aggregate
+- Column Calculation
+- Optional Index
 
 
 
@@ -3432,7 +3443,7 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| filter |  | the filter structure |   |
 
 
 
@@ -3440,28 +3451,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 ##### Returns
 
 
--  The new filter data object that were get the aggregate filters
+-  a text to identify the filter
 
 
 
 
-### dist/filters/helpers/common/getFilterid.js
+### dist/filters/helpers/common/getFiltersByAggregateColumn.js
 
 
-#### getFilterid(filter) 
+#### getFiltersByAggregateColumn(filterData) 
 
-Get the Filter ID by the filter structure
-The order of the epression ID is:
-- Scope Type
-- scopeid
-- qrveyid
-- panelid
-- columnid
-- validator
-- property
-- Column Aggregate
-- Column Calculation
-- Optional Index
+Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
 
 
 
@@ -3470,7 +3470,7 @@ The order of the epression ID is:
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3478,7 +3478,7 @@ The order of the epression ID is:
 ##### Returns
 
 
--  a text to identify the filter
+-  The new filter data object that were get the aggregate filters
 
 
 
@@ -3822,6 +3822,33 @@ Validates if the given validator is a Range type. Range type means the value has
 
 
 
+### dist/filters/helpers/common/isRegularValidator.js
+
+
+#### isRegularValidator(validator) 
+
+Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| validator |  | The filter validator |   |
+
+
+
+
+##### Returns
+
+
+-  true: it is a range validator
+
+
+
+
 ### dist/filters/helpers/common/mergeFilters.js
 
 
@@ -3951,33 +3978,6 @@ Gets a new value structure array by merging two value structures
 
 
 
-### dist/filters/helpers/common/isRegularValidator.js
-
-
-#### isRegularValidator(validator) 
-
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
-
-
-
-
-##### Returns
-
-
--  true: it is a range validator
-
-
-
-
 ### dist/filters/helpers/common/resolveDatasetConditions.js
 
 

package/dist/cjs/globalization/interfaces/filters/II18nFilter.d.ts

@@ -6,7 +6,7 @@ import { II18nRankingContainer } from "./II18nRankingContainer";
 import { II18nFilterOperator } from "./II18nFilterOperator";
 import { II18nFilterScopes } from "./II18nFilterScopes";
 export interface II18nFilter {
-    suffix_scope_label: string;
+    scope_label: string;
     operators: II18nFilterOperator;
     ranking_container: II18nRankingContainer;
     relative_container: II18nRelativeContainer;

package/dist/cjs/globalization/labels/filters/I18N_FILTER.js

@@ -9,7 +9,7 @@ const I18N_RELATIVE_CONTAINER_1 = require("./I18N_RELATIVE_CONTAINER");
 const I18N_SLIDEBAR_1 = require("./I18N_SLIDEBAR");
 const I18N_VALUE_CONTAINER_1 = require("./I18N_VALUE_CONTAINER");
 exports.I18N_FILTER = {
-    suffix_scope_label: '{{scope}} Filters',
+    scope_label: '{{scope}} Filters',
     operators: I18N_FILTER_OPERATOR_1.I18N_FILTER_OPERATOR,
     relative_container: I18N_RELATIVE_CONTAINER_1.I18N_RELATIVE_CONTAINER,
     scope: I18N_FILTER_SCOPE_1.I18N_FILTER_SCOPE,

package/dist/globalization/interfaces/filters/II18nFilter.d.ts

@@ -6,7 +6,7 @@ import { II18nRankingContainer } from "./II18nRankingContainer";
 import { II18nFilterOperator } from "./II18nFilterOperator";
 import { II18nFilterScopes } from "./II18nFilterScopes";
 export interface II18nFilter {
-    suffix_scope_label: string;
+    scope_label: string;
     operators: II18nFilterOperator;
     ranking_container: II18nRankingContainer;
     relative_container: II18nRelativeContainer;

package/dist/globalization/labels/filters/I18N_FILTER.js

@@ -6,7 +6,7 @@ import { I18N_RELATIVE_CONTAINER } from "./I18N_RELATIVE_CONTAINER";
 import { I18N_SLIDEBAR } from "./I18N_SLIDEBAR";
 import { I18N_VALUE_CONTAINER } from "./I18N_VALUE_CONTAINER";
 export const I18N_FILTER = {
-    suffix_scope_label: '{{scope}} Filters',
+    scope_label: '{{scope}} Filters',
     operators: I18N_FILTER_OPERATOR,
     relative_container: I18N_RELATIVE_CONTAINER,
     scope: I18N_FILTER_SCOPE,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.2.4-18",
+  "version": "1.2.4-19",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",

package/src/globalization/interfaces/filters/II18nFilter.ts

@@ -7,7 +7,7 @@ import { II18nFilterOperator } from "./II18nFilterOperator";
 import { II18nFilterScopes } from "./II18nFilterScopes";
 
 export interface II18nFilter {
-    suffix_scope_label: string; // The sustantive of the scopes. i.e: suffix_scope_label='Filters'; Result: Global *Filters*
+    scope_label: string; // The sustantive of the scopes. i.e: scope_label='Filters'; Result: Global *Filters*
     operators: II18nFilterOperator;
     ranking_container: II18nRankingContainer;
     relative_container: II18nRelativeContainer;

package/src/globalization/labels/filters/I18N_FILTER.ts

@@ -8,7 +8,7 @@ import { I18N_SLIDEBAR } from "./I18N_SLIDEBAR";
 import { I18N_VALUE_CONTAINER } from "./I18N_VALUE_CONTAINER";
 
 export const I18N_FILTER: II18nFilter = {
-    suffix_scope_label: '{{scope}} Filters',
+    scope_label: '{{scope}} Filters',
     operators: I18N_FILTER_OPERATOR,
     relative_container: I18N_RELATIVE_CONTAINER,
     scope: I18N_FILTER_SCOPE,