@qrvey/utils 1.2.9-15 → 1.2.9-19

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-15*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-19*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -2619,12 +2619,13 @@ Get an string of the properties of the given column.
 
 
 
-### dist/services/api/getAllDatasets.api.js
+### dist/qrvey/helpers/getValueWithSuffixes.js
 
 
-#### getAllDatasets(config, pickDatasets) 
+#### getValueWithSuffixes(value, suffixes) 
 
-Get a dataset list from a collection of Qrvey IDs
+Get a string value with suffixes if available.
+Add suffix into the value string. Prioritized for numeric values.
 
 
 
@@ -2633,8 +2634,8 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | the widget config. Includes the appid and others configuration properties |   |
-| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
+| value |  | a number or string |   |
+| suffixes |  | An object with singular or plural suffix string. |   |
 
 
 
@@ -2642,17 +2643,17 @@ Get a dataset list from a collection of Qrvey IDs
 ##### Returns
 
 
--  a promise
+-  a string value with suffix
 
 
 
 
-### dist/services/api/getAllQrveys.api.js
+### dist/qrvey/helpers/transformValue.js
 
 
-#### getAllQrveys(config, params) 
+#### transformValue(value, settings) 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+Transforms a value depending of localization/globalization and extras settings.
 
 
 
@@ -2661,8 +2662,8 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
+| value |  | A value to transform |   |
+| settings |  | The settings of the transformValue function |   |
 
 
 
@@ -2670,17 +2671,36 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
 
 
-- `Void`
+-  A transformed value
 
 
 
+#### getOutputFormat(settings) 
 
-### dist/services/api/getDatasetColumns.api.js
+Gets the outputformat settings
 
 
-#### getDatasetColumns(qrveyid) 
 
-Get a dataset by Qrvey ID
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| settings |  | The settings of the transformValue function |   |
+
+
+
+
+##### Returns
+
+
+-  the outputformat settings
+
+
+
+#### getFormatConfig(settings) 
+
+Gets the format config
 
 
 
@@ -2689,7 +2709,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| settings |  | The settings of the transformValue function |   |
 
 
 
@@ -2697,17 +2717,74 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
+-  the format config
 
 
 
 
-### dist/typescript/decorators/Throttled.js
+### dist/stencil/decorators/Config.js
 
 
-#### Throttled(time) 
+#### 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
+
+
+
+
+
+
+##### Examples
+
+```javascript
+\ @Config() @Prop() settings;
+
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 
-(Method Decorator) Throttled Class Method
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+### dist/stencil/util/createRef.js
+
+
+#### createRef() 
+
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+
+
+
+
+
+
+##### Returns
+
+
+-  function - Function to use in ref prop in html elements
+
+
+
+
+### dist/stencil/util/getConfig.js
+
+
+#### getConfig(cfg) 
+
+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
 
 
 
@@ -2716,7 +2793,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 |   |
+| cfg |  |  |   |
 
 
 
@@ -2729,12 +2806,12 @@ Get a dataset by Qrvey ID
 
 
 
-### dist/typescript/decorators/Debounce.js
+### dist/services/api/getAllDatasets.api.js
 
 
-#### Debounce(time) 
+#### getAllDatasets(config, pickDatasets) 
 
-(Method Decorator) Debounce Class Method
+Get a dataset list from a collection of Qrvey IDs
 
 
 
@@ -2743,7 +2820,8 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 |   |
+| config |  | the widget config. Includes the appid and others configuration properties |   |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
 
 
@@ -2751,34 +2829,29 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
 
-### dist/stencil/decorators/Config.js
-
+### dist/services/api/getAllQrveys.api.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
+#### getAllQrveys(config, params) 
 
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
-```javascript
-\ @Config() @Prop() settings;
 
-someMethod() {
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-}
-```
 
 
 ##### Returns
@@ -2789,14 +2862,21 @@ someMethod() {
 
 
 
-### dist/stencil/util/createRef.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### createRef() 
+#### getDatasetColumns(qrveyid) 
+
+Get a dataset by Qrvey ID
+
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2804,21 +2884,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
 ##### Returns
 
 
--  function - Function to use in ref prop in html elements
+-  a promise
 
 
 
 
-### dist/stencil/util/getConfig.js
+### dist/typescript/decorators/Debounce.js
 
 
-#### getConfig(cfg) 
+#### Debounce(time) 
 
-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
+(Method Decorator) Debounce Class Method
 
 
 
@@ -2827,7 +2903,34 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| time |  | (optional) deafult 500 |   |
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+### dist/typescript/decorators/Throttled.js
+
+
+#### Throttled(time) 
+
+(Method Decorator) Throttled Class Method
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| time |  | (optional) deafult 500 |   |
 
 
 
@@ -3365,12 +3468,12 @@ Excludes and returns a filter data without filters by the given scopes
 
 
 
-### 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.
 
 
 
@@ -3379,7 +3482,7 @@ Gets the Filter Label + Column label
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
+| column |  | The filter column |   |
 
 
 
@@ -3387,17 +3490,17 @@ Gets the Filter Label + Column label
 ##### Returns
 
 
--  a sring label
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### 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
 
 
 
@@ -3406,7 +3509,7 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| filter |  | the UI filter |   |
 
 
 
@@ -3414,7 +3517,7 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  a sring label
 
 
 
@@ -3632,12 +3735,12 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 
 
-### 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.
 
 
 
@@ -3646,8 +3749,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 |   |
 
 
 
@@ -3655,17 +3757,17 @@ 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.
 
 
 
 
-### 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).
 
 
 
@@ -3674,7 +3776,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 |   |
 
 
 
@@ -3682,7 +3785,7 @@ 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
 
 
 
@@ -3742,12 +3845,12 @@ Determines if the filter column and property is a distinct group dates type
 
 
 
-### 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
 
 
 
@@ -3756,7 +3859,7 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| validator |  | The validator |   |
 
 
 
@@ -3764,17 +3867,17 @@ 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
 
 
 
 
-### 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.
 
 
 
@@ -3783,7 +3886,7 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -3791,7 +3894,7 @@ 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.
 
 
 
@@ -4151,34 +4254,6 @@ 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
 
 
@@ -4235,6 +4310,34 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
 
 
 
+### 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/getUIFlatFiltersByParams.js
 
 

package/dist/cjs/filters/helpers/builder/getFilterBuilderGeneralConfig.js

@@ -12,6 +12,7 @@ function getFilterBuilderGeneralConfig(config = {}) {
         apiKey: (0, getAttribute_1.getAttribute)(config, 'api_key') || config.apiKey,
         appid: (0, getAttribute_1.getAttribute)(config, 'app_id') || config.appid,
         domain: config.domain,
+        locale: config.locale,
         qv_token: config.qv_token,
         timezoneControl: (0, getAttribute_1.getAttribute)(config, 'timezone_control') || config.timezoneControl,
         userid: (0, getAttribute_1.getAttribute)(config, 'user_id') || config.userid,

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

@@ -8,3 +8,4 @@ export * from './getUIFlatFiltersByParams';
 export * from './getUIFlatFiltersByScopes';
 export * from './getUIValues';
 export * from './getUpdatedUIFilters';
+export * from './transformFilterValues';

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

@@ -20,3 +20,4 @@ __exportStar(require("./getUIFlatFiltersByParams"), exports);
 __exportStar(require("./getUIFlatFiltersByScopes"), exports);
 __exportStar(require("./getUIValues"), exports);
 __exportStar(require("./getUpdatedUIFilters"), exports);
+__exportStar(require("./transformFilterValues"), exports);

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

@@ -0,0 +1,4 @@
+import { IFSFilter } from "../../interfaces/common/IFSFilter";
+import { IFValue } from "../../interfaces/IFValue";
+import { IFUTransformFilterValuesSettings } from "../../interfaces/ui/IFUTransformFilterValuesSettings";
+export declare function transformFilterValues(filter: IFSFilter, settings: IFUTransformFilterValuesSettings): IFValue[];

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformFilterValues = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+const transformValue_1 = require("../../../qrvey/helpers/transformValue");
+const isRangeValidator_1 = require("../common/isRangeValidator");
+const isRegularValidator_1 = require("../common/isRegularValidator");
+function transformFilterValues(filter, settings) {
+    const transformValueSettings = Object.assign(Object.assign({}, settings), { column: filter.column, property: filter.property });
+    if ((0, isEmpty_1.isEmpty)(filter))
+        return [];
+    if ((0, isRegularValidator_1.isRegularValidator)(filter.validator)) {
+        return filter.values.map((value) => (Object.assign(Object.assign({}, value), { value: (0, transformValue_1.transformValue)(value.value, transformValueSettings) })));
+    }
+    else if ((0, isRangeValidator_1.isRangeValidator)(filter.validator)) {
+        return filter.values.map((value) => (Object.assign(Object.assign({}, value), { min: (0, transformValue_1.transformValue)(value.min, transformValueSettings), max: (0, transformValue_1.transformValue)(value.max, transformValueSettings) })));
+    }
+    else {
+        return filter.values;
+    }
+}
+exports.transformFilterValues = transformFilterValues;

package/dist/cjs/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts

@@ -7,5 +7,6 @@ export interface IFilterBuilderGeneralConfig {
     domain: string;
     qv_token?: string;
     timezoneControl?: string;
+    locale?: string;
     userid: string;
 }

package/dist/cjs/filters/interfaces/panel/IFilterPanelConfig.d.ts

@@ -7,4 +7,5 @@ import { IFUDataStore } from "../ui/IFUDataStore";
 export interface IFilterPanelConfig extends IFUDataStore {
     filterBuilderConfig?: IFilterBuilderConfig;
     i18n?: IResourceI18n;
+    locale?: string;
 }

package/dist/cjs/filters/interfaces/ui/IFUTransformFilterValuesSettings.d.ts

@@ -0,0 +1,6 @@
+import { II18nServiceTranslate } from "../../../globalization/interfaces/II18nServiceTranslate";
+export interface IFUTransformFilterValuesSettings {
+    translate: II18nServiceTranslate;
+    locale: string;
+    suffixTranslateLabel?: string;
+}