@qrvey/utils 1.2.9-11 → 1.2.9-15

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-11*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-15*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -2622,7 +2622,7 @@ Get an string of the properties of the given column.
 ### dist/services/api/getAllDatasets.api.js
 
 
-#### getAllDatasets(qrveyids) 
+#### getAllDatasets(config, pickDatasets) 
 
 Get a dataset list from a collection of Qrvey IDs
 
@@ -2633,7 +2633,8 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
+| config |  | the widget config. Includes the appid and others configuration properties |   |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
 
 
@@ -2701,29 +2702,23 @@ Get a dataset by Qrvey ID
 
 
 
-### dist/stencil/decorators/Config.js
-
+### dist/typescript/decorators/Throttled.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
+#### Throttled(time) 
 
+(Method Decorator) Throttled Class Method
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| time |  | (optional) deafult 500 |   |
 
-```javascript
-\ @Config() @Prop() settings;
 
-someMethod() {
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-}
-```
 
 
 ##### Returns
@@ -2734,72 +2729,74 @@ someMethod() {
 
 
 
-### dist/stencil/util/createRef.js
+### dist/typescript/decorators/Debounce.js
 
 
-#### createRef() 
+#### Debounce(time) 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+(Method Decorator) Debounce Class Method
 
 
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| time |  | (optional) deafult 500 |   |
 
 
-##### Returns
 
 
--  function - Function to use in ref prop in html elements
+##### Returns
 
 
+- `Void`
 
 
-### dist/stencil/util/getConfig.js
 
 
-#### getConfig(cfg) 
+### dist/stencil/decorators/Config.js
 
-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
 
+#### 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
 
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
 
 
 
+##### Examples
 
-##### Returns
+```javascript
+\ @Config() @Prop() settings;
 
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 
-- `Void`
 
+##### Returns
 
 
+- `Void`
 
-### 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 |   |
 
 
 
@@ -2807,17 +2804,21 @@ try to find this string as a variable on Windows object
 ##### 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 +2827,7 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 |   |
+| cfg |  |  |   |
 
 
 
@@ -3244,12 +3245,12 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### excludeFiltersByAggregateColumn(filterData) 
+#### areFiltersEquals(filter1, filter2) 
 
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
+Validates if both filters are the same
 
 
 
@@ -3258,7 +3259,8 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3266,17 +3268,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 ##### Returns
 
 
--  The new filter data object that were excluded the aggregate filters
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Validates if both filters are the same
+Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
 
 
 
@@ -3285,8 +3287,7 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3294,7 +3295,7 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  The new filter data object that were excluded the aggregate filters
 
 
 
@@ -3364,12 +3365,12 @@ Excludes and returns a filter data without filters by the given scopes
 
 
 
-### dist/filters/helpers/common/getFilterColumnLabel.js
+### dist/filters/helpers/common/getFilterLabel.js
 
 
-#### getFilterColumnLabel(column) 
+#### getFilterLabel(filter) 
 
-Get an string of the properties of the given filter column.
+Gets the Filter Label + Column label
 
 
 
@@ -3378,7 +3379,7 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| filter |  | the UI filter |   |
 
 
 
@@ -3386,17 +3387,17 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  a sring label
 
 
 
 
-### dist/filters/helpers/common/getFilterLabel.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### getFilterLabel(filter) 
+#### getFilterColumnLabel(column) 
 
-Gets the Filter Label + Column label
+Get an string of the properties of the given filter column.
 
 
 
@@ -3405,7 +3406,7 @@ Gets the Filter Label + Column label
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
+| column |  | The filter column |   |
 
 
 
@@ -3413,7 +3414,7 @@ Gets the Filter Label + Column label
 ##### Returns
 
 
--  a sring label
+-  an string with the property, aggregate or calculation label.
 
 
 
@@ -3631,12 +3632,12 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+### dist/filters/helpers/common/haveFiltersByDataset.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### haveFiltersByDataset(filterData, qrveyid) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 
 
@@ -3645,7 +3646,8 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings |   |
+| filterData |  | the filter data or the UI filter data. |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -3653,17 +3655,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
+-  true: the filter data has filters by the Qrvey ID
 
 
 
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
+### dist/filters/helpers/common/getParamsToGetFilterSettings.js
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
+#### getParamsToGetFilterSettings(settings) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3672,8 +3674,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | the filter data or the UI filter data. |   |
-| qrveyid |  | The Qrvey ID |   |
+| settings |  | an object to the ParamsToGetFilter settings |   |
 
 
 
@@ -3681,7 +3682,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
 ##### Returns
 
 
--  true: the filter data has filters by the Qrvey ID
+-  a new ParamsToGetFilter settings object.
 
 
 
@@ -3741,12 +3742,12 @@ Determines if the filter column and property is a distinct group dates type
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### isInValidator(validator) 
+#### isNullValidator(validator) 
 
-Validates if the given validator is a In type
+Checks if the given validator is a Null type.
 
 
 
@@ -3755,7 +3756,7 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -3763,17 +3764,17 @@ Validates if the given validator is a In type
 ##### Returns
 
 
--  true: it is a In validator; false: it is not a In validator
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
 
-### dist/filters/helpers/common/isNullValidator.js
+### dist/filters/helpers/common/isInValidator.js
 
 
-#### isNullValidator(validator) 
+#### isInValidator(validator) 
 
-Checks if the given validator is a Null type.
+Validates if the given validator is a In type
 
 
 
@@ -3782,7 +3783,7 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| validator |  | The validator |   |
 
 
 
@@ -3790,7 +3791,7 @@ Checks if the given validator is a Null type.
 ##### Returns
 
 
--  True: It is a Null Validator; False: It is not a Null Validator.
+-  true: it is a In validator; false: it is not a In validator
 
 
 
@@ -4150,6 +4151,34 @@ Gets the label of the filter property
 
 
 
+### dist/filters/helpers/ui/getUIFlatFilterByParams.js
+
+
+#### getUIFlatFilterByParams() 
+
+Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
+The validation to filter the stored filter is depending on:
+- Column
+- Qrvey ID,
+- Scope type
+- Scope ID
+- Panel ID
+- Validator type
+- Property type
+
+
+
+
+
+
+##### Returns
+
+
+-  The index of the uFilter array or the Filter object s
+
+
+
+
 ### dist/filters/helpers/ui/getOutputFormatByColumn.js
 
 
@@ -4178,30 +4207,30 @@ Gets output format object from Datasets by the given column. Item of the dataset
 
 
 
-### dist/filters/helpers/ui/getUIFlatFilterByParams.js
+### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
 
 
-#### getUIFlatFilterByParams() 
+#### getQrveyIdsByUIFilters(uiFilter) 
 
-Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID,
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
+Gets a collection of Qrvey IDs in the UI Filter structure.
+Looks around all filter structure finding the qrveyid propertty in each dataset
 
 
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| uiFilter |  |  |   |
+
+
 
 
 ##### Returns
 
 
--  The index of the uFilter array or the Filter object s
+- `Void`
 
 
 
@@ -4292,6 +4321,34 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 
 
+### dist/filters/helpers/ui/getUpdatedUIFilters.js
+
+
+#### getUpdatedUIFilters(data, datasets) 
+
+Gets a new UI Filter structure with a datasets/columns info updates
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| data |  | The UI Filter structure |   |
+| datasets |  | An array of datasets/column info used for updating the data |   |
+
+
+
+
+##### Returns
+
+
+-  A new UI FIlter structure
+
+
+
+
 ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
 
 

package/dist/charts/constants/AGGREGATE_LABEL.d.ts

@@ -1,5 +1,5 @@
 export declare enum AGGREGATE_LABEL {
-    NONE = "None",
+    NONE = "No Aggregate",
     AVG = "Average",
     MEDIAN = "Median",
     MIN = "Minimum",

package/dist/charts/constants/AGGREGATE_LABEL.js

@@ -1,6 +1,6 @@
 export var AGGREGATE_LABEL;
 (function (AGGREGATE_LABEL) {
-    AGGREGATE_LABEL["NONE"] = "None";
+    AGGREGATE_LABEL["NONE"] = "No Aggregate";
     AGGREGATE_LABEL["AVG"] = "Average";
     AGGREGATE_LABEL["MEDIAN"] = "Median";
     AGGREGATE_LABEL["MIN"] = "Minimum";

package/dist/cjs/charts/constants/AGGREGATE_LABEL.d.ts

@@ -1,5 +1,5 @@
 export declare enum AGGREGATE_LABEL {
-    NONE = "None",
+    NONE = "No Aggregate",
     AVG = "Average",
     MEDIAN = "Median",
     MIN = "Minimum",

package/dist/cjs/charts/constants/AGGREGATE_LABEL.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AGGREGATE_LABEL = void 0;
 var AGGREGATE_LABEL;
 (function (AGGREGATE_LABEL) {
-    AGGREGATE_LABEL["NONE"] = "None";
+    AGGREGATE_LABEL["NONE"] = "No Aggregate";
     AGGREGATE_LABEL["AVG"] = "Average";
     AGGREGATE_LABEL["MEDIAN"] = "Median";
     AGGREGATE_LABEL["MIN"] = "Minimum";

package/dist/cjs/filters/helpers/ui/getQrveyIdsByUIFilters.d.ts

@@ -0,0 +1,7 @@
+import { IFSData } from "../../interfaces/common/IFSData";
+/**
+ * Gets a collection of Qrvey IDs in the UI Filter structure.
+ * Looks around all filter structure finding the qrveyid propertty in each dataset
+ * @param uiFilter
+ */
+export declare function getQrveyIdsByUIFilters(uiFilter: IFSData): string[];

package/dist/cjs/filters/helpers/ui/getQrveyIdsByUIFilters.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getQrveyIdsByUIFilters = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+/**
+ * Gets a collection of Qrvey IDs in the UI Filter structure.
+ * Looks around all filter structure finding the qrveyid propertty in each dataset
+ * @param uiFilter
+ */
+function getQrveyIdsByUIFilters(uiFilter) {
+    const qrveyids = [];
+    if ((0, isEmpty_1.isEmpty)(uiFilter))
+        return qrveyids;
+    uiFilter.scopes.forEach(scope => {
+        if (!(0, isEmpty_1.isEmpty)(scope.datasets)) {
+            scope.datasets.forEach(dataset => {
+                if (!(0, isEmpty_1.isEmpty)(dataset))
+                    qrveyids.push(dataset.qrveyid);
+            });
+        }
+    });
+    return qrveyids;
+}
+exports.getQrveyIdsByUIFilters = getQrveyIdsByUIFilters;

package/dist/cjs/filters/helpers/ui/getUpdatedUIFilters.d.ts

@@ -0,0 +1,9 @@
+import { IDataset } from "../../../qrvey/interfaces/IDataset";
+import { IFUData } from "../../interfaces/ui/IFUData";
+/**
+ * Gets a new UI Filter structure with a datasets/columns info updates
+ * @param data The UI Filter structure
+ * @param datasets An array of datasets/column info used for updating the data
+ * @returns A new UI FIlter structure
+ */
+export declare function getUpdatedUIFilters(data: IFUData, datasets?: IDataset[]): IFUData;

package/dist/cjs/filters/helpers/ui/getUpdatedUIFilters.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUpdatedUIFilters = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+/**
+ * Gets a new UI Filter structure with a datasets/columns info updates
+ * @param data The UI Filter structure
+ * @param datasets An array of datasets/column info used for updating the data
+ * @returns A new UI FIlter structure
+ */
+function getUpdatedUIFilters(data, datasets = []) {
+    if ((0, isEmpty_1.isEmpty)(data) || (0, isEmpty_1.isEmpty)(datasets))
+        return data;
+    const updatedScopes = data.scopes.map(scopes => {
+        scopes.datasets = scopes.datasets.map(dataset => {
+            const datasetInfo = datasets.find(dInfo => dInfo.qrveyid === dataset.qrveyid && dInfo.linkid === dataset.linkid);
+            if (!(0, isEmpty_1.isEmpty)(datasetInfo))
+                dataset.label = datasetInfo.label;
+            dataset.filters = dataset.filters.map(filter => {
+                let columnInfo;
+                if (!(0, isEmpty_1.isEmpty)(datasetInfo))
+                    columnInfo = datasetInfo.options.find(cInfo => { var _a, _b; return cInfo.id === filter.column.id && ((_a = cInfo.dataset) === null || _a === void 0 ? void 0 : _a.qrveyid) === filter.column.qrveyid && ((_b = cInfo.dataset) === null || _b === void 0 ? void 0 : _b.linkid) === filter.column.linkid; });
+                if (!(0, isEmpty_1.isEmpty)(columnInfo)) {
+                    filter.column.formulaType = columnInfo.formulaType;
+                    filter.column.label = columnInfo.label;
+                    filter.column.type = columnInfo.type;
+                }
+                return filter;
+            });
+            return dataset;
+        });
+        return scopes;
+    });
+    return Object.assign(Object.assign({}, data), { scopes: updatedScopes });
+}
+exports.getUpdatedUIFilters = getUpdatedUIFilters;