@qrvey/utils 1.16.1-9 → 1.17.0-1

package/dist/cjs/filters/helpers/common/mergeValues.js

@@ -1,19 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeValues = void 0;
+exports.mergeValues = mergeValues;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const getMergeValuesSettings_1 = require("./getMergeValuesSettings");
 const isInValidator_1 = require("./isInValidator");
 const isNullValidator_1 = require("./isNullValidator");
 const isRangeValidator_1 = require("./isRangeValidator");
 const isRegularValidator_1 = require("./isRegularValidator");
-/**
- * Gets a new value structure array by merging two value structures
- * @param filter1 the target filter structure
- * @param filter2 the filter to be used to merge the values
- * @param settings configuration of the mergeFilter
- * @returns a new value structure array
- */
 function mergeValues(filter1, filter2, settings) {
     if ((0, isEmpty_1.isEmpty)(filter1) && (0, isEmpty_1.isEmpty)(filter2))
         return [];
@@ -28,7 +21,6 @@ function mergeValues(filter1, filter2, settings) {
     else {
         if ((0, isInValidator_1.isInValidator)(filter1.validator)) {
             newValues = filter2Values.reduce((values, value2) => {
-                var _a, _b;
                 const value1Index = filter1Values.findIndex((value1) => value2.anchor === value1.anchor &&
                     value2.cursor === value1.cursor &&
                     value2.includeCurrent === value1.includeCurrent &&
@@ -42,8 +34,8 @@ function mergeValues(filter1, filter2, settings) {
                     values[value1Index] = {
                         anchor: value2.anchor,
                         cursor: value2.cursor,
-                        displayed: (_a = value2.displayed) !== null && _a !== void 0 ? _a : values[value1Index].displayed,
-                        enabled: (_b = value2.enabled) !== null && _b !== void 0 ? _b : values[value1Index].enabled,
+                        displayed: value2.displayed ?? values[value1Index].displayed,
+                        enabled: value2.enabled ?? values[value1Index].enabled,
                         includeCurrent: value2.includeCurrent,
                         isCalendarDate: value2.isCalendarDate,
                         number: value2.number,
@@ -55,15 +47,14 @@ function mergeValues(filter1, filter2, settings) {
         }
         else if ((0, isRangeValidator_1.isRangeValidator)(filter1.validator)) {
             newValues = filter2Values.reduce((values, value2) => {
-                var _a, _b;
                 const value1Index = filter1Values.findIndex((value1) => value2.max === value1.max && value2.min === value1.min);
                 if (value1Index === -1) {
                     values.push(value2);
                 }
                 else {
                     values[value1Index] = {
-                        displayed: (_a = value2.displayed) !== null && _a !== void 0 ? _a : values[value1Index].displayed,
-                        enabled: (_b = value2.enabled) !== null && _b !== void 0 ? _b : values[value1Index].enabled,
+                        displayed: value2.displayed ?? values[value1Index].displayed,
+                        enabled: value2.enabled ?? values[value1Index].enabled,
                         max: value2.max,
                         min: value2.min,
                     };
@@ -74,7 +65,6 @@ function mergeValues(filter1, filter2, settings) {
         else if ((0, isRegularValidator_1.isRegularValidator)(filter1.validator) ||
             (0, isNullValidator_1.isNullValidator)(filter1.validator)) {
             newValues = filter2Values.reduce((values, value2) => {
-                var _a, _b;
                 const value1Index = filter1Values.findIndex((value1) => value2.imageUrl === value1.imageUrl &&
                     value2.value === value1.value);
                 if (value1Index === -1) {
@@ -82,8 +72,8 @@ function mergeValues(filter1, filter2, settings) {
                 }
                 else {
                     values[value1Index] = {
-                        displayed: (_a = value2.displayed) !== null && _a !== void 0 ? _a : values[value1Index].displayed,
-                        enabled: (_b = value2.enabled) !== null && _b !== void 0 ? _b : values[value1Index].enabled,
+                        displayed: value2.displayed ?? values[value1Index].displayed,
+                        enabled: value2.enabled ?? values[value1Index].enabled,
                         imageUrl: value2.imageUrl,
                         value: value2.value,
                         valueid: value2.valueid,
@@ -99,4 +89,3 @@ function mergeValues(filter1, filter2, settings) {
     }
     return newValues;
 }
-exports.mergeValues = mergeValues;

package/dist/cjs/filters/helpers/common/resolveDatasetConditions.js

@@ -1,16 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveDatasetConditions = void 0;
+exports.resolveDatasetConditions = resolveDatasetConditions;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const hasProperty_1 = require("../../../general/object/hasProperty");
-/**
- * Resolves the conditions by given params
- * @param filter The dataset structure
- * @param params given parameters to validate the dataset
- * @param letPassUndefinedProperties Flag to avoid applying the condition when the filter properties are undefined
- * @param letPassUndefinedParams Flag to avoid applying the condition when the param properties are explicit undefined.
- * @returns true: the condition is satisfied
- */
 function resolveDatasetConditions(dataset, params, letPassUndefinedProperties = false, letPassUndefinedParams = true) {
     return ((!(0, hasProperty_1._hasProperty)(params, "enableds") ||
         !(0, hasProperty_1._hasProperty)(params.enableds, "datasets") ||
@@ -28,4 +20,3 @@ function resolveDatasetConditions(dataset, params, letPassUndefinedProperties =
             params.qrveyid === dataset.qrveyid) &&
         dataset.filters.length > 0);
 }
-exports.resolveDatasetConditions = resolveDatasetConditions;

package/dist/cjs/filters/helpers/common/resolveFilterConditions.js

@@ -1,18 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveFilterConditions = void 0;
+exports.resolveFilterConditions = resolveFilterConditions;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const hasProperty_1 = require("../../../general/object/hasProperty");
-/**
- * Resolves the conditions by given params
- * @param filter The filter
- * @param params given parameters to validate the filter
- * @param letPassUndefinedProperties Flag to avoid applying the condition when the filter properties are undefined
- * @param letPassUndefinedParams Flag to avoid applying the condition when the param properties are explicit undefined.
- * @returns true: the condition is satisfied
- */
 function resolveFilterConditions(filter, params, letPassUndefinedProperties = false, letPassUndefinedParams = true) {
-    var _a, _b, _c, _d, _e, _f;
     return ((!(0, hasProperty_1._hasProperty)(params, "enableds") ||
         !(0, hasProperty_1._hasProperty)(params.enableds, "filters") ||
         (letPassUndefinedProperties && filter.enabled == null) ||
@@ -42,11 +33,10 @@ function resolveFilterConditions(filter, params, letPassUndefinedProperties = fa
         (!(0, hasProperty_1._hasProperty)(params, "column") ||
             (letPassUndefinedProperties && filter.column == null) ||
             (letPassUndefinedParams && (0, isEmpty_1.isEmpty)(params.column)) ||
-            (((letPassUndefinedParams && (0, isEmpty_1.isEmpty)((_a = params.column) === null || _a === void 0 ? void 0 : _a.id)) ||
-                ((_b = params.column) === null || _b === void 0 ? void 0 : _b.id) === filter.column.id) &&
-                ((letPassUndefinedParams && (0, isEmpty_1.isEmpty)((_c = params.column) === null || _c === void 0 ? void 0 : _c.qrveyid)) ||
-                    ((_d = params.column) === null || _d === void 0 ? void 0 : _d.qrveyid) === filter.column.qrveyid) &&
-                ((letPassUndefinedParams && (0, isEmpty_1.isEmpty)((_e = params.column) === null || _e === void 0 ? void 0 : _e.aggregate)) ||
-                    ((_f = params.column) === null || _f === void 0 ? void 0 : _f.aggregate) === filter.column.aggregate))));
+            (((letPassUndefinedParams && (0, isEmpty_1.isEmpty)(params.column?.id)) ||
+                params.column?.id === filter.column.id) &&
+                ((letPassUndefinedParams && (0, isEmpty_1.isEmpty)(params.column?.qrveyid)) ||
+                    params.column?.qrveyid === filter.column.qrveyid) &&
+                ((letPassUndefinedParams && (0, isEmpty_1.isEmpty)(params.column?.aggregate)) ||
+                    params.column?.aggregate === filter.column.aggregate))));
 }
-exports.resolveFilterConditions = resolveFilterConditions;

package/dist/cjs/filters/helpers/common/resolveScopeConditions.js

@@ -1,16 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveScopeConditions = void 0;
+exports.resolveScopeConditions = resolveScopeConditions;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const hasProperty_1 = require("../../../general/object/hasProperty");
-/**
- * Resolves the conditions by given params
- * @param filter The filter scope structure
- * @param params given parameters to validate the filter
- * @param letPassUndefinedProperties Flag to avoid applying the condition when the properties of the properties are undefined
- * @param letPassUndefinedParams Flag to avoid applying the condition when the properties of the params are explicit undefined.
- * @returns true: the condition is satisfied
- */
 function resolveScopeConditions(scope, params, letPassUndefinedProperties = false, letPassUndefinedParams = true) {
     return ((!(0, hasProperty_1._hasProperty)(params, "enableds") ||
         !(0, hasProperty_1._hasProperty)(params.enableds, "scopes") ||
@@ -32,4 +24,3 @@ function resolveScopeConditions(scope, params, letPassUndefinedProperties = fals
             scope.scopeid === params.scopeid) &&
         scope.datasets.length > 0);
 }
-exports.resolveScopeConditions = resolveScopeConditions;

package/dist/cjs/filters/helpers/filtersTokensToString.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filtersTokensToString = void 0;
+exports.filtersTokensToString = filtersTokensToString;
 const FILTER_TOKENS_STRUCTURE_TYPE_1 = require("../constants/common/FILTER_TOKENS_STRUCTURE_TYPE");
-/**
- * It takes an array of tokens and returns a string
- * @param {IFFilterTokens[]} tokens - IFFilterTokens[] - the tokens to convert to a string
- * @returns A string
- */
 function filtersTokensToString(tokens) {
     let str = "";
     for (const token of tokens) {
@@ -20,4 +15,3 @@ function filtersTokensToString(tokens) {
     }
     return str.trim();
 }
-exports.filtersTokensToString = filtersTokensToString;

package/dist/cjs/filters/helpers/getAggFiltersFromFilterData.js

@@ -1,18 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAggFiltersFromFilterData = void 0;
+exports.getAggFiltersFromFilterData = getAggFiltersFromFilterData;
 const isEmpty_1 = require("../../general/mix/isEmpty");
 const getFiltersByAggregateColumn_1 = require("./common/getFiltersByAggregateColumn");
-/**
- * @todo FIX AGGREGATE FILTERS
- * @private
- * @param filterData
- * @param _summaries
- * @returns the aggFilters structure
- */
 function getAggFiltersFromFilterData(filterData, _summaries) {
-    const _filterData = Object.assign({}, (0, getFiltersByAggregateColumn_1.getFiltersByAggregateColumn)(filterData));
+    const _filterData = { ...(0, getFiltersByAggregateColumn_1.getFiltersByAggregateColumn)(filterData) };
     if ((0, isEmpty_1.isEmpty)(_filterData))
         return;
 }
-exports.getAggFiltersFromFilterData = getAggFiltersFromFilterData;

package/dist/cjs/filters/helpers/getAvailableScopes.js

@@ -1,14 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAvailableScopes = void 0;
+exports.getAvailableScopes = getAvailableScopes;
 const isEmpty_1 = require("../../general/mix/isEmpty");
 const FILTER_SCOPE_1 = require("../constants/common/FILTER_SCOPE");
-/**
- * Gets Scopes/Scope IDs by given IDs
- * @param config given Differnts IDs in order set a available scope
- * @param includeGlobal flag to add the global scope
- * @returns a Scopes/Scope IDs array
- */
 function getAvailableScopes(config, includeGlobal = true) {
     if ((0, isEmpty_1.isEmpty)(config))
         return;
@@ -44,4 +38,3 @@ function getAvailableScopes(config, includeGlobal = true) {
     }
     return scopes;
 }
-exports.getAvailableScopes = getAvailableScopes;

package/dist/cjs/filters/helpers/getAvailableScopesIDsByConfig.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAvailableScopesIDsByConfig = void 0;
+exports.getAvailableScopesIDsByConfig = getAvailableScopesIDsByConfig;
 const getAttribute_1 = require("../../general/object/getAttribute");
-/**
- * Gets the Scopes IDS for the Available Scope function by any config
- * @param config any config
- * @returns a Available Scope IDS config
- */
 function getAvailableScopesIDsByConfig(config = {}) {
     return {
         scope: config.scope,
@@ -18,4 +13,3 @@ function getAvailableScopesIDsByConfig(config = {}) {
         panelid: (0, getAttribute_1.getAttribute)(config, "panel_id") || config.panelid,
     };
 }
-exports.getAvailableScopesIDsByConfig = getAvailableScopesIDsByConfig;

package/dist/cjs/filters/helpers/getScopesByHierarchy.js

@@ -1,13 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScopesByHierarchy = void 0;
+exports.getScopesByHierarchy = getScopesByHierarchy;
 const FILTER_SCOPE_1 = require("../constants/common/FILTER_SCOPE");
-/**
- * [TODO: Make a description for this]
- * @param scopes the collection of Scopes/Scope IDs
- * @param currentScope Current scope type
- * @returns A new array of Scopes/Scope IDs
- */
 function getScopesByHierarchy(scopes = [], currentScope = FILTER_SCOPE_1.FILTER_SCOPE.GLOBAL) {
     const scopeIndex = scopes.findIndex((s) => s.label === currentScope);
     const chartScopeIndex = scopes.findIndex((s) => s.label === FILTER_SCOPE_1.FILTER_SCOPE.CHART);
@@ -19,4 +13,3 @@ function getScopesByHierarchy(scopes = [], currentScope = FILTER_SCOPE_1.FILTER_
     }
     return [];
 }
-exports.getScopesByHierarchy = getScopesByHierarchy;

package/dist/cjs/filters/helpers/getTokensFromFilters.js

@@ -1,20 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTokensFromFilters = void 0;
+exports.getTokensFromFilters = getTokensFromFilters;
 const getUIValues_1 = require("./ui/getUIValues");
 const getFilterPropertyLabel_1 = require("./ui/getFilterPropertyLabel");
 const FILTER_TOKENS_STRUCTURE_TYPE_1 = require("../constants/common/FILTER_TOKENS_STRUCTURE_TYPE");
 const isEmpty_1 = require("../../general/mix/isEmpty");
 const constants_1 = require("../constants");
 const transformFilterValues_1 = require("./ui/transformFilterValues");
-/**
- * It takes a filter object and returns an array of tokens that represent the filter
- * @param {IFUData} filters - The filters object.
- * @param {IFTokensFromFiltersSettings} options - IFTokensFromFiltersSettings
- * @returns {IFFilterTokens[]} An array of tokens that represents the filters object
- */
 function getTokensFromFilters(filters, options) {
-    var _a, _b, _c, _d;
     const tokens = [];
     const i18nService = options.i18nService;
     const settings = {
@@ -22,13 +15,12 @@ function getTokensFromFilters(filters, options) {
         addEnableds: true,
     };
     const settingsTransform = {
-        i18n: options === null || options === void 0 ? void 0 : options.i18n,
+        i18n: options?.i18n,
         translate: i18nService.translate.bind(i18nService),
     };
     const getValue = (valueItem) => {
-        var _a, _b;
         if (valueItem.value) {
-            return ((_a = valueItem.displayed) !== null && _a !== void 0 ? _a : true) && ((_b = valueItem.enabled) !== null && _b !== void 0 ? _b : true)
+            return (valueItem.displayed ?? true) && (valueItem.enabled ?? true)
                 ? valueItem.value
                 : "";
         }
@@ -57,8 +49,8 @@ function getTokensFromFilters(filters, options) {
                 });
             }
             for (const [index, filter] of Object.entries(database.filters)) {
-                if (!(filter === null || filter === void 0 ? void 0 : filter.enabled)) {
-                    if (((_a = tokens[tokens.length - 1]) === null || _a === void 0 ? void 0 : _a.type) ===
+                if (!filter?.enabled) {
+                    if (tokens[tokens.length - 1]?.type ===
                         FILTER_TOKENS_STRUCTURE_TYPE_1.FILTER_TOKENS_STRUCTURE_TYPE.LOGICAL_OPERATOR) {
                         tokens.pop();
                     }
@@ -72,7 +64,7 @@ function getTokensFromFilters(filters, options) {
                     const searchToken = tokens.find((token) => token.token === `${filter.extras.filterLabel}:` &&
                         token.id === filter.extras.panelid);
                     if (!searchToken) {
-                        if (((_b = tokens[tokens.length - 1]) === null || _b === void 0 ? void 0 : _b.type) ===
+                        if (tokens[tokens.length - 1]?.type ===
                             FILTER_TOKENS_STRUCTURE_TYPE_1.FILTER_TOKENS_STRUCTURE_TYPE.LOGICAL_OPERATOR) {
                             tokens.pop();
                         }
@@ -84,8 +76,8 @@ function getTokensFromFilters(filters, options) {
                     }
                 }
                 let columnLabel = filter.column.label;
-                if ((_c = filter === null || filter === void 0 ? void 0 : filter.column) === null || _c === void 0 ? void 0 : _c.aggregate) {
-                    columnLabel += ` (${i18nService.translate(`common.aggregate_labels.${(_d = filter === null || filter === void 0 ? void 0 : filter.column) === null || _d === void 0 ? void 0 : _d.aggregate.toLowerCase()}`)})`;
+                if (filter?.column?.aggregate) {
+                    columnLabel += ` (${i18nService.translate(`common.aggregate_labels.${filter?.column?.aggregate.toLowerCase()}`)})`;
                 }
                 tokens.push({
                     token: `${columnLabel}:`,
@@ -135,4 +127,3 @@ function getTokensFromFilters(filters, options) {
     }
     return tokens;
 }
-exports.getTokensFromFilters = getTokensFromFilters;

package/dist/cjs/filters/helpers/getVerboseFilter.js

@@ -1,16 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVerboseFilter = void 0;
+exports.getVerboseFilter = getVerboseFilter;
 const getTokensFromFilters_1 = require("./getTokensFromFilters");
 const filtersTokensToString_1 = require("./filtersTokensToString");
-/**
- * It takes a set of filters and returns a string that describes the filters
- * @param {IFUData} filters - The filters object that you want to convert to a string.
- * @param {IFTokensFromFiltersSettings} options - IFTokensFromFiltersSettings
- * @returns A string
- */
 function getVerboseFilter(filters, options) {
     const tokensFromFilters = (0, getTokensFromFilters_1.getTokensFromFilters)(filters, options);
     return (0, filtersTokensToString_1.filtersTokensToString)(tokensFromFilters);
 }
-exports.getVerboseFilter = getVerboseFilter;

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

@@ -1,29 +1,16 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./backend/index"), exports);
-__exportStar(require("./builder/index"), exports);
-__exportStar(require("./common/index"), exports);
-__exportStar(require("./settings/index"), exports);
-__exportStar(require("./ui/index"), exports);
-__exportStar(require("./applyHierarchyForAggFilters"), exports);
-__exportStar(require("./getAvailableScopes"), exports);
-__exportStar(require("./getAvailableScopesIDsByConfig"), exports);
-__exportStar(require("./getScopesByHierarchy"), exports);
-__exportStar(require("./getTokensFromFilters"), exports);
-__exportStar(require("./filtersTokensToString"), exports);
-__exportStar(require("./getVerboseFilter"), exports);
-__exportStar(require("./OLD_getAggFilters"), exports);
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./backend/index"), exports);
+tslib_1.__exportStar(require("./builder/index"), exports);
+tslib_1.__exportStar(require("./common/index"), exports);
+tslib_1.__exportStar(require("./settings/index"), exports);
+tslib_1.__exportStar(require("./ui/index"), exports);
+tslib_1.__exportStar(require("./applyHierarchyForAggFilters"), exports);
+tslib_1.__exportStar(require("./getAvailableScopes"), exports);
+tslib_1.__exportStar(require("./getAvailableScopesIDsByConfig"), exports);
+tslib_1.__exportStar(require("./getScopesByHierarchy"), exports);
+tslib_1.__exportStar(require("./getTokensFromFilters"), exports);
+tslib_1.__exportStar(require("./filtersTokensToString"), exports);
+tslib_1.__exportStar(require("./getVerboseFilter"), exports);
+tslib_1.__exportStar(require("./OLD_getAggFilters"), exports);

package/dist/cjs/filters/helpers/settings/areMultipleScopesByProperties.js

@@ -1,16 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.areMultipleScopesByProperties = void 0;
+exports.areMultipleScopesByProperties = areMultipleScopesByProperties;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const get_1 = require("../../../general/object/get");
 const getScopesSettings_1 = require("./getScopesSettings");
-/**
- * Validates if the scope settings is satisfied by properties in multiple scopes
- * @param {IFSettings} settings the filter setting
- * @param {string} scopeProperties the property or the string path of the scope settings
- * @param {string} condition validate with AND or OR condition
- * @returns true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
- */
 function areMultipleScopesByProperties(settings, scopeProperties, condition = "AND") {
     if ((0, isEmpty_1.isEmpty)(settings) || (0, isEmpty_1.isEmpty)(settings.scopes))
         return false;
@@ -21,4 +14,3 @@ function areMultipleScopesByProperties(settings, scopeProperties, condition = "A
             ? scopeProperties.every(conditionFunction(scope))
             : scopeProperties.some(conditionFunction(scope))).length > 0);
 }
-exports.areMultipleScopesByProperties = areMultipleScopesByProperties;

package/dist/cjs/filters/helpers/settings/areMultipleScopesByProperty.js

@@ -1,15 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.areMultipleScopesByProperty = void 0;
+exports.areMultipleScopesByProperty = areMultipleScopesByProperty;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const get_1 = require("../../../general/object/get");
 const getScopesSettings_1 = require("./getScopesSettings");
-/**
- * Validates if the scope settings is satisfied the property in multiple scopes
- * @param {IFSettings} settings the filter setting
- * @param {string} property the property or the string path of the scope settings
- * @returns true if there are scopes to be satisfied; false: one or none scopes to be satisfied
- */
 function areMultipleScopesByProperty(settings, property) {
     if ((0, isEmpty_1.isEmpty)(settings) || (0, isEmpty_1.isEmpty)(settings.scopes))
         return false;
@@ -17,4 +11,3 @@ function areMultipleScopesByProperty(settings, property) {
     return (scopes.length > 1 &&
         (0, getScopesSettings_1.getScopesSettings)(settings.scopes).filter((scope) => (0, get_1._get)(scope, property, false)).length > 1);
 }
-exports.areMultipleScopesByProperty = areMultipleScopesByProperty;

package/dist/cjs/filters/helpers/settings/getFilterSettings.js

@@ -1,22 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilterSettings = void 0;
+exports.getFilterSettings = getFilterSettings;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const objectCopy_1 = require("../../../general/object/objectCopy");
 const mergeDeep_1 = require("../../../general/object/mergeDeep");
 const FILTER_SCOPE_1 = require("../../constants/common/FILTER_SCOPE");
 const FILTER_SETTINGS_DEFAULT_1 = require("../../constants/settings/FILTER_SETTINGS_DEFAULT");
 const getScopesToDisplay_1 = require("./getScopesToDisplay");
-/**
- * Gets a new filter settings object according to various conditions
- * - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
- * - If there is not filter settings provived, a default one is returned
- * - The returned filter settings depend on the coexisting scopes
- * @param {IFSettings} filterSettings the given filter settings
- * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
- * @param {IFSettings} otherSettings another filter settings object to be merged with the filterSettings param
- * @returns a new filter settings object
- */
 function getFilterSettings(filterSettings, allowedScopes = [], otherSettings) {
     let settings = (0, mergeDeep_1.mergeDeep)(FILTER_SETTINGS_DEFAULT_1.FILTER_SETTINGS_DEFAULT, (0, objectCopy_1.objectCopy)(filterSettings));
     const scopesSettings = (0, getScopesToDisplay_1.getScopesToDisplay)(settings).filter((scope) => allowedScopes.includes(scope.id));
@@ -32,13 +22,6 @@ function getFilterSettings(filterSettings, allowedScopes = [], otherSettings) {
     settings = (0, mergeDeep_1.mergeDeep)(settings, otherSettings);
     return settings;
 }
-exports.getFilterSettings = getFilterSettings;
-/**
- * Gets the filter settings by multiple scopes conditions
- * @param {IFSettings} settings the given filter settings
- * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
- * @returns a new filter settings object
- */
 function getFilterSettingsByMultipleScopes(settings, allowedScopes) {
     const scopesSettings = (0, getScopesToDisplay_1.getScopesToDisplay)(settings).filter((scope) => allowedScopes.includes(scope.id));
     let newSettings = settings;
@@ -63,12 +46,6 @@ function getFilterSettingsByMultipleScopes(settings, allowedScopes) {
     }
     return newSettings;
 }
-/**
- * Gets the filter settings when a single scope is permitted
- * @param {IFSettings} settings the given filter settings
- * @param {IFScope[]} allowedScopes a collection of scope types that are permitted
- * @returns a new filter settings object
- */
 function getFilterSettingsByOnlyScope(settings, allowedScopes) {
     const scopesSettings = (0, getScopesToDisplay_1.getScopesToDisplay)(settings).filter((scope) => allowedScopes.includes(scope.id));
     let newSettings = getFilterSettingsByGeneralOnlyScope(settings);
@@ -86,11 +63,6 @@ function getFilterSettingsByOnlyScope(settings, allowedScopes) {
     }
     return newSettings;
 }
-/**
- * Gets the filter settings when there is not scope to accept
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByNoScopes(settings) {
     const newSettings = {
         chartBuilder: {
@@ -146,12 +118,6 @@ function getFilterSettingsByNoScopes(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when a general scope are only permitted
- * The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByGeneralOnlyScope(settings) {
     const newSettings = {
         filterBuilder: {
@@ -174,11 +140,6 @@ function getFilterSettingsByGeneralOnlyScope(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there is not a default scope type
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByNoDefaultScope(settings) {
     const newSettings = {
         chartBuilder: {
@@ -188,11 +149,6 @@ function getFilterSettingsByNoDefaultScope(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there is only a default scope type
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByOnlyDefaultScope(settings) {
     const newSettings = {
         filterDisplayer: {
@@ -238,11 +194,6 @@ function getFilterSettingsByOnlyDefaultScope(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there are a default scope and other single scope
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByDefaultWithOneAdditionalScope(settings) {
     const newSettings = {
         filterPanel: {
@@ -259,20 +210,10 @@ function getFilterSettingsByDefaultWithOneAdditionalScope(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there is only the panel scope
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByOnlyPanelScope(settings) {
     const newSettings = getFilterSettingsByNoDefaultScope(settings);
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there is only the data scope
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByOnlyDataScope(settings) {
     const newSettings = {
         filterDisplayer: {
@@ -287,12 +228,6 @@ function getFilterSettingsByOnlyDataScope(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there are not general scopes allowed
- * The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsBySkippingGeneralScopes(settings) {
     const newSettings = {
         panel: {
@@ -312,11 +247,6 @@ function getFilterSettingsBySkippingGeneralScopes(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there are no panel scopes and multiple scopes allowed.
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByMultipleNoPanelGlobalScopes(settings) {
     const newSettings = {
         panel: {
@@ -325,11 +255,6 @@ function getFilterSettingsByMultipleNoPanelGlobalScopes(settings) {
     };
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
-/**
- * Gets the filter settings when there are no panel scopes and multiple scopes allowed.
- * @param {IFSettings} settings the given filter settings
- * @returns a new filter settings object
- */
 function getFilterSettingsByMultipleNoPanelScopes(settings) {
     const newSettings = {
         filterDisplayer: {

package/dist/cjs/filters/helpers/settings/getScopeColorSetting.js

@@ -1,14 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScopeColorSetting = void 0;
+exports.getScopeColorSetting = getScopeColorSetting;
 const isEmpty_1 = require("../../../general/mix/isEmpty");
 const getScopeSettings_1 = require("./getScopeSettings");
-/**
- * Gets the color of the scope in the settings object
- * @param {IFSettings} settings the filter settings
- * @param {IFScope} scope the scope type
- * @returns an string with the color.
- */
 function getScopeColorSetting(settings, scope) {
     const defaultColor = "#C0C0C0";
     const scopeSetting = (0, getScopeSettings_1.getScopeSettings)(settings, scope);
@@ -18,4 +12,3 @@ function getScopeColorSetting(settings, scope) {
         ? scopeSetting.color
         : defaultColor;
 }
-exports.getScopeColorSetting = getScopeColorSetting;