@qrvey/utils 1.16.1-8 → 1.17.0-0

package/dist/filters/helpers/getScopesByHierarchy.js

@@ -1,10 +1,4 @@
 import { FILTER_SCOPE } from "../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
- */
 export function getScopesByHierarchy(scopes = [], currentScope = FILTER_SCOPE.GLOBAL) {
     const scopeIndex = scopes.findIndex((s) => s.label === currentScope);
     const chartScopeIndex = scopes.findIndex((s) => s.label === FILTER_SCOPE.CHART);

package/dist/filters/helpers/getTokensFromFilters.d.ts

@@ -1,10 +1,4 @@
 import { IFUData } from "../interfaces/ui/IFUData";
 import { IFTokensFromFiltersSettings } from "../interfaces/IFTokensFromFiltersSettings";
 import { IFFilterTokens } from "../interfaces/IFFilterTokens";
-/**
- * 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
- */
 export declare function getTokensFromFilters(filters: IFUData, options: IFTokensFromFiltersSettings): IFFilterTokens[];

package/dist/filters/helpers/getTokensFromFilters.js

@@ -4,14 +4,7 @@ import { FILTER_TOKENS_STRUCTURE_TYPE } from "../constants/common/FILTER_TOKENS_
 import { isEmpty } from "../../general/mix/isEmpty";
 import { FILTER_SCOPE } from "../constants";
 import { transformFilterValues } from "./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
- */
 export function getTokensFromFilters(filters, options) {
-    var _a, _b, _c, _d;
     const tokens = [];
     const i18nService = options.i18nService;
     const settings = {
@@ -19,13 +12,12 @@ export 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
                 : "";
         }
@@ -54,8 +46,8 @@ export 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.LOGICAL_OPERATOR) {
                         tokens.pop();
                     }
@@ -69,7 +61,7 @@ export 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.LOGICAL_OPERATOR) {
                             tokens.pop();
                         }
@@ -81,8 +73,8 @@ export 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}:`,

package/dist/filters/helpers/getVerboseFilter.d.ts

@@ -1,9 +1,3 @@
 import { IFUData } from "../interfaces/ui/IFUData";
 import { IFTokensFromFiltersSettings } from "../interfaces/IFTokensFromFiltersSettings";
-/**
- * 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
- */
 export declare function getVerboseFilter(filters: IFUData, options: IFTokensFromFiltersSettings): string;

package/dist/filters/helpers/getVerboseFilter.js

@@ -1,11 +1,5 @@
 import { getTokensFromFilters } from "./getTokensFromFilters";
 import { filtersTokensToString } from "./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
- */
 export function getVerboseFilter(filters, options) {
     const tokensFromFilters = getTokensFromFilters(filters, options);
     return filtersTokensToString(tokensFromFilters);

package/dist/filters/helpers/settings/areMultipleScopesByProperties.d.ts

@@ -1,9 +1,2 @@
 import { IFSettings } from "../../interfaces/settings/IFSettings";
-/**
- * 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
- */
 export declare function areMultipleScopesByProperties(settings: IFSettings, scopeProperties: string[], condition?: "AND" | "OR"): boolean;

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

@@ -1,13 +1,6 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { _get } from "../../../general/object/get";
 import { getScopesSettings } from "./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
- */
 export function areMultipleScopesByProperties(settings, scopeProperties, condition = "AND") {
     if (isEmpty(settings) || isEmpty(settings.scopes))
         return false;

package/dist/filters/helpers/settings/areMultipleScopesByProperty.d.ts

@@ -1,8 +1,2 @@
 import { IFSettings } from "../../interfaces/settings/IFSettings";
-/**
- * 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
- */
 export declare function areMultipleScopesByProperty(settings: IFSettings, property: string): boolean;

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

@@ -1,12 +1,6 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { _get } from "../../../general/object/get";
 import { getScopesSettings } from "./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
- */
 export function areMultipleScopesByProperty(settings, property) {
     if (isEmpty(settings) || isEmpty(settings.scopes))
         return false;

package/dist/filters/helpers/settings/getFilterSettings.d.ts

@@ -1,13 +1,3 @@
 import { IFScope } from "../../interfaces/IFScope";
 import { IFSettings } from "../../interfaces/settings/IFSettings";
-/**
- * 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
- */
 export declare function getFilterSettings(filterSettings: IFSettings, allowedScopes?: IFScope[], otherSettings?: IFSettings): IFSettings;

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

@@ -4,16 +4,6 @@ import { mergeDeep } from "../../../general/object/mergeDeep";
 import { FILTER_SCOPE } from "../../constants/common/FILTER_SCOPE";
 import { FILTER_SETTINGS_DEFAULT } from "../../constants/settings/FILTER_SETTINGS_DEFAULT";
 import { getScopesToDisplay } from "./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
- */
 export function getFilterSettings(filterSettings, allowedScopes = [], otherSettings) {
     let settings = mergeDeep(FILTER_SETTINGS_DEFAULT, objectCopy(filterSettings));
     const scopesSettings = getScopesToDisplay(settings).filter((scope) => allowedScopes.includes(scope.id));
@@ -29,12 +19,6 @@ export function getFilterSettings(filterSettings, allowedScopes = [], otherSetti
     settings = mergeDeep(settings, otherSettings);
     return settings;
 }
-/**
- * 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 = getScopesToDisplay(settings).filter((scope) => allowedScopes.includes(scope.id));
     let newSettings = settings;
@@ -59,12 +43,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 = getScopesToDisplay(settings).filter((scope) => allowedScopes.includes(scope.id));
     let newSettings = getFilterSettingsByGeneralOnlyScope(settings);
@@ -82,11 +60,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: {
@@ -142,12 +115,6 @@ function getFilterSettingsByNoScopes(settings) {
     };
     return 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: {
@@ -170,11 +137,6 @@ function getFilterSettingsByGeneralOnlyScope(settings) {
     };
     return 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: {
@@ -184,11 +146,6 @@ function getFilterSettingsByNoDefaultScope(settings) {
     };
     return 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: {
@@ -234,11 +191,6 @@ function getFilterSettingsByOnlyDefaultScope(settings) {
     };
     return 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: {
@@ -255,20 +207,10 @@ function getFilterSettingsByDefaultWithOneAdditionalScope(settings) {
     };
     return 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 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: {
@@ -283,12 +225,6 @@ function getFilterSettingsByOnlyDataScope(settings) {
     };
     return 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: {
@@ -308,11 +244,6 @@ function getFilterSettingsBySkippingGeneralScopes(settings) {
     };
     return 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: {
@@ -321,11 +252,6 @@ function getFilterSettingsByMultipleNoPanelGlobalScopes(settings) {
     };
     return 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/filters/helpers/settings/getScopeColorSetting.d.ts

@@ -1,9 +1,3 @@
 import { IFScope } from "../../interfaces/IFScope";
 import { IFSettings } from "../../interfaces/settings/IFSettings";
-/**
- * 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.
- */
 export declare function getScopeColorSetting(settings: IFSettings, scope: IFScope): string;

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

@@ -1,11 +1,5 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { getScopeSettings } from "./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.
- */
 export function getScopeColorSetting(settings, scope) {
     const defaultColor = "#C0C0C0";
     const scopeSetting = getScopeSettings(settings, scope);

package/dist/filters/helpers/settings/getScopeSettings.d.ts

@@ -1,10 +1,4 @@
 import { IFScope } from "../../interfaces/IFScope";
 import { IFSettings } from "../../interfaces/settings/IFSettings";
 import { IFSettingsScope } from "../../interfaces/settings/IFSettingsScope";
-/**
- * Gets the scope settings by the scope type
- * @param {IFSettings} settings the filter settings
- * @param {IFScope} scope the scope type
- * @returns the scope settings
- */
 export declare function getScopeSettings(settings: IFSettings, scope: IFScope): IFSettingsScope;

package/dist/filters/helpers/settings/getScopeSettings.js

@@ -1,11 +1,5 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { getScopesSettings } from "./getScopesSettings";
-/**
- * Gets the scope settings by the scope type
- * @param {IFSettings} settings the filter settings
- * @param {IFScope} scope the scope type
- * @returns the scope settings
- */
 export function getScopeSettings(settings, scope) {
     if (isEmpty(settings) || isEmpty(settings.scopes))
         return;

package/dist/filters/helpers/settings/getScopesSettings.d.ts

@@ -1,8 +1,3 @@
 import { IFSettingsScope } from "../../interfaces/settings/IFSettingsScope";
 import { IFSettingsScopes } from "../../interfaces/settings/IFSettingsScopes";
-/**
- * Gets the scopes settings as array
- * @param {IFSettingsScopes} scopes the scopes settings
- * @returns an array of the scopes settings
- */
 export declare function getScopesSettings(scopes: IFSettingsScopes): IFSettingsScope[];

package/dist/filters/helpers/settings/getScopesSettings.js

@@ -1,11 +1,9 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
-/**
- * Gets the scopes settings as array
- * @param {IFSettingsScopes} scopes the scopes settings
- * @returns an array of the scopes settings
- */
 export function getScopesSettings(scopes) {
     if (isEmpty(scopes))
         return [];
-    return Object.keys(scopes).map((scope) => (Object.assign(Object.assign({}, scopes[scope.toUpperCase()]), { id: scope.toUpperCase() })));
+    return Object.keys(scopes).map((scope) => ({
+        ...scopes[scope.toUpperCase()],
+        id: scope.toUpperCase(),
+    }));
 }

package/dist/filters/helpers/settings/getScopesToDisplay.d.ts

@@ -1,8 +1,3 @@
 import { IFSettings } from "../../interfaces/settings/IFSettings";
 import { IFSettingsScope } from "../../interfaces/settings/IFSettingsScope";
-/**
- * Gets the scope allowed to display
- * @param {IFSettings} settings the filter settings
- * @returns an array of the scopes settings
- */
 export declare function getScopesToDisplay(settings: IFSettings): IFSettingsScope[];

package/dist/filters/helpers/settings/getScopesToDisplay.js

@@ -1,10 +1,5 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { getScopesSettings } from "./getScopesSettings";
-/**
- * Gets the scope allowed to display
- * @param {IFSettings} settings the filter settings
- * @returns an array of the scopes settings
- */
 export function getScopesToDisplay(settings) {
     if (isEmpty(settings) || isEmpty(settings.scopes))
         return [];

package/dist/filters/helpers/settings/isLeastSingleScopeByProperties.d.ts

@@ -1,9 +1,2 @@
 import { IFSettings } from "../../interfaces/settings/IFSettings";
-/**
- * Validates if the scope settings is satisfied by properties at least in one scope
- * @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 if there is one scope to be satisfied; false: none scopes to be satisfied
- */
 export declare function isLeastSingleScopeByProperties(settings: IFSettings, scopeProperties: string[], condition?: "AND" | "OR"): boolean;

package/dist/filters/helpers/settings/isLeastSingleScopeByProperties.js

@@ -1,13 +1,6 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { _get } from "../../../general/object/get";
 import { getScopesSettings } from "./getScopesSettings";
-/**
- * Validates if the scope settings is satisfied by properties at least in one scope
- * @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 if there is one scope to be satisfied; false: none scopes to be satisfied
- */
 export function isLeastSingleScopeByProperties(settings, scopeProperties, condition = "AND") {
     if (isEmpty(settings) || isEmpty(settings.scopes))
         return false;

package/dist/filters/helpers/settings/isLeastSingleScopeByProperty.d.ts

@@ -1,8 +1,2 @@
 import { IFSettings } from "../../interfaces/settings/IFSettings";
-/**
- * Validates if the scope settings is satisfied by a property at least in one scope
- * @param {IFSettings} settings the filter setting
- * @param {string} property the property or the string path of the scope settings
- * @returns true if there is one scope to be satisfied; false: none scopes to be satisfied
- */
 export declare function isLeastSingleScopeByProperty(settings: IFSettings, property: string): boolean;

package/dist/filters/helpers/settings/isLeastSingleScopeByProperty.js

@@ -1,12 +1,6 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { _get } from "../../../general/object/get";
 import { getScopesSettings } from "./getScopesSettings";
-/**
- * Validates if the scope settings is satisfied by a property at least in one scope
- * @param {IFSettings} settings the filter setting
- * @param {string} property the property or the string path of the scope settings
- * @returns true if there is one scope to be satisfied; false: none scopes to be satisfied
- */
 export function isLeastSingleScopeByProperty(settings, property) {
     if (isEmpty(settings) || isEmpty(settings.scopes))
         return false;

package/dist/filters/helpers/ui/excludeUIFiltersByAggregate.d.ts

@@ -1,7 +1,2 @@
 import { IFUFilter } from "../../interfaces/ui/IFUFilter";
-/**
- * Excludes Aggregate Filters in the Flattened UI Filters array
- * @param uFilters Collection of Flat UI Filters
- * @returns a new Flat UI Filters that were excluded the aggregate filters
- */
 export declare function excludeUIFiltersByAggregate(uFilters?: IFUFilter[]): IFUFilter[];

package/dist/filters/helpers/ui/excludeUIFiltersByAggregate.js

@@ -1,9 +1,4 @@
 import { objectCopy } from "../../../general/object/objectCopy";
-/**
- * Excludes Aggregate Filters in the Flattened UI Filters array
- * @param uFilters Collection of Flat UI Filters
- * @returns a new Flat UI Filters that were excluded the aggregate filters
- */
 export function excludeUIFiltersByAggregate(uFilters = []) {
     const _uFilters = objectCopy(uFilters);
     return _uFilters.filter((uFilter) => uFilter.column.aggregate == null);

package/dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.d.ts

@@ -1,9 +1,3 @@
 import { IFScope } from "../../interfaces/IFScope";
 import { IFUFlattenedFilter } from "../../interfaces/ui/IFUFlattenedFilter";
-/**
- * Excludes and returns a UI Flat Filters without filters by the given scopes
- * @param uFilters The Flatten UI Filters
- * @param scopes collection of scopes types
- * @returns The new array of UI Flattened filters
- */
 export declare function excludeUIFlatFiltersByScopes(uFilters?: IFUFlattenedFilter[], scopes?: IFScope[]): IFUFlattenedFilter[];

package/dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js

@@ -1,11 +1,5 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { objectCopy } from "../../../general/object/objectCopy";
-/**
- * Excludes and returns a UI Flat Filters without filters by the given scopes
- * @param uFilters The Flatten UI Filters
- * @param scopes collection of scopes types
- * @returns The new array of UI Flattened filters
- */
 export function excludeUIFlatFiltersByScopes(uFilters = [], scopes = []) {
     if (isEmpty(uFilters))
         return [];

package/dist/filters/helpers/ui/getFilterPropertyLabel.d.ts

@@ -1,9 +1,4 @@
 import { II18nServiceTranslate } from "../../../globalization/interfaces/II18nServiceTranslate";
 import { IFSFilter } from "../../interfaces/common/IFSFilter";
 import { IFUFilter } from "../../interfaces/ui/IFUFilter";
-/**
- * Gets the label of the filter property
- * @param filter The UI Filter
- * @returns a string of the filter property label
- */
 export declare function getFilterPropertyLabel(filter: IFUFilter | IFSFilter, translate?: II18nServiceTranslate): string;

package/dist/filters/helpers/ui/getFilterPropertyLabel.js

@@ -1,9 +1,4 @@
 import { getPropertyLabel } from "../../../qrvey/helpers/getPropertyLabel";
-/**
- * Gets the label of the filter property
- * @param filter The UI Filter
- * @returns a string of the filter property label
- */
 export function getFilterPropertyLabel(filter, translate) {
     return getPropertyLabel(filter.column, filter.property, translate);
 }

package/dist/filters/helpers/ui/getOutputFormatByColumn.d.ts

@@ -1,10 +1,4 @@
 import { IColumn } from "../../../columns/interfaces/IColumn";
 import { IColumnOutputFormatSettings } from "../../../columns/interfaces/IColumnOutputFormatSettings";
 import { IDataset } from "../../../qrvey/interfaces/IDataset";
-/**
- * Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
- * @param column The column
- * @param datasets array of datasets
- * @returns The output format object
- */
 export declare function getOutputFormatByColumn(column: IColumn, datasets?: IDataset[]): IColumnOutputFormatSettings;

package/dist/filters/helpers/ui/getOutputFormatByColumn.js

@@ -1,11 +1,5 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { _get } from "../../../general/object/get";
-/**
- * Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
- * @param column The column
- * @param datasets array of datasets
- * @returns The output format object
- */
 export function getOutputFormatByColumn(column, datasets = []) {
     let foundColumn;
     datasets.some((dataset) => {

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

@@ -1,7 +1,2 @@
 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/filters/helpers/ui/getQrveyIdsByUIFilters.js

@@ -1,9 +1,4 @@
 import { isEmpty } from "../../../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
- */
 export function getQrveyIdsByUIFilters(uiFilter) {
     const qrveyids = [];
     if (isEmpty(uiFilter) || isEmpty(uiFilter.scopes))

package/dist/filters/helpers/ui/getUIFlatFilterByParams.d.ts

@@ -1,15 +1,3 @@
 import { IFUFlattenedFilter } from "../../interfaces/ui/IFUFlattenedFilter";
 import { IFUParamsToGetFilter } from "../../interfaces/ui/IFUParamsToGetFilter";
-/**
- * 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
- */
 export declare function getUIFlatFilterByParams(uFilters?: IFUFlattenedFilter[], params?: IFUParamsToGetFilter, getIndex?: boolean): number | IFUFlattenedFilter;

package/dist/filters/helpers/ui/getUIFlatFilterByParams.js

@@ -1,18 +1,6 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { objectCopy } from "../../../general/object/objectCopy";
 import { resolveUIFlatFilterByParams } from "./resolveUIFlatFilterByParams";
-/**
- * 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
- */
 export function getUIFlatFilterByParams(uFilters = [], params = {}, getIndex = false) {
     if (isEmpty(params))
         return;