@qrvey/filters 0.0.45 → 0.1.0

package/dist/helpers/getFilterId.d.ts

@@ -1,18 +1,2 @@
 import { IFilter } from "../resources/filters.resources";
-/**
- * Get the Filter ID by the filter structure
- * The order of the epression ID is:
- * - Scope Type
- * - scope Id
- * - dataset Id
- * - column Id
- * - validator
- * - grouping
- * - Column Aggregate
- * - Optional Index
- * @param filter the filter structure
- * @param index an aditional number to add into the ID
- * @returns a text to identify the filter
- */
 export declare function getFilterId(filter: IFilter, index?: number): string;
-//# sourceMappingURL=getFilterId.d.ts.map

package/dist/helpers/getFilterId.js

@@ -1,19 +1,4 @@
 import { isEmpty, isObject } from "@qrvey/utils";
-/**
- * Get the Filter ID by the filter structure
- * The order of the epression ID is:
- * - Scope Type
- * - scope Id
- * - dataset Id
- * - column Id
- * - validator
- * - grouping
- * - Column Aggregate
- * - Optional Index
- * @param filter the filter structure
- * @param index an aditional number to add into the ID
- * @returns a text to identify the filter
- */
 export function getFilterId(filter, index) {
     if (isEmpty(filter) || !isObject(filter))
         return "";

package/dist/helpers/getFilterType.d.ts

@@ -1,11 +1,4 @@
 import { IColumnType } from "@qrvey/utils";
 import { IFilterValidator } from "../resources/filter-validators.resources";
 import { IFilterType } from "../resources/filters.resources";
-/**
- * Gets the filter type based on the column type and the validator
- * @param columnType the column type
- * @param validator the validator type
- * @returns the filter type
- */
 export declare function getFilterType(columnType: IColumnType, validator: IFilterValidator): IFilterType;
-//# sourceMappingURL=getFilterType.d.ts.map

package/dist/helpers/getFilterType.js

@@ -1,11 +1,5 @@
 import { COLUMN } from "@qrvey/utils";
 import { FILTER_TYPE, FILTER_TYPE_BY_VALIDATOR, } from "../resources/filters.resources";
-/**
- * Gets the filter type based on the column type and the validator
- * @param columnType the column type
- * @param validator the validator type
- * @returns the filter type
- */
 export function getFilterType(columnType, validator) {
     if (columnType === COLUMN.RANKING)
         return FILTER_TYPE.RANKING;

package/dist/helpers/index.d.ts

@@ -1,7 +1,11 @@
 export * from "./filter-adapt.helpers";
 export * from "./filter-settings.helpers";
+export * from "./filter-validators.helpers";
+export * from "./filter-verbose.helpers";
+export * from "./getAggregateFilters";
 export * from "./getFilterId";
 export * from "./getFilterType";
+export * from "./isDateDistinctGrouping";
+export * from "./isRankingFilter";
 export * from "./resolveFilterConditions";
 export * from "./utils.helpers";
-//# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.js

@@ -1,6 +1,11 @@
 export * from "./filter-adapt.helpers";
 export * from "./filter-settings.helpers";
+export * from "./filter-validators.helpers";
+export * from "./filter-verbose.helpers";
+export * from "./getAggregateFilters";
 export * from "./getFilterId";
 export * from "./getFilterType";
+export * from "./isDateDistinctGrouping";
+export * from "./isRankingFilter";
 export * from "./resolveFilterConditions";
 export * from "./utils.helpers";

package/dist/helpers/isDateDistinctGrouping.d.ts

@@ -0,0 +1,2 @@
+import { IFilterGrouping } from "../resources/filter-grouping.resources";
+export declare function isDateDistinctGrouping(grouping: IFilterGrouping): boolean;

package/dist/helpers/isDateDistinctGrouping.js

@@ -0,0 +1,12 @@
+import { FILTER_GROUPING, } from "../resources/filter-grouping.resources";
+const DATE_DISTINCT_GROUPINGS = [
+    FILTER_GROUPING.YEAR_QUARTER,
+    FILTER_GROUPING.YEAR_MONTH,
+    FILTER_GROUPING.MONTH_DAY,
+    FILTER_GROUPING.DAY_HOUR,
+    FILTER_GROUPING.HOUR_MINUTE,
+    FILTER_GROUPING.MINUTE_SECOND,
+];
+export function isDateDistinctGrouping(grouping) {
+    return DATE_DISTINCT_GROUPINGS.includes(grouping);
+}

package/dist/helpers/isRankingFilter.d.ts

@@ -0,0 +1,2 @@
+import { IFilter } from "../resources/filters.resources";
+export declare function isRankingFilter(filter: IFilter): boolean;

package/dist/helpers/isRankingFilter.js

@@ -0,0 +1,7 @@
+import { COLUMN, isEmpty } from "@qrvey/utils";
+import { isNullValidator } from "./filter-validators.helpers";
+export function isRankingFilter(filter) {
+    return (filter.columnType === COLUMN.RANKING &&
+        isEmpty(filter.aggregateType) &&
+        !isNullValidator(filter.validator));
+}

package/dist/helpers/resolveFilterConditions.d.ts

@@ -1,11 +1,3 @@
 import { IFilterParamSettings } from "../resources/filter-functions.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Resolves conditions to fullfill the match of the filter object
- * @param filter the filter object
- * @param params the params of the filter to resolve the condition
- * @param settings the filter param settings
- * @returns true: the conditions is fullfiled.
- */
 export declare function resolveFilterConditions(filter: IFilter, params: Partial<IFilter>, settings: IFilterParamSettings): boolean;
-//# sourceMappingURL=resolveFilterConditions.d.ts.map

package/dist/helpers/resolveFilterConditions.js

@@ -1,12 +1,5 @@
-/**
- * Resolves conditions to fullfill the match of the filter object
- * @param filter the filter object
- * @param params the params of the filter to resolve the condition
- * @param settings the filter param settings
- * @returns true: the conditions is fullfiled.
- */
 export function resolveFilterConditions(filter, params, settings) {
-    const paramKeys = Object.keys(params) || [];
+    const paramKeys = Object.keys(params);
     let condition = true;
     for (let i = 0; i < paramKeys.length; i++) {
         const paramKey = paramKeys[i];

package/dist/helpers/utils.helpers.d.ts

@@ -1,26 +1,9 @@
 import { IColumn, IDataset } from "@qrvey/utils";
-/**
- * Gets the column info by ID
- * @param ids the ids to search the info
- * @param ids.columnId the column ID
- * @param ids.datasetId the dataset ID
- * @param datasets the collection of datasets
- * @returns the Column Info
- */
 export declare function getColumnInfo(ids: {
     columnId: string;
     datasetId: string;
 }, datasets?: IDataset[]): IColumn | undefined;
-/**
- * Gets the dataset info by ID
- * @param ids the ids to search the info
- * @param ids.columnId the column ID
- * @param ids.datasetId the dataset ID
- * @param datasets the collection of datasets
- * @returns the Dataset Info
- */
 export declare function getDatasetInfo(ids: {
     columnId: string;
     datasetId: string;
 }, datasets?: IDataset[]): IDataset | undefined;
-//# sourceMappingURL=utils.helpers.d.ts.map

package/dist/helpers/utils.helpers.js

@@ -1,23 +1,7 @@
-/**
- * Gets the column info by ID
- * @param ids the ids to search the info
- * @param ids.columnId the column ID
- * @param ids.datasetId the dataset ID
- * @param datasets the collection of datasets
- * @returns the Column Info
- */
 export function getColumnInfo(ids, datasets = []) {
     const datasetInfo = getDatasetInfo(ids, datasets);
     return datasetInfo?.options?.find((cInfo) => cInfo.id === ids.columnId && cInfo.qrveyid === ids.datasetId);
 }
-/**
- * Gets the dataset info by ID
- * @param ids the ids to search the info
- * @param ids.columnId the column ID
- * @param ids.datasetId the dataset ID
- * @param datasets the collection of datasets
- * @returns the Dataset Info
- */
 export function getDatasetInfo(ids, datasets = []) {
     if (ids == null || !Array.isArray(datasets))
         return;

package/dist/index.d.ts

@@ -2,4 +2,3 @@ export * from "./classes";
 export * from "./helpers";
 export * from "./models";
 export * from "./resources";
-//# sourceMappingURL=index.d.ts.map

package/dist/models/filter-builder.models.d.ts

@@ -1,203 +1,47 @@
 import { IFilterAddSettings, IFilterBuilderEditSettings, IFilterMergeSettings, IFilterParamSettings } from "../resources/filter-functions.resources";
 import { IFilterValue } from "../resources/filter-values.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Structure model for the adding filters
- */
 export interface IFilterBuilderAdd {
-    /**
-     * Adds one filter into the collection.
-     * Inserts it next to the last similar filter
-     * @param filter the filter to add
-     * @param inIndex the index to add the new filter
-     * @param settings the settings object to setup this function
-     * @returns the new collection of filters
-     */
     addSingle: (filter: IFilter, inIndex?: number, settings?: IFilterAddSettings) => IFilterBuilderSingleReturn;
-    /**
-     * Adds various filter into the collection.
-     * Inserts them next to the last similar filter
-     * @param filter the filter to add
-     * @param inIndexes collection of indexes to add the new filters
-     * @param settings the settings object to setup this function
-     * @returns the new collection of filters
-     */
     addMultiple: (filter: IFilter[], inIndexes?: number[], settings?: IFilterAddSettings) => IFilterBuilderMultipleReturn;
 }
-/**
- * Structure module for the editing filter values
- */
 export interface IFilterBuilderAddValue {
-    /**
-     * Adds one value from filter
-     * @param id the ID to search the filter to add value
-     * @param value the value to to add
-     * @returns the new filter collection
-     */
     addValue: (id: string, value: IFilterValue) => IFilterBuilderSingleReturn;
-    /**
-     * Adds various values from filter
-     * @param id the ID to search the filter to add value
-     * @param values the value collection to add
-     * @returns the new filter collection
-     */
     addValues: (id: string, values: IFilterValue[]) => IFilterBuilderSingleReturn;
 }
-/**
- * Structure module for the deleting filters
- */
 export interface IFilterBuilderDelete {
-    /**
-     * Removes one filter from the collection
-     * @param id the ID to search the filter to remove
-     * @returns the new filter collection
-     */
     deleteSingle: (id: string) => IFilterBuilderSingleReturn;
-    /**
-     * Removes various filters from the collection
-     * @param ids a collection of ID to search filters to remove
-     * @returns the new filter collection
-     */
     deleteMultiple: (ids: string[]) => IFilterBuilderMultipleReturn;
 }
-/**
- * Structure module for the editing filter values
- */
 export interface IFilterBuilderDeleteValue {
-    /**
-     * Removes one value from filter
-     * @param id the ID to search the filter to remove value
-     * @param index the index to search the value to remove
-     * @returns the new filter collection
-     */
     deleteValue: (id: string, index: number) => IFilterBuilderSingleReturn;
-    /**
-     * Removes various values from filter
-     * @param id the ID to search the filter to remove value
-     * @param indexes the index collection to search the value to remove
-     * @returns the new filter collection
-     */
     deleteValues: (id: string, indexes: number[]) => IFilterBuilderSingleReturn;
 }
-/**
- * Structure module for the editing filters
- */
 export interface IFilterBuilderEdit {
-    /**
-     * Edits one filter from the collection
-     * @param filter an object with properties to edit
-     * @param id the ID to search the filter to edit
-     * @param settings settings object for the function
-     * @returns the new filter collection
-     */
     editSingle: (id: string, filter: Partial<IFilter> | IFilter, settings?: IFilterBuilderEditSettings) => IFilterBuilderSingleReturn;
-    /**
-     * Edits various filters from the collection
-     * @param filters a collection of object with properties to edit
-     * @param ids the collection of IDs to search filters to edit
-     * @param settings settings object for the function
-     * @returns the new filter collection
-     */
     editMultiple: (ids: string[], filter: Partial<IFilter>[] | IFilter[], settings?: IFilterBuilderEditSettings) => IFilterBuilderMultipleReturn;
 }
-/**
- * Structure module for the editing filter values
- */
 export interface IFilterBuilderEditValue {
-    /**
-     * Edits one value from filter
-     * @param id the ID to search the filter to edit value
-     * @param value the value to edit
-     * @param index the value index to edit
-     * @returns the new filter collection
-     */
     editValue: (id: string, value: IFilterValue, index: number) => IFilterBuilderSingleReturn;
-    /**
-     * Edits various values from filter
-     * @param id the ID to search the filter to edit value
-     * @param values the value collection to edit
-     * @param indexes the index collection to edit
-     * @returns the new filter collection
-     */
     editValues: (id: string, values: IFilterValue[], indexes: number[]) => IFilterBuilderSingleReturn;
 }
-/**
- * Structure module for the editing filters
- */
 export interface IFilterBuilderMerge {
-    /**
-     * Merge the filter into the collection by some filter parameters
-     * @param filter the filter to merge
-     * @param settings the settings object to setup this function
-     * @returns the new filter collection
-     */
     mergeSingle: (filter: IFilter, settings?: IFilterMergeSettings) => IFilterBuilderSingleReturn;
-    /**
-     * Merge the filters into the collection by some filter parameters
-     * @param filters the filter collection to merge
-     * @param settings the settings object to setup this function
-     * @returns the new filter collection
-     */
     mergeMultiple: (filters: IFilter[], settings?: IFilterMergeSettings) => IFilterBuilderMultipleReturn;
 }
-/**
- * Structure module for the editing filter values
- */
 export interface IFilterBuilderMergeValue {
-    /**
-     * Merge values from filter
-     * @param id the ID to search the filter to merge values
-     * @param values the value collection to merge
-     * @returns the new filter collection
-     */
     mergeValues: (id: string, values: IFilterValue[] | undefined, indexes: number[]) => IFilterBuilderSingleReturn;
 }
-/**
- * Structure module for the setting filters
- */
 export interface IFilterBuilderSet {
-    /**
-     * Sets the given filters by param
-     * - Remove the filters by the sucesfull conditions and replace the given ones
-     * @param filters the filters to set
-     * @param params params to search the filters
-     * @param settings settings for this function
-     * @returns the new collection of filters
-     */
     replaceByParams: (filters: IFilter[], params: Partial<IFilter>, settings?: IFilterParamSettings) => IFilterBuilderMultipleReturn;
 }
-/**
- * Structure for the returning a single item
- */
 export interface IFilterBuilderSingleReturn {
-    /**
-     * the new filter collection
-     */
     resulting: IFilter[];
-    /**
-     * the affected filter
-     */
     affected?: IFilter;
-    /**
-     * the original filter before affecting
-     */
     original?: IFilter;
 }
-/**
- * Structure for the returning a multiple items
- */
 export interface IFilterBuilderMultipleReturn {
-    /**
-     * the new filter collection
-     */
     resulting: IFilter[];
-    /**
-     * the affected filters
-     */
     affected?: IFilter[];
-    /**
-     * the original filters before affecting
-     */
     original?: IFilter[];
 }
-//# sourceMappingURL=filter-builder.models.d.ts.map

package/dist/models/filter-resources.models.d.ts

@@ -2,70 +2,17 @@ import { IColumnType } from "@qrvey/utils";
 import { IFilterGroupingInfoListByColumnSettings } from "../resources/filter-functions.resources";
 import { IColumnTypeWithGrouping, IFilterGrouping, IFilterGroupingInfo } from "../resources/filter-grouping.resources";
 import { IFilterValidator, IFilterValidatorInfo } from "../resources/filter-validators.resources";
-/**
- * Structure model for the getting resources
- */
 export interface IFilterResourcesValidator {
-    /**
-     * Gets the complete collection of validator types
-     * @returns the collection of validator types
-     */
     getValidators: () => IFilterValidator[];
-    /**
-     * Gets the complete collection of validator info
-     * @returns the collection of validator info
-     */
     getInfoValidators: () => IFilterValidatorInfo[];
-    /**
-     * Gets a validator info by a validator type
-     * @param validator the validator type
-     * @returns a single validator info
-     */
     getInfoByValidator: (validator: IFilterValidator) => IFilterValidatorInfo;
-    /**
-     * Gets a collection of validator info by a column type
-     * @param type the column type
-     * @returns a collection of validator info
-     */
     getInfoValidatorsByColumnType: (type: IColumnType) => 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 column types
-     * @returns a collection of validator info
-     */
     getInfoValidatorsByColumnTypes: (types: IColumnType[]) => IFilterValidatorInfo[];
 }
 export interface IFilterResourcesGrouping {
-    /**
-     * Gets the complete collection of grouping types
-     * @returns the collection of grouping types
-     */
     getGroupings: () => IFilterGrouping[];
-    /**
-     * Gets the complete collection of validator info
-     * @returns the collection of validator info
-     */
     getInfoGroupings: () => IFilterGroupingInfo[];
-    /**
-     * Gets a grouping info by a grouping type
-     * @param grouping the grouping type
-     * @returns a single grouping info
-     */
     getInfoByGrouping: (validator: IFilterValidator) => IFilterGroupingInfo;
-    /**
-     * Gets a collection of validator info by a column type
-     * @param type the column type
-     * @returns a collection of validator info
-     */
     getInfoGroupingsByColumnType: (type: IColumnType, settings?: IFilterGroupingInfoListByColumnSettings) => IFilterGroupingInfo[];
-    /**
-     * 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 column type
-     * @param settings settings for the function
-     * @returns a collection of grouping info
-     */
     getInfoGroupingsByColumnTypes: (types: IColumnTypeWithGrouping[], settings?: IFilterGroupingInfoListByColumnSettings[]) => IFilterGroupingInfo[];
 }
-//# sourceMappingURL=filter-resources.models.d.ts.map

package/dist/models/filter-searcher.models.d.ts

@@ -1,42 +1,13 @@
-import { IFilterParamSettings } from "../resources/filter-functions.resources";
+import { IFilterFindLastIndexReturn, IFilterParamSettings } from "../resources/filter-functions.resources";
 import { IFilter } from "../resources/filters.resources";
 export interface IFilterSearcherParams {
-    /**
-     * 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 inexes
-     * @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;
 }
-//# sourceMappingURL=filter-searcher.models.d.ts.map
+export interface IFilterSearchEngine extends IFilterSearcherParams {
+    findLastIndexByFilter(newFilter: IFilter, index?: number): IFilterFindLastIndexReturn;
+    setFilters(filters: IFilter[]): void;
+}

package/dist/models/filter-validation.models.d.ts

@@ -1,59 +1,19 @@
 import { IFilterValidation, IFilterValidationInfo } from "../resources/filter-validation.resources";
 import { IFilterInputValue } from "../resources/filter-values.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Structure module for the editing filter values
- */
 export interface IFilterValidationValue {
-    /**
-     * Validates the value based on the given filter
-     * @param filter the filter to validate the value
-     * @param value the value to validate
-     * @returns the resulting validation
-     */
     value: (filter: IFilter, value: IFilterInputValue) => IFilterValidationSingleError;
-    /**
-     * Validates the values based on the given filter
-     * @param filter the filter to validate the value
-     * @param values the collection of values to validate
-     * @returns the resulting validation
-     */
     values: (filter: IFilter, values: IFilterInputValue[]) => IFilterValidationMultipleError;
 }
-/**
- * Structure for the returning validation status
- */
 export interface IFilterValidationSingleError {
-    /**
-     * the errors
-     */
     errors: IFilterValidationError[];
-    /**
-     * The info of the errors
-     */
     infoErrors: IFilterValidationInfo[];
 }
-/**
- * Structure for the returning validation status on mulitple values
- */
 export interface IFilterValidationMultipleError {
-    /**
-     * the errors collection
-     */
     errors: IFilterValidationError[][];
-    /**
-     * The info of the errors collection
-     */
     infoErrors: IFilterValidationInfo[][];
 }
-/**
- * Structure for the error
- */
 export interface IFilterValidationError {
     type: IFilterValidation;
-    /**
-     * the affected values
-     */
     value?: IFilterInputValue;
 }
-//# sourceMappingURL=filter-validation.models.d.ts.map

package/dist/models/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./filter-builder.models";
 export * from "./filter-resources.models";
 export * from "./filter-searcher.models";
-//# sourceMappingURL=index.d.ts.map