@qrvey/filters 0.0.1 → 0.0.2

package/src/classes/FilterBuilder.ts

@@ -1,6 +1,6 @@
 import { getLastIndexFromArray, isEmpty, objectCopy } from "@qrvey/utils";
 
-import { FilterSearch } from "./FilterSearch";
+import { FilterSearcher } from "./FilterSearcher";
 
 import { getEditFiltersSettings } from "../helpers/filter-settings.helpers";
 import { getFilterId } from "../helpers/getFilterId";
@@ -12,11 +12,15 @@ import {
   IFilterBuilderEdit,
   IFilterBuilderEditValue,
   IFilterBuilderMultipleReturn,
+  IFilterBuilderSet,
   IFilterBuilderSingleReturn,
 } from "../models/filter-builder.models";
-import { IFilterBuilderEditSettings } from "../resources/filter-functions.resources";
+import {
+  IFilterBuilderEditSettings,
+  IFilterParamSettings,
+} from "../resources/filter-functions.resources";
 import { IFilterValue } from "../resources/filter-values.resources";
-import { IFilter } from "../resources/filters.resources";
+import { DEFAULT_FILTER, IFilter } from "../resources/filters.resources";
 
 /**
  * Class to build new filters and manipulate ones.
@@ -28,19 +32,20 @@ export class FilterBuilder
     IFilterBuilderDelete,
     IFilterBuilderDeleteValue,
     IFilterBuilderEdit,
-    IFilterBuilderEditValue
+    IFilterBuilderEditValue,
+    IFilterBuilderSet
 {
   /**
    * Instance to search filters
    */
-  private searchEngine: FilterSearch;
+  private searchEngine: FilterSearcher;
 
   /**
    * Constructor
    * @param filters the collection of filters
    */
-  constructor(protected filters: IFilter[]) {
-    this.searchEngine = new FilterSearch(filters);
+  constructor(protected filters: IFilter[] = []) {
+    this.searchEngine = new FilterSearcher(filters);
   }
 
   /**
@@ -150,6 +155,40 @@ export class FilterBuilder
     return { resulting: this.filters, affected: affectedFilters };
   }
 
+  /**
+   * Builds an filter structure based on given params
+   * @param filter the partial filter params
+   * @param automaticId flag to generate a new filter ID based on the filter info
+   * @returns the complete filter structure
+   */
+  createFilter(filter: Partial<IFilter>, automaticId = true): IFilter {
+    const newFilter: IFilter = {
+      ...DEFAULT_FILTER,
+      aggregateType: filter.aggregateType ?? DEFAULT_FILTER.aggregateType,
+      collapsed: filter.collapsed ?? DEFAULT_FILTER.collapsed,
+      columnId: filter.columnId ?? DEFAULT_FILTER.columnId,
+      columnType: filter.columnType ?? DEFAULT_FILTER.columnType,
+      datasetId: filter.datasetId ?? DEFAULT_FILTER.datasetId,
+      deletable: filter.deletable ?? DEFAULT_FILTER.deletable,
+      displayed: filter.displayed ?? DEFAULT_FILTER.displayed,
+      editable: filter.editable ?? DEFAULT_FILTER.editable,
+      enableable: filter.enableable ?? DEFAULT_FILTER.enableable,
+      enabled: filter.enabled ?? DEFAULT_FILTER.enabled,
+      id: "",
+      operator: filter.operator || DEFAULT_FILTER.operator,
+      scope: filter.scope || DEFAULT_FILTER.scope,
+      scopeId: filter.scopeId || DEFAULT_FILTER.scopeId,
+      validator: filter.validator || DEFAULT_FILTER.validator,
+      grouping: filter.grouping || DEFAULT_FILTER.grouping,
+      section: filter.section || DEFAULT_FILTER.section,
+      selectAll: filter.selectAll ?? DEFAULT_FILTER.selectAll,
+      values: filter.values || DEFAULT_FILTER.values,
+    };
+    if (automaticId) newFilter.id = getFilterId(newFilter);
+
+    return newFilter;
+  }
+
   /**
    * Removes one filter from the collection
    * @param id the ID to search the filter to remove
@@ -190,6 +229,23 @@ export class FilterBuilder
     return { resulting: this.filters, affected: deletedFilters };
   }
 
+  /**
+   * Removes various filters by params
+   * @param params params to search the filters to delete
+   * @param settings settings for this function
+   * @returns the new collection of filters
+   */
+  public deleteByParams(
+    params: Partial<IFilter>,
+    settings?: IFilterParamSettings,
+  ): IFilterBuilderMultipleReturn {
+    const affected = this.searchEngine.filterByParams(params, settings);
+    this.filters = this.searchEngine.excludeByParams(params, settings);
+
+    this.sync();
+    return { resulting: this.filters, affected };
+  }
+
   /**
    * Removes one value from filter
    * @param id the ID to search the filter to remove value
@@ -369,10 +425,44 @@ export class FilterBuilder
     return { resulting: this.filters, affected: affectedFilters };
   }
 
+  /**
+   * **************************************************************************************************
+   ****************************************** Setters *************************************************
+   ****************************************************************************************************
+   */
+
+  /**
+   * 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 {
+    this.filters = this.searchEngine.excludeByParams(params, settings);
+    const resulting = this.addMutiple(filters);
+
+    this.sync();
+    return { resulting: this.filters, affected: resulting.affected };
+  }
+
   /**
    * Method to sync the Filter instances
    */
   private sync(): void {
     this.searchEngine.setFilters(this.filters);
   }
+
+  /**
+   * Sets the filters
+   * @param filters the new collection of filters to set
+   */
+  public setFilters(filters: IFilter[]): void {
+    this.filters = filters;
+  }
 }

package/src/classes/FilterManager.ts

@@ -1,40 +1,108 @@
+import { IDataset } from "@qrvey/utils";
+
+import { FilterAdapter } from "./FilterAdapter";
 import { FilterBuilder } from "./FilterBuilder";
-import { FilterSearch } from "./FilterSearch";
+import { FilterSearcher } from "./FilterSearcher";
 
+import { IFilterPanelInteractiveTable } from "../resources";
 import { IFilter } from "../resources/filters.resources";
 
 /**
- *
+ * Class to manage the filters
  */
 export class FilterManager {
   /**
-   * Instance to search filters
+   * Instance to adapt filters
    */
-  private searchEngine: FilterSearch;
+  private _adapt: FilterAdapter;
 
   /**
    * Instance to build filters
    */
-  private builder: FilterBuilder;
+  private _builder: FilterBuilder;
 
   /**
-   * Class to get static resources
+   * Instance to search filters
    */
-  // private resources: FilterResources;
+  private _searchEngine: FilterSearcher;
 
   /**
    * Constructor
    * @param filters the collection of filters
+   * @param datasets the collection of datasets info
+   * @param interactiveTable table of interaction properties for each section
+   */
+  constructor(
+    protected filters: IFilter[] = [],
+    protected datasets: IDataset[] = [],
+    protected interactiveTable?: IFilterPanelInteractiveTable,
+  ) {
+    this._searchEngine = new FilterSearcher(filters);
+    this._builder = new FilterBuilder(filters);
+    this._adapt = new FilterAdapter(filters, datasets, interactiveTable);
+  }
+
+  /**
+   * **************************************************************************************************
+   ****************************************** Getters *************************************************
+   ****************************************************************************************************
+   */
+
+  /**
+   * Gets the builder methods
+   * @returns the builder methods
+   */
+  public get builder(): FilterBuilder {
+    return this._builder;
+  }
+
+  /**
+   * Gets the adapt methods
+   * @returns the adapt methods
    */
-  constructor(protected filters: IFilter[]) {
-    this.searchEngine = new FilterSearch(filters);
-    this.builder = new FilterBuilder(filters);
+  public get adapt(): FilterAdapter {
+    return this._adapt;
   }
 
-  manager() {
-    return {
-      searchEngine: this.searchEngine,
-      buider: this.builder,
-    };
+  /**
+   * Gets the search methods
+   * @returns the search methods
+   */
+  public get search(): FilterSearcher {
+    return this._searchEngine;
+  }
+
+  /**
+   * **************************************************************************************************
+   ****************************************** Setters *************************************************
+   ****************************************************************************************************
+   */
+
+  /**
+   * Sets the datasets
+   * @param datasets the collection of dataset info
+   */
+  public setDatasets(datasets: IDataset[]): void {
+    this._adapt.setDatasets(datasets);
+  }
+
+  /**
+   * Sets the filters
+   * @param filters the new collection of filters to set
+   */
+  public setFilters(filters: IFilter[] = []): void {
+    this._builder.setFilters(filters);
+    this._searchEngine.setFilters(filters);
+    this._adapt.setFilters(filters);
+  }
+
+  /**
+   * Sets the table of interactive table
+   * @param interactiveTable table of interaction properties for each section
+   */
+  public setInteractiveTable(
+    interactiveTable: IFilterPanelInteractiveTable,
+  ): void {
+    this.interactiveTable = interactiveTable;
   }
 }

package/src/classes/FilterResources.ts

@@ -1,7 +1,7 @@
 import { COLUMN, IColumnType, intersectObjectArrays } from "@qrvey/utils";
 
 import { getInfoGroupingsByColumnTypeSettings } from "../helpers/filter-settings.helpers";
-import { IFilterInfoGroupingsByColumnSettings } from "../resources/filter-functions.resources";
+import { IFilterGroupingInfoListByColumnSettings } from "../resources/filter-functions.resources";
 import {
   FILTER_GROUPING,
   FILTER_GROUPING_INFO,
@@ -13,15 +13,15 @@ import {
   FILTER_GROUPINGS,
   IColumnTypeWithGrouping,
   IFilterGrouping,
-  IFilterInfoGrouping,
+  IFilterGroupingInfo,
 } from "../resources/filter-grouping.resources";
 import {
   FILTER_VALIDATOR_INFO,
   FILTER_VALIDATOR_INFO_LIST,
   FILTER_VALIDATORS,
   FILTER_VALIDATORS_INFO_BY_COLUMN_TYPE,
-  IFilterInfoValidator,
   IFilterValidator,
+  IFilterValidatorInfo,
 } from "../resources/filter-validators.resources";
 
 /**
@@ -40,7 +40,7 @@ export class FilterResources {
    * Gets the complete collection of validator info
    * @returns the collection of validator info
    */
-  static getInfoValidators(): IFilterInfoValidator[] {
+  static getValidatorInfoList(): IFilterValidatorInfo[] {
     return FILTER_VALIDATOR_INFO_LIST;
   }
 
@@ -49,7 +49,7 @@ export class FilterResources {
    * @param validator the validator type
    * @returns a single validator info
    */
-  static getInfoByValidator(validator: IFilterValidator): IFilterInfoValidator {
+  static getValidatorInfo(validator: IFilterValidator): IFilterValidatorInfo {
     return FILTER_VALIDATOR_INFO[validator];
   }
 
@@ -58,9 +58,9 @@ export class FilterResources {
    * @param type the column type
    * @returns a collection of validator info
    */
-  static getInfoValidatorsByColumnType(
+  static getValidatorInfoListByColumnType(
     type: IColumnType,
-  ): IFilterInfoValidator[] {
+  ): IFilterValidatorInfo[] {
     return FILTER_VALIDATORS_INFO_BY_COLUMN_TYPE[type];
   }
 
@@ -70,13 +70,13 @@ export class FilterResources {
    * @param types a collection of column types
    * @returns a collection of validator info
    */
-  static getInfoValidatorsByColumnTypes(
+  static getValidatorInfoListByColumnTypes(
     types: IColumnType[],
-  ): IFilterInfoValidator[] {
+  ): IFilterValidatorInfo[] {
     if (!Array.isArray(types)) return [];
 
     const infoValidators = types.map((type) =>
-      FilterResources.getInfoValidatorsByColumnType(type),
+      FilterResources.getValidatorInfoListByColumnType(type),
     );
     return intersectObjectArrays(infoValidators, "value");
   }
@@ -93,7 +93,7 @@ export class FilterResources {
    * Gets the complete collection of validator info
    * @returns the collection of validator info
    */
-  static getInfoGroupings(): IFilterInfoGrouping[] {
+  static getGroupingsInfoList(): IFilterGroupingInfo[] {
     return FILTER_GROUPING_INFO_LIST;
   }
 
@@ -102,7 +102,7 @@ export class FilterResources {
    * @param grouping the grouping type
    * @returns a single grouping info
    */
-  static getInfoByGrouping(grouping: IFilterGrouping): IFilterInfoGrouping {
+  static getGroupingInfo(grouping: IFilterGrouping): IFilterGroupingInfo {
     return FILTER_GROUPING_INFO[grouping];
   }
 
@@ -112,25 +112,26 @@ export class FilterResources {
    * @param settings settings for the function
    * @returns a collection of grouping info
    */
-  static getInfoGroupingsByColumnType(
-    type: IColumnTypeWithGrouping,
-    settings?: IFilterInfoGroupingsByColumnSettings,
-  ): IFilterInfoGrouping[] {
+  static getGroupingInfoListByColumnType(
+    type: IColumnType,
+    settings?: IFilterGroupingInfoListByColumnSettings,
+  ): IFilterGroupingInfo[] {
     const completeSettings = getInfoGroupingsByColumnTypeSettings(settings);
-    let groupinInfoList = FILTER_GROUPING_INFO_BY_COLUMN_TYPE[type];
+    let groupinInfoList =
+      FILTER_GROUPING_INFO_BY_COLUMN_TYPE[type as IColumnTypeWithGrouping];
 
     if (type === COLUMN.EXPRESSION)
-      groupinInfoList = this.getInfoGroupingOnExpressions(
+      groupinInfoList = this.getGroupingInfoListOnExpressions(
         groupinInfoList,
         completeSettings,
       );
     if (type === COLUMN.IMAGEUPLOAD)
-      groupinInfoList = this.getInfoGroupingOnImageUploads(
+      groupinInfoList = this.getGroupingInfoListOnImageUploads(
         groupinInfoList,
         completeSettings,
       );
-    if ([COLUMN.DATE, COLUMN.DATE_FORMULA].includes(type))
-      groupinInfoList = this.getInfoGroupingOnDates(
+    if (type === COLUMN.DATE || type === COLUMN.DATE_FORMULA)
+      groupinInfoList = this.getGroupingInfoListOnDates(
         groupinInfoList,
         completeSettings,
       );
@@ -144,10 +145,10 @@ export class FilterResources {
    * @param settings settings for the function
    * @returns the new grouping info list
    */
-  static getInfoGroupingOnExpressions(
-    groupinInfoList: IFilterInfoGrouping[],
-    settings: IFilterInfoGroupingsByColumnSettings,
-  ): IFilterInfoGrouping[] {
+  static getGroupingInfoListOnExpressions(
+    groupinInfoList: IFilterGroupingInfo[],
+    settings: IFilterGroupingInfoListByColumnSettings,
+  ): IFilterGroupingInfo[] {
     if (!settings.isExpressionCategorizable) return [];
 
     return groupinInfoList;
@@ -159,10 +160,10 @@ export class FilterResources {
    * @param settings settings for the function
    * @returns the new grouping info list
    */
-  static getInfoGroupingOnImageUploads(
-    groupinInfoList: IFilterInfoGrouping[],
-    settings: IFilterInfoGroupingsByColumnSettings,
-  ): IFilterInfoGrouping[] {
+  static getGroupingInfoListOnImageUploads(
+    groupinInfoList: IFilterGroupingInfo[],
+    settings: IFilterGroupingInfoListByColumnSettings,
+  ): IFilterGroupingInfo[] {
     if (settings.hasImageUploadAnalysis) return groupinInfoList;
 
     return groupinInfoList.filter(
@@ -177,10 +178,10 @@ export class FilterResources {
    * @param settings settings for the function
    * @returns the new grouping info list
    */
-  static getInfoGroupingOnDates(
-    groupinInfoList: IFilterInfoGrouping[],
-    settings: IFilterInfoGroupingsByColumnSettings,
-  ): IFilterInfoGrouping[] {
+  static getGroupingInfoListOnDates(
+    groupinInfoList: IFilterGroupingInfo[],
+    settings: IFilterGroupingInfoListByColumnSettings,
+  ): IFilterGroupingInfo[] {
     let newGroupInfoList = groupinInfoList;
     if (settings.hasDateTime) {
       newGroupInfoList = [
@@ -211,14 +212,14 @@ export class FilterResources {
    * @param settings settings for the function
    * @returns a collection of grouping info
    */
-  static getInfoGroupingsByColumnTypes(
-    types: IColumnTypeWithGrouping[],
-    settings?: IFilterInfoGroupingsByColumnSettings[],
-  ): IFilterInfoGrouping[] {
+  static getGroupingInfoListByColumnTypes(
+    types: IColumnType[],
+    settings?: IFilterGroupingInfoListByColumnSettings[],
+  ): IFilterGroupingInfo[] {
     if (!Array.isArray(types)) return [];
 
     const infoGroupings = types.map((type, index) =>
-      FilterResources.getInfoGroupingsByColumnType(type, settings?.[index]),
+      FilterResources.getGroupingInfoListByColumnType(type, settings?.[index]),
     );
     return intersectObjectArrays(infoGroupings, "value");
   }

package/src/classes/{FilterSearch.ts → FilterSearcher.ts}

@@ -8,13 +8,34 @@ import { IFilter } from "../resources/filters.resources";
 /**
  * Class to search filters.
  */
-export class FilterSearch {
+export class FilterSearcher {
   /**
    * Constructor
    * @param filters the collection of filters
    */
   constructor(protected filters: IFilter[] = []) {}
 
+  /**
+   * 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
+   */
+  public excludeByParams(
+    params: Partial<IFilter>,
+    settings?: IFilterParamSettings,
+  ): IFilter[] {
+    if (isEmpty(this.filters) || isEmpty(params)) return this.filters;
+
+    const completeSettings: IFilterParamSettings =
+      getParamFiltersSettings(settings);
+
+    return this.filters.filter(
+      (filter: IFilter) =>
+        !resolveFilterConditions(filter, params, completeSettings),
+    );
+  }
+
   /**
    * Searchs filters by the given params
    * @param params params to search the filters
@@ -30,21 +51,45 @@ export class FilterSearch {
     const completeSettings: IFilterParamSettings =
       getParamFiltersSettings(settings);
 
-    return this.filters.reduce((filters: IFilter[], filter: IFilter) => {
-      const condition = resolveFilterConditions(
-        filter,
-        params,
-        completeSettings,
-      );
+    return this.filters.filter((filter: IFilter) =>
+      resolveFilterConditions(filter, params, completeSettings),
+    );
+  }
 
-      if (condition) filters.push(filter);
-      return filters;
-    }, []);
+  /**
+   * 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
+   */
+  public filterIndexesByParams(
+    params: Partial<IFilter>,
+    settings?: IFilterParamSettings,
+  ): number[] {
+    if (isEmpty(this.filters) || isEmpty(params)) return [];
+
+    const completeSettings: IFilterParamSettings =
+      getParamFiltersSettings(settings);
+
+    return this.filters.reduce(
+      (indexes: number[], filter: IFilter, index: number) => {
+        const condition = resolveFilterConditions(
+          filter,
+          params,
+          completeSettings,
+        );
+        if (condition) {
+          indexes.push(index);
+        }
+        return indexes;
+      },
+      [],
+    );
   }
 
   /**
    * Searchs filters by the given params.
-   * Get the first match of the searching
+   * 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
@@ -66,7 +111,7 @@ export class FilterSearch {
 
   /**
    * Searchs filters by the given params.
-   * Get the first match of the searching and return the related index
+   * 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
@@ -86,6 +131,12 @@ export class FilterSearch {
     );
   }
 
+  /**
+   * **************************************************************************************************
+   ****************************************** Setters *************************************************
+   ****************************************************************************************************
+   */
+
   /**
    * Sets the filters
    * @param filters the new collection of filters to set

package/src/classes/index.ts

@@ -1,4 +1,4 @@
 export * from "./FilterBuilder";
 export * from "./FilterManager";
 export * from "./FilterResources";
-export * from "./FilterSearch";
+export * from "./FilterSearcher";