@qrvey/filters 0.0.45 → 0.1.0

package/src/helpers/filter-settings.helpers.ts

@@ -1,133 +0,0 @@
-import {
-  DEFAULT_FILTER_ADD_SETTINGS,
-  DEFAULT_FILTER_CREATE_SETTINGS,
-  DEFAULT_FILTERS_EDIT_SETTINGS,
-  DEFAULT_FILTERS_GROUPING_INFO_BY_COLUMN_SETTINGS,
-  DEFAULT_FILTERS_PARAM_SETTINGS,
-  IFilterAddSettings,
-  IFilterBuilderEditSettings,
-  IFilterCreateSettings,
-  IFilterGroupingInfoListByColumnSettings,
-  IFilterParamSettings,
-  IFilterReplaceParamSettings,
-} from "../resources/filter-functions.resources";
-
-/**
- * Gets a complete settings for the edit filters settings
- * - Fills the missing properties with default ones
- * @param settings the settings
- * @returns the complete settings
- */
-export function getEditFiltersSettings(
-  settings?: IFilterBuilderEditSettings,
-): IFilterBuilderEditSettings {
-  return {
-    automaticId:
-      settings?.automaticId ?? DEFAULT_FILTERS_EDIT_SETTINGS.automaticId,
-    strictValidation:
-      settings?.strictValidation ??
-      DEFAULT_FILTERS_EDIT_SETTINGS.strictValidation,
-  };
-}
-
-/**
- * Gets a complete settings for the filter-create settings
- * @param settings the filter-create settings
- * @returns the complete filter-create settings
- */
-export function getFilterAddSettings(
-  settings?: IFilterAddSettings,
-): IFilterAddSettings {
-  return {
-    automaticId:
-      settings?.automaticId ?? DEFAULT_FILTER_ADD_SETTINGS.automaticId,
-    automaticOperator:
-      settings?.automaticOperator ??
-      DEFAULT_FILTER_ADD_SETTINGS.automaticOperator,
-  };
-}
-
-/**
- * Gets a complete settings for the filter-create settings
- * @param settings the filter-create settings
- * @returns the complete filter-create settings
- */
-export function getFilterCreateSettings(
-  settings?: IFilterCreateSettings,
-): IFilterCreateSettings {
-  return {
-    automaticId:
-      settings?.automaticId ?? DEFAULT_FILTER_CREATE_SETTINGS.automaticId,
-    rawValues: settings?.rawValues ?? DEFAULT_FILTER_CREATE_SETTINGS.rawValues,
-    strictValidation:
-      settings?.strictValidation ??
-      DEFAULT_FILTER_CREATE_SETTINGS.strictValidation,
-    ...getInfoGroupingsByColumnTypeSettings(settings),
-  };
-}
-
-/**
- * Gets a complete settings for the info grouping by column settings
- * - Fills the missing properties with default ones
- * @param settings the settings
- * @returns the complete settings
- */
-export function getInfoGroupingsByColumnTypeSettings(
-  settings?: IFilterGroupingInfoListByColumnSettings,
-): IFilterGroupingInfoListByColumnSettings {
-  return {
-    hasDateTime:
-      settings?.hasDateTime ??
-      DEFAULT_FILTERS_GROUPING_INFO_BY_COLUMN_SETTINGS.hasDateTime,
-    hasDistinctDate:
-      settings?.hasDistinctDate ??
-      DEFAULT_FILTERS_GROUPING_INFO_BY_COLUMN_SETTINGS.hasDistinctDate,
-    hasDistinctDateTime:
-      settings?.hasDistinctDateTime ??
-      DEFAULT_FILTERS_GROUPING_INFO_BY_COLUMN_SETTINGS.hasDistinctDateTime,
-    hasImageUploadAnalysis:
-      settings?.hasImageUploadAnalysis ??
-      DEFAULT_FILTERS_GROUPING_INFO_BY_COLUMN_SETTINGS.hasImageUploadAnalysis,
-    isExpressionCategorizable:
-      settings?.isExpressionCategorizable ??
-      DEFAULT_FILTERS_GROUPING_INFO_BY_COLUMN_SETTINGS.isExpressionCategorizable,
-  };
-}
-
-/**
- * Gets a complete settings for the param settings
- * - Fills the missing properties with default ones
- * @param settings the settings
- * @returns the complete settings
- */
-export function getParamFiltersSettings(
-  settings?: IFilterParamSettings,
-): IFilterParamSettings {
-  return {
-    letPassUndefinedParams:
-      settings?.letPassUndefinedParams ??
-      DEFAULT_FILTERS_PARAM_SETTINGS.letPassUndefinedParams,
-    letPassUndefinedProperties:
-      settings?.letPassUndefinedProperties ??
-      DEFAULT_FILTERS_PARAM_SETTINGS.letPassUndefinedProperties,
-    removeEmptyArrays:
-      settings?.removeEmptyArrays ??
-      DEFAULT_FILTERS_PARAM_SETTINGS.removeEmptyArrays,
-  };
-}
-
-/**
- * Gets a complete settings for the replaceByParams settings
- * - Fills the missing properties with default ones
- * @param settings the settings
- * @returns the complete settings
- */
-export function getReplaceByParamsSettings(
-  settings?: IFilterReplaceParamSettings,
-): IFilterReplaceParamSettings {
-  return {
-    ...settings,
-    automaticOperator: settings?.automaticOperator ?? false,
-    addingInSameIndex: settings?.addingInSameIndex ?? false,
-  };
-}

package/src/helpers/filter-validators.helpers.ts

@@ -1,15 +0,0 @@
-import {
-  FILTER_VALIDATOR,
-  IFilterValidator,
-} from "../resources/filter-validators.resources";
-
-/**
- * Checks if the given validator is a Null type.
- * @param validator The Filter Validator
- * @returns True: It is a Null Validator
- */
-export function isNullValidator(validator: IFilterValidator): boolean {
-  return [FILTER_VALIDATOR.IS_NOT_NULL, FILTER_VALIDATOR.IS_NULL].includes(
-    validator,
-  );
-}

package/src/helpers/getFilterId.ts

@@ -1,35 +0,0 @@
-import { isEmpty, isObject } from "@qrvey/utils";
-
-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 function getFilterId(filter: IFilter, index?: number): string {
-  if (isEmpty(filter) || !isObject(filter)) return "";
-
-  const filterId: string[] = [];
-  if (!isEmpty(filter.scope)) filterId.push(filter.scope.toLowerCase());
-  if (!isEmpty(filter.scopeId)) filterId.push(filter.scopeId!);
-  if (!isEmpty(filter.datasetId)) filterId.push(filter.datasetId);
-  if (!isEmpty(filter.columnId)) filterId.push(filter.columnId);
-  if (!isEmpty(filter.validator)) filterId.push(filter.validator.toLowerCase());
-  if (!isEmpty(filter.grouping)) filterId.push(filter.grouping!.toLowerCase());
-  if (!isEmpty(filter.aggregateType))
-    filterId.push(filter.aggregateType!.toLowerCase());
-  if (!isEmpty(index)) filterId.push(index!.toString());
-
-  return filterId.length > 0 ? filterId.join("|") : "";
-}

package/src/helpers/getFilterType.ts

@@ -1,23 +0,0 @@
-import { COLUMN, IColumnType } from "@qrvey/utils";
-
-import { IFilterValidator } from "../resources/filter-validators.resources";
-import {
-  FILTER_TYPE,
-  FILTER_TYPE_BY_VALIDATOR,
-  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 function getFilterType(
-  columnType: IColumnType,
-  validator: IFilterValidator,
-): IFilterType {
-  if (columnType === COLUMN.RANKING) return FILTER_TYPE.RANKING;
-
-  return FILTER_TYPE_BY_VALIDATOR[validator];
-}

package/src/helpers/index.ts

@@ -1,6 +0,0 @@
-export * from "./filter-adapt.helpers";
-export * from "./filter-settings.helpers";
-export * from "./getFilterId";
-export * from "./getFilterType";
-export * from "./resolveFilterConditions";
-export * from "./utils.helpers";

package/src/helpers/resolveFilterConditions.ts

@@ -1,29 +0,0 @@
-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 function resolveFilterConditions(
-  filter: IFilter,
-  params: Partial<IFilter>,
-  settings: IFilterParamSettings,
-): boolean {
-  const paramKeys = (Object.keys(params) as (keyof IFilter)[]) || [];
-
-  let condition = true;
-  for (let i = 0; i < paramKeys.length; i++) {
-    const paramKey = paramKeys[i];
-    condition =
-      (settings.letPassUndefinedProperties && filter[paramKey] == null) ||
-      (settings.letPassUndefinedParams && params[paramKey] == null) ||
-      params[paramKey] === filter[paramKey];
-
-    if (!condition) break;
-  }
-  return condition;
-}

package/src/helpers/utils.helpers.ts

@@ -1,37 +0,0 @@
-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 function getColumnInfo(
-  ids: { columnId: string; datasetId: string },
-  datasets: IDataset[] = [],
-): IColumn | undefined {
-  const datasetInfo: IDataset | undefined = 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: { columnId: string; datasetId: string },
-  datasets: IDataset[] = [],
-): IDataset | undefined {
-  if (ids == null || !Array.isArray(datasets)) return;
-
-  return datasets?.find((dInfo) => dInfo.qrveyid === ids.datasetId);
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from "./classes";
-export * from "./helpers";
-export * from "./models";
-export * from "./resources";

package/src/models/filter-builder.models.ts

@@ -1,256 +0,0 @@
-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[];
-}

package/src/models/filter-resources.models.ts

@@ -1,89 +0,0 @@
-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[];
-}

package/src/models/filter-searcher.models.ts

@@ -1,61 +0,0 @@
-import { 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;
-}