@qrvey/filters 0.0.45 → 0.1.0

package/dist/classes/FilterResources.d.ts

@@ -1,139 +1,25 @@
 import { IColumnVsFormulaType, IDTimezone } from "@qrvey/utils";
 import { IFilterGroupingInfoByColumnTypeSettings, IFilterGroupingInfoByFilterSettings, IFilterGroupingInfoListByColumnSettings } from "../resources/filter-functions.resources";
 import { IFilterGrouping, IFilterGroupingInfo } from "../resources/filter-grouping.resources";
+import { IFilterScope } from "../resources/filter-scopes.resources";
 import { IFilterValidator, IFilterValidatorInfo } from "../resources/filter-validators.resources";
 import { IFilter } from "../resources/filters.resources";
-import { IFilterScope } from "../resources/filter-scopes.resources";
-/**
- * Class to search, build and get resources for the filters.
- */
 export declare class FilterResources {
-    /**
-     * **************************************************************************************************
-     **************************************** Grouping **************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets a grouping info by a grouping type
-     * @param grouping the grouping type
-     * @returns a single grouping info
-     */
     static getGroupingInfo(grouping: IFilterGrouping): IFilterGroupingInfo;
-    /**
-     * Gets a collection of groupings info by a column type
-     * @param type the object with column and formula type
-     * @param settings settings for the function
-     * @returns a collection of grouping info
-     */
     static getGroupingInfoListByColumnType(type: IColumnVsFormulaType, settings?: IFilterGroupingInfoListByColumnSettings): IFilterGroupingInfo[];
-    /**
-     * Gets a grouping info by a column type and grouping
-     * @param type the object with column and formula type
-     * @param grouping the grouping type
-     * @param settings settings for the function
-     * @returns the grouping info
-     */
     static getGroupingInfoByColumnType(type: IColumnVsFormulaType, grouping?: IFilterGrouping, settings?: IFilterGroupingInfoByColumnTypeSettings): IFilterGroupingInfo | undefined;
-    /**
-     * Gets a grouping info by a filter
-     * @param filter the filter object
-     * @returns the grouping info
-     */
     static getGroupingInfoByFilter(filter: IFilter, settings?: IFilterGroupingInfoByFilterSettings): IFilterGroupingInfo | undefined;
-    /**
-     * Gets a collection of groupings info by a column type
-     * - The resulting grouping info collection is an intersection of mulitple grouping info collections
-     * @param types the collection of objects with column and formula types
-     * @param settings settings for the function
-     * @returns a collection of grouping info
-     */
     static getGroupingInfoListByColumnTypes(types: IColumnVsFormulaType[], settings?: IFilterGroupingInfoListByColumnSettings[]): IFilterGroupingInfo[];
-    /**
-     * Gets the grouping info of Date column type
-     * @param groupinInfoList the original grouping info list
-     * @param settings settings for the function
-     * @returns the new grouping info list
-     */
     static getGroupingInfoListOnDates(groupinInfoList: IFilterGroupingInfo[], settings: IFilterGroupingInfoListByColumnSettings): IFilterGroupingInfo[];
-    /**
-     * Gets the grouping info of Expression column type
-     * @param groupinInfoList the original grouping info list
-     * @param settings settings for the function
-     * @returns the new grouping info list
-     */
     static getGroupingInfoListOnExpressions(groupinInfoList: IFilterGroupingInfo[], settings: IFilterGroupingInfoListByColumnSettings): IFilterGroupingInfo[];
-    /**
-     * Gets the grouping info of Image Upload column type
-     * @param groupinInfoList the original grouping info list
-     * @param settings settings for the function
-     * @returns the new grouping info list
-     */
     static getGroupingInfoListOnImageUploads(groupinInfoList: IFilterGroupingInfo[], settings: IFilterGroupingInfoListByColumnSettings): IFilterGroupingInfo[];
-    /**
-     * Gets the complete collection of grouping types
-     * @returns the collection of grouping types
-     */
     static getGroupings(): IFilterGrouping[];
-    /**
-     * Gets the complete collection of validator info
-     * @returns the collection of validator info
-     */
     static getGroupingsInfoList(): IFilterGroupingInfo[];
-    /**
-     * **************************************************************************************************
-     **************************************** Scopes *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the collection of filter scopes in order of hierarchy
-     * @returns the collection of validator info
-     */
     static getHierarchyScopes(): IFilterScope[];
-    /**
-     * **************************************************************************************************
-     **************************************** Timezone *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the filters transformed by the given timezone
-     * @param filters the filters to transform
-     * @param timezone the timezone info
-     * @returns the transformed filters to a new timezone
-     */
     static getFiltersByTimezone(filters: IFilter[], timezone: IDTimezone): IFilter[];
-    /**
-     * **************************************************************************************************
-     **************************************** Validator *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets a validator info by a validator type
-     * @param validator the validator type
-     * @returns a single validator info
-     */
     static getValidatorInfo(validator: IFilterValidator): IFilterValidatorInfo;
-    /**
-     * Gets the complete collection of validator info
-     * @returns the collection of validator info
-     */
     static getValidatorInfoList(): IFilterValidatorInfo[];
-    /**
-     * Gets a collection of validator info by a column type
-     * @param type the object with column and formula type
-     * @returns a collection of validator info
-     */
     static getValidatorInfoListByColumnType(type: IColumnVsFormulaType): IFilterValidatorInfo[];
-    /**
-     * Gets a collection of validator info by a mutiple column types
-     * - The resulting validator info collection is an intersection of mulitple validator info collections
-     * @param types a collection of objects with column and formula types
-     * @returns a collection of validator info
-     */
     static getValidatorInfoListByColumnTypes(types: IColumnVsFormulaType[]): IFilterValidatorInfo[];
-    /**
-     * Gets the complete collection of validator types
-     * @returns the collection of validator types
-     */
     static getValidators(): IFilterValidator[];
 }
-//# sourceMappingURL=FilterResources.d.ts.map

package/dist/classes/FilterResources.js

@@ -1,34 +1,15 @@
 import { COLUMN, COLUMN_BY_FORMULA, FORMULA, getDateByTimezone, intersectObjectArrays, isEmpty, objectCopy, } from "@qrvey/utils";
-import { getFilterType } from "../helpers/getFilterType";
+import { FilterValidation } from "./FilterValidation";
 import { getInfoGroupingsByColumnTypeSettings } from "../helpers/filter-settings.helpers";
+import { getFilterType } from "../helpers/getFilterType";
 import { FILTER_GROUPING, FILTER_GROUPING_INFO, FILTER_GROUPING_INFO_BY_COLUMN_TYPE, FILTER_GROUPING_INFO_BY_DATE_TIME, FILTER_GROUPING_INFO_BY_DISTINCT_DATE, FILTER_GROUPING_INFO_BY_DISTINCT_DATE_TIME, FILTER_GROUPING_INFO_LIST, FILTER_GROUPINGS, } from "../resources/filter-grouping.resources";
+import { FILTER_SCOPES, } from "../resources/filter-scopes.resources";
 import { FILTER_VALIDATOR_INFO, FILTER_VALIDATOR_INFO_LIST, FILTER_VALIDATORS, FILTER_VALIDATORS_INFO_BY_COLUMN_TYPE, } from "../resources/filter-validators.resources";
 import { FILTER_TYPE } from "../resources/filters.resources";
-import { FILTER_SCOPES, } from "../resources/filter-scopes.resources";
-import { FilterValidation } from "./FilterValidation";
-/**
- * Class to search, build and get resources for the filters.
- */
 export class FilterResources {
-    /**
-     * **************************************************************************************************
-     **************************************** Grouping **************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets a grouping info by a grouping type
-     * @param grouping the grouping type
-     * @returns a single grouping info
-     */
     static getGroupingInfo(grouping) {
         return FILTER_GROUPING_INFO[grouping];
     }
-    /**
-     * Gets a collection of groupings info by a column type
-     * @param type the object with column and formula type
-     * @param settings settings for the function
-     * @returns a collection of grouping info
-     */
     static getGroupingInfoListByColumnType(type, settings) {
         const { type: columnType, formulaType } = type;
         const completeSettings = getInfoGroupingsByColumnTypeSettings(settings);
@@ -47,13 +28,6 @@ export class FilterResources {
             groupinInfoList = this.getGroupingInfoListOnDates(groupinInfoList, completeSettings);
         return groupinInfoList;
     }
-    /**
-     * Gets a grouping info by a column type and grouping
-     * @param type the object with column and formula type
-     * @param grouping the grouping type
-     * @param settings settings for the function
-     * @returns the grouping info
-     */
     static getGroupingInfoByColumnType(type, grouping, settings) {
         if (grouping == null)
             return;
@@ -61,35 +35,17 @@ export class FilterResources {
         const groupingInfo = groupingInfoList.find((gInfo) => gInfo.value === grouping);
         return groupingInfo == null ? groupingInfoList[0] : groupingInfo;
     }
-    /**
-     * Gets a grouping info by a filter
-     * @param filter the filter object
-     * @returns the grouping info
-     */
     static getGroupingInfoByFilter(filter, settings) {
         if (!FilterValidation.isGroupingValid(filter.columnType, filter.validator))
             return;
         return this.getGroupingInfoByColumnType({ type: filter.columnType, formulaType: filter.formulaType }, filter.grouping, settings);
     }
-    /**
-     * Gets a collection of groupings info by a column type
-     * - The resulting grouping info collection is an intersection of mulitple grouping info collections
-     * @param types the collection of objects with column and formula types
-     * @param settings settings for the function
-     * @returns a collection of grouping info
-     */
     static getGroupingInfoListByColumnTypes(types, settings) {
         if (!Array.isArray(types))
             return [];
         const infoGroupings = types.map((type, index) => FilterResources.getGroupingInfoListByColumnType(type, settings?.[index]));
         return intersectObjectArrays(infoGroupings, "value");
     }
-    /**
-     * Gets the grouping info of Date column type
-     * @param groupinInfoList the original grouping info list
-     * @param settings settings for the function
-     * @returns the new grouping info list
-     */
     static getGroupingInfoListOnDates(groupinInfoList, settings) {
         let newGroupInfoList = groupinInfoList;
         if (settings.hasDateTime) {
@@ -112,65 +68,25 @@ export class FilterResources {
         }
         return newGroupInfoList;
     }
-    /**
-     * Gets the grouping info of Expression column type
-     * @param groupinInfoList the original grouping info list
-     * @param settings settings for the function
-     * @returns the new grouping info list
-     */
     static getGroupingInfoListOnExpressions(groupinInfoList, settings) {
         if (!settings.isExpressionCategorizable)
             return [];
         return groupinInfoList;
     }
-    /**
-     * Gets the grouping info of Image Upload column type
-     * @param groupinInfoList the original grouping info list
-     * @param settings settings for the function
-     * @returns the new grouping info list
-     */
     static getGroupingInfoListOnImageUploads(groupinInfoList, settings) {
         if (settings.hasImageUploadAnalysis)
             return groupinInfoList;
         return groupinInfoList.filter((groupingInfo) => groupingInfo.value !== FILTER_GROUPING.IMAGEUPLOAD_IMAGEWORDS);
     }
-    /**
-     * Gets the complete collection of grouping types
-     * @returns the collection of grouping types
-     */
     static getGroupings() {
         return FILTER_GROUPINGS;
     }
-    /**
-     * Gets the complete collection of validator info
-     * @returns the collection of validator info
-     */
     static getGroupingsInfoList() {
         return FILTER_GROUPING_INFO_LIST;
     }
-    /**
-     * **************************************************************************************************
-     **************************************** Scopes *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the collection of filter scopes in order of hierarchy
-     * @returns the collection of validator info
-     */
     static getHierarchyScopes() {
         return FILTER_SCOPES;
     }
-    /**
-     * **************************************************************************************************
-     **************************************** Timezone *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the filters transformed by the given timezone
-     * @param filters the filters to transform
-     * @param timezone the timezone info
-     * @returns the transformed filters to a new timezone
-     */
     static getFiltersByTimezone(filters, timezone) {
         if (isEmpty(filters) || !Array.isArray(filters))
             return [];
@@ -213,31 +129,12 @@ export class FilterResources {
             };
         });
     }
-    /**
-     * **************************************************************************************************
-     **************************************** Validator *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets a validator info by a validator type
-     * @param validator the validator type
-     * @returns a single validator info
-     */
     static getValidatorInfo(validator) {
         return FILTER_VALIDATOR_INFO[validator];
     }
-    /**
-     * Gets the complete collection of validator info
-     * @returns the collection of validator info
-     */
     static getValidatorInfoList() {
         return FILTER_VALIDATOR_INFO_LIST;
     }
-    /**
-     * Gets a collection of validator info by a column type
-     * @param type the object with column and formula type
-     * @returns a collection of validator info
-     */
     static getValidatorInfoListByColumnType(type) {
         const { type: colummType, formulaType } = type;
         let newType = colummType;
@@ -246,22 +143,12 @@ export class FilterResources {
         }
         return FILTER_VALIDATORS_INFO_BY_COLUMN_TYPE[newType];
     }
-    /**
-     * Gets a collection of validator info by a mutiple column types
-     * - The resulting validator info collection is an intersection of mulitple validator info collections
-     * @param types a collection of objects with column and formula types
-     * @returns a collection of validator info
-     */
     static getValidatorInfoListByColumnTypes(types) {
         if (!Array.isArray(types))
             return [];
         const infoValidators = types.map((type) => FilterResources.getValidatorInfoListByColumnType(type));
         return intersectObjectArrays(infoValidators, "value");
     }
-    /**
-     * Gets the complete collection of validator types
-     * @returns the collection of validator types
-     */
     static getValidators() {
         return FILTER_VALIDATORS;
     }

package/dist/classes/FilterSearcher.d.ts

@@ -1,90 +1,15 @@
-import { IFilterSearcherParams } from "../models/filter-searcher.models";
+import { IFilterSearchEngine } from "../models/filter-searcher.models";
 import { IFilterFindLastIndexReturn, IFilterParamSettings } from "../resources/filter-functions.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Class to search filters.
- */
-export declare class FilterSearcher implements IFilterSearcherParams {
+export declare class FilterSearcher implements IFilterSearchEngine {
     protected filters: IFilter[];
-    /**
-     * Constructor
-     * @param filters the collection of filters
-     */
     constructor(filters?: IFilter[]);
-    /**
-     * **************************************************************************************************
-     **************************************** By Params *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Searchs and excludes filters by the given params
-     * @param params params to exclude the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     excludeByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): IFilter[];
-    /**
-     * Searchs filters by the given params
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     filterByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): IFilter[];
-    /**
-     * Searchs filters by the given params and returns the indexes
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     filterIndexesByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): number[];
-    /**
-     * Searchs filters by the given params.
-     * Gets the first match of the searching
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     findByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): IFilter | undefined;
-    /**
-     * Searchs filters by the given params.
-     * Gets the first match of the searching and returns the related index
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     findIndexByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): number;
-    /**
-     * **************************************************************************************************
-     **************************************** By Filters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets an index where the new filter is going to be added
-     * If an index is given, the searching is skipped
-     * @param newFilter the new filter to add
-     * @param index a custom index
-     * @returns the index result object
-     */
     findLastIndexByFilter(newFilter: IFilter, index?: number): IFilterFindLastIndexReturn;
-    /**
-     * **************************************************************************************************
-     ****************************************** Getters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the filter collection
-     * @returns the collection of filters of the context
-     */
     getFilters(): IFilter[];
-    /**
-     * **************************************************************************************************
-     ****************************************** Setters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Sets the filters
-     * @param filters the new collection of filters to set
-     */
     setFilters(filters: IFilter[]): void;
 }
-//# sourceMappingURL=FilterSearcher.d.ts.map

package/dist/classes/FilterSearcher.js

@@ -1,54 +1,24 @@
 import { getLastIndexFromArray, isEmpty, isNaNV2, objectCopy, } from "@qrvey/utils";
 import { getParamFiltersSettings } from "../helpers/filter-settings.helpers";
 import { resolveFilterConditions } from "../helpers/resolveFilterConditions";
-/**
- * Class to search filters.
- */
 export class FilterSearcher {
     filters;
-    /**
-     * Constructor
-     * @param filters the collection of filters
-     */
     constructor(filters = []) {
         this.filters = filters;
         this.setFilters(Array.isArray(filters) ? filters : []);
     }
-    /**
-     * **************************************************************************************************
-     **************************************** By Params *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Searchs and excludes filters by the given params
-     * @param params params to exclude the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     excludeByParams(params, settings) {
         if (isEmpty(this.filters) || isEmpty(params))
             return this.filters;
         const completeSettings = getParamFiltersSettings(settings);
         return this.filters.filter((filter) => !resolveFilterConditions(filter, params, completeSettings));
     }
-    /**
-     * Searchs filters by the given params
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     filterByParams(params, settings) {
         if (isEmpty(this.filters) || isEmpty(params))
             return this.filters;
         const completeSettings = getParamFiltersSettings(settings);
         return this.filters.filter((filter) => resolveFilterConditions(filter, params, completeSettings));
     }
-    /**
-     * Searchs filters by the given params and returns the indexes
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     filterIndexesByParams(params, settings) {
         if (isEmpty(this.filters) || isEmpty(params))
             return [];
@@ -61,42 +31,16 @@ export class FilterSearcher {
             return indexes;
         }, []);
     }
-    /**
-     * Searchs filters by the given params.
-     * Gets the first match of the searching
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     findByParams(params, settings) {
         if (isEmpty(this.filters) || isEmpty(params))
             return undefined;
         return this.filters.find((filter) => resolveFilterConditions(filter, params, getParamFiltersSettings(settings)));
     }
-    /**
-     * Searchs filters by the given params.
-     * Gets the first match of the searching and returns the related index
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     findIndexByParams(params, settings) {
         if (isEmpty(this.filters) || isEmpty(params))
             return -1;
         return this.filters.findIndex((filter) => resolveFilterConditions(filter, params, getParamFiltersSettings(settings)));
     }
-    /**
-     * **************************************************************************************************
-     **************************************** By Filters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets an index where the new filter is going to be added
-     * If an index is given, the searching is skipped
-     * @param newFilter the new filter to add
-     * @param index a custom index
-     * @returns the index result object
-     */
     findLastIndexByFilter(newFilter, index = -1) {
         const result = {
             index: -1,
@@ -111,47 +55,26 @@ export class FilterSearcher {
             return { ...result, index: this.filters.length - 1 };
         if (newIndex > -1)
             return { ...result, index: newIndex };
-        // Look index next to Scope - Dataset - column
         let lastIndex = getLastIndexFromArray(this.filters, (aFilter) => aFilter.columnId === newFilter.columnId &&
             aFilter.datasetId === newFilter.datasetId &&
             aFilter.scope === newFilter.scope &&
             aFilter.scopeId === newFilter.scopeId);
         if (lastIndex > -1)
             return { ...result, index: lastIndex, nextToColumnFilter: true };
-        // Look index next to Scope - Dataset
         lastIndex = getLastIndexFromArray(this.filters, (aFilter) => aFilter.datasetId === newFilter.datasetId &&
             aFilter.scope === newFilter.scope &&
             aFilter.scopeId === newFilter.scopeId);
         if (lastIndex > -1)
             return { ...result, index: lastIndex, nextToDatasetFilter: true };
-        // Look index next to Scope
         lastIndex = getLastIndexFromArray(this.filters, (aFilter) => aFilter.scope === newFilter.scope &&
             aFilter.scopeId === newFilter.scopeId);
         if (lastIndex > -1)
             return { ...result, index: lastIndex, nextToScopeFilter: true };
         return result;
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** Getters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the filter collection
-     * @returns the collection of filters of the context
-     */
     getFilters() {
         return this.filters;
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** Setters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Sets the filters
-     * @param filters the new collection of filters to set
-     */
     setFilters(filters) {
         this.filters = objectCopy(filters);
     }

package/dist/classes/FilterValidation.d.ts

@@ -1,58 +1,12 @@
+import { IFilterValidator } from "../resources";
 import { IColumnTypeWithGrouping } from "../resources/filter-grouping.resources";
 import { IFilter } from "../resources/filters.resources";
-import { IFilterValidator } from "../resources";
-/**
- *
- */
 export declare class FilterValidation {
-    /**
-     * Validated if the given filter exists into the filter collection
-     * @param filters the collection of filters
-     * @param filter the filter to validate
-     * @returns True when the filter is duplicated in the collection
-     */
     static isDuplicated(filters: IFilter[], filter: IFilter): boolean;
-    /**
-     * Validates if the given regular value is duplicated with another value collection
-     * @param filter1 the filter info
-     * @param filter2 the filter info to compare
-     * @returns true when the value is duplicated
-     */
     static isFilterValueDuplicated(filter1: IFilter, filter2: IFilter): boolean;
-    /**
-     * Validates if the given regular value is duplicated with another value collection
-     * @param values1 the filter regular values collection
-     * @param values2 the filter regular values collection
-     * @returns true when the regular value is duplicated
-     */
     private static isFilterRegularValueDuplicated;
-    /**
-     * Validates if the given range value is duplicated with another value collection
-     * @param values1 the filter range values collection
-     * @param values2 the filter range values colleciton
-     * @returns true when the range value is duplicated
-     */
     private static isFilterRangeValueDuplicated;
-    /**
-     * Validates if the given relative value is duplicated with another value collection
-     * @param values1 the filter relative values collection
-     * @param values2 the filter relative values collection
-     * @returns true when the relative value is duplicated
-     */
     private static isFilterRelativeValueDuplicated;
-    /**
-     * Validates if the given ranking value is duplicated with another value collection
-     * @param _values1 the filter ranking values collection
-     * @param _values2 the filter ranking values collection
-     * @returns true when the ranking value is duplicated
-     */
     private static isFilterRankingValueDuplicated;
-    /**
-     * Validates if the grouping is valid to set for the given params
-     * @param columnType the column type
-     * @param validator the filter validator
-     * @returns true when the grouping is valid
-     */
     static isGroupingValid(columnType: IColumnTypeWithGrouping, validator: IFilterValidator): boolean;
 }
-//# sourceMappingURL=FilterValidation.d.ts.map