@qrvey/filters 0.0.44 → 0.1.0

package/src/classes/FilterManager.ts

@@ -1,126 +0,0 @@
-import { IDataset } from "@qrvey/utils";
-
-import { FilterAdapter } from "./FilterAdapter";
-import { FilterBuilder } from "./FilterBuilder";
-import { FilterSearcher } from "./FilterSearcher";
-
-import { IFilterPanelInteractiveTable } from "../resources";
-import { IFilter } from "../resources/filters.resources";
-
-/**
- * Class to manage the filters
- */
-export class FilterManager {
-  /**
-   * Instance to adapt filters
-   */
-  private _adapt: FilterAdapter;
-
-  /**
-   * Instance to build filters
-   */
-  private _builder: FilterBuilder;
-
-  /**
-   * Instance to search filters
-   */
-  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[] = [],
-    private _interactiveTable?: IFilterPanelInteractiveTable,
-  ) {
-    this._searchEngine = new FilterSearcher(_filters);
-    this._builder = new FilterBuilder(_filters);
-    this._adapt = new FilterAdapter(_filters, datasets, _interactiveTable);
-  }
-
-  /**
-   * **************************************************************************************************
-   ****************************************** Getters *************************************************
-   ****************************************************************************************************
-   */
-
-  /**
-   * Gets the adapt methods
-   * @returns the adapt methods
-   */
-  public get adapt(): FilterAdapter {
-    return this._adapt;
-  }
-
-  /**
-   * Gets the builder methods
-   * @returns the builder methods
-   */
-  public get builder(): FilterBuilder {
-    return this._builder;
-  }
-
-  /**
-   * Gets the filter collections
-   * @returns the filters
-   */
-  public get filters(): IFilter[] {
-    return this._filters;
-  }
-
-  /**
-   * Gets the interactive table
-   * @returns the interactive table
-   */
-  public get interactiveTable(): IFilterPanelInteractiveTable | undefined {
-    return this._interactiveTable;
-  }
-
-  /**
-   * 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._filters = filters;
-    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;
-    this._adapt.setInteractiveTable(this._interactiveTable);
-  }
-}

package/src/classes/FilterResources.ts

@@ -1,411 +0,0 @@
-import {
-  COLUMN,
-  COLUMN_BY_FORMULA,
-  FORMULA,
-  getDateByTimezone,
-  IColumnVsFormulaType,
-  IDTimezone,
-  intersectObjectArrays,
-  isEmpty,
-  objectCopy,
-} from "@qrvey/utils";
-
-import { getFilterType } from "../helpers/getFilterType";
-import { getInfoGroupingsByColumnTypeSettings } from "../helpers/filter-settings.helpers";
-import {
-  IFilterValue,
-  IFilterValueRange,
-  IFilterValueRegular,
-  IFilterValueRelativeDate,
-} from "../resources/filter-values.resources";
-import {
-  IFilterGroupingInfoByColumnTypeSettings,
-  IFilterGroupingInfoByFilterSettings,
-  IFilterGroupingInfoListByColumnSettings,
-} from "../resources/filter-functions.resources";
-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,
-  IColumnTypeWithGrouping,
-  IFilterGrouping,
-  IFilterGroupingInfo,
-} from "../resources/filter-grouping.resources";
-import {
-  FILTER_VALIDATOR_INFO,
-  FILTER_VALIDATOR_INFO_LIST,
-  FILTER_VALIDATORS,
-  FILTER_VALIDATORS_INFO_BY_COLUMN_TYPE,
-  IFilterValidator,
-  IFilterValidatorInfo,
-} from "../resources/filter-validators.resources";
-import { IFilter, FILTER_TYPE } from "../resources/filters.resources";
-import {
-  FILTER_SCOPES,
-  IFilterScope,
-} 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
-   */
-  public static getGroupingInfo(
-    grouping: IFilterGrouping,
-  ): IFilterGroupingInfo {
-    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
-   */
-  public static getGroupingInfoListByColumnType(
-    type: IColumnVsFormulaType,
-    settings?: IFilterGroupingInfoListByColumnSettings,
-  ): IFilterGroupingInfo[] {
-    const { type: columnType, formulaType } = type;
-
-    const completeSettings = getInfoGroupingsByColumnTypeSettings(settings);
-
-    let newType = columnType;
-    if (formulaType != null) {
-      newType = COLUMN_BY_FORMULA[formulaType];
-    }
-    let groupinInfoList =
-      FILTER_GROUPING_INFO_BY_COLUMN_TYPE[newType as IColumnTypeWithGrouping];
-
-    if (newType === COLUMN.EXPRESSION)
-      groupinInfoList = this.getGroupingInfoListOnExpressions(
-        groupinInfoList,
-        completeSettings,
-      );
-    if (newType === COLUMN.IMAGEUPLOAD)
-      groupinInfoList = this.getGroupingInfoListOnImageUploads(
-        groupinInfoList,
-        completeSettings,
-      );
-    if (
-      newType === COLUMN.DATE ||
-      newType === COLUMN.DATE_FORMULA ||
-      formulaType === FORMULA.DATE
-    )
-      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
-   */
-  public static getGroupingInfoByColumnType(
-    type: IColumnVsFormulaType,
-    grouping?: IFilterGrouping,
-    settings?: IFilterGroupingInfoByColumnTypeSettings,
-  ): IFilterGroupingInfo | undefined {
-    if (grouping == null) return;
-
-    const groupingInfoList = FilterResources.getGroupingInfoListByColumnType(
-      type,
-      settings,
-    );
-    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
-   */
-  public static getGroupingInfoByFilter(
-    filter: IFilter,
-    settings?: IFilterGroupingInfoByFilterSettings,
-  ): IFilterGroupingInfo | undefined {
-    if (
-      !FilterValidation.isGroupingValid(
-        filter.columnType as IColumnTypeWithGrouping,
-        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
-   */
-  public static getGroupingInfoListByColumnTypes(
-    types: IColumnVsFormulaType[],
-    settings?: IFilterGroupingInfoListByColumnSettings[],
-  ): IFilterGroupingInfo[] {
-    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
-   */
-  public static getGroupingInfoListOnDates(
-    groupinInfoList: IFilterGroupingInfo[],
-    settings: IFilterGroupingInfoListByColumnSettings,
-  ): IFilterGroupingInfo[] {
-    let newGroupInfoList = groupinInfoList;
-    if (settings.hasDateTime) {
-      newGroupInfoList = [
-        ...newGroupInfoList,
-        ...FILTER_GROUPING_INFO_BY_DATE_TIME,
-      ];
-    }
-    if (settings.hasDistinctDate) {
-      newGroupInfoList = [
-        ...newGroupInfoList,
-        ...FILTER_GROUPING_INFO_BY_DISTINCT_DATE,
-      ];
-    }
-    if (settings.hasDistinctDateTime) {
-      newGroupInfoList = [
-        ...newGroupInfoList,
-        ...FILTER_GROUPING_INFO_BY_DISTINCT_DATE_TIME,
-      ];
-    }
-
-    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
-   */
-  public static getGroupingInfoListOnExpressions(
-    groupinInfoList: IFilterGroupingInfo[],
-    settings: IFilterGroupingInfoListByColumnSettings,
-  ): IFilterGroupingInfo[] {
-    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
-   */
-  public static getGroupingInfoListOnImageUploads(
-    groupinInfoList: IFilterGroupingInfo[],
-    settings: IFilterGroupingInfoListByColumnSettings,
-  ): IFilterGroupingInfo[] {
-    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
-   */
-  public static getGroupings(): IFilterGrouping[] {
-    return FILTER_GROUPINGS;
-  }
-
-  /**
-   * Gets the complete collection of validator info
-   * @returns the collection of validator info
-   */
-  public static getGroupingsInfoList(): IFilterGroupingInfo[] {
-    return FILTER_GROUPING_INFO_LIST;
-  }
-
-  /**
-   * **************************************************************************************************
-   **************************************** Scopes *************************************************
-   ****************************************************************************************************
-   */
-
-  /**
-   * Gets the collection of filter scopes in order of hierarchy
-   * @returns the collection of validator info
-   */
-  public static getHierarchyScopes(): IFilterScope[] {
-    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
-   */
-  public static getFiltersByTimezone(
-    filters: IFilter[],
-    timezone: IDTimezone,
-  ): IFilter[] {
-    if (isEmpty(filters) || !Array.isArray(filters)) return [];
-
-    const newFilters: IFilter[] = objectCopy(filters);
-    return newFilters.map((filter) => {
-      const type = getFilterType(filter.columnType, filter.validator);
-
-      let values: IFilterValue[] = filter.values || [];
-      switch (type) {
-        case FILTER_TYPE.RANGE:
-          values = (values as IFilterValueRange[]).map((value) => ({
-            ...value,
-            min:
-              value.min != null
-                ? getDateByTimezone(value.min, timezone)
-                : undefined,
-            max:
-              value.max != null
-                ? getDateByTimezone(value.max, timezone)
-                : undefined,
-          }));
-          break;
-        case FILTER_TYPE.REGULAR:
-          values = (values as IFilterValueRegular[]).map((value) => ({
-            ...value,
-            value:
-              value.value != null
-                ? getDateByTimezone(value.value, timezone)
-                : undefined,
-          }));
-          break;
-        case FILTER_TYPE.RELATIVE:
-          values = (values as IFilterValueRelativeDate[]).map((value) => ({
-            ...value,
-            anchor:
-              typeof value.anchor === "string"
-                ? getDateByTimezone(value.anchor, timezone)
-                : value.anchor,
-          }));
-          break;
-      }
-      return {
-        ...filter,
-        values,
-      };
-    });
-  }
-
-  /**
-   * **************************************************************************************************
-   **************************************** Validator *************************************************
-   ****************************************************************************************************
-   */
-
-  /**
-   * Gets a validator info by a validator type
-   * @param validator the validator type
-   * @returns a single validator info
-   */
-  public static getValidatorInfo(
-    validator: IFilterValidator,
-  ): IFilterValidatorInfo {
-    return FILTER_VALIDATOR_INFO[validator];
-  }
-
-  /**
-   * Gets the complete collection of validator info
-   * @returns the collection of validator info
-   */
-  public static getValidatorInfoList(): IFilterValidatorInfo[] {
-    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
-   */
-  public static getValidatorInfoListByColumnType(
-    type: IColumnVsFormulaType,
-  ): IFilterValidatorInfo[] {
-    const { type: colummType, formulaType } = type;
-
-    let newType = colummType;
-    if (formulaType != null) {
-      newType = COLUMN_BY_FORMULA[formulaType];
-    }
-    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
-   */
-  public static getValidatorInfoListByColumnTypes(
-    types: IColumnVsFormulaType[],
-  ): IFilterValidatorInfo[] {
-    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
-   */
-  public static getValidators(): IFilterValidator[] {
-    return FILTER_VALIDATORS;
-  }
-}