@qrvey/filters 0.0.44 → 0.1.0

package/src/resources/filters.resources.ts

@@ -1,232 +0,0 @@
-import {
-  COLUMN,
-  IAggregateType,
-  IColumnType,
-  IFormulaType,
-  IFUData,
-} from "@qrvey/utils";
-
-import { IFilterGrouping } from "./filter-grouping.resources";
-import { IFilterLogic } from "./filter-logic.resources";
-import { FILTER_OPERATOR, IFilterOperator } from "./filter-operators.resources";
-import { IFilterPanelInteractiveTable } from "./filter-panel.interfaces";
-import { FILTER_SCOPE, IFilterScope } from "./filter-scopes.resources";
-import {
-  FILTER_VALIDATOR,
-  IFilterValidator,
-} from "./filter-validators.resources";
-import { IFilterValue } from "./filter-values.resources";
-import { IFilterVisual } from "./filter-visual.resources";
-
-export type IFilterType = FILTER_TYPE;
-
-export type IFilterTypeByValidator = { [key in IFilterValidator]: IFilterType };
-
-/**
- * The filter structure
- */
-export interface IFilter {
-  /**
-   * The aggregate type for the column
-   */
-  aggregateType?: IAggregateType;
-  /**
-   * Flag to collapse the filter
-   */
-  collapsed: boolean;
-  /**
-   * The column ID
-   */
-  columnId: string;
-  /**
-   * The column Type
-   */
-  columnType: IColumnType;
-  /**
-   * Custom label for this filter
-   */
-  customLabel?: string;
-  /**
-   * Dataset ID
-   */
-  datasetId: string;
-  /**
-   * Flag to allow deleting filter
-   */
-  deletable: boolean;
-  /**
-   * Flag to display the filter.
-   * Filters are applied anyway.
-   */
-  displayed: boolean;
-  /**
-   * Flag to allow editing filter
-   */
-  editable: boolean;
-  /**
-   * Flag to apply the filters
-   */
-  enabled: boolean;
-  /**
-   * Flag to allow enabling filter
-   */
-  enableable: boolean;
-  /**
-   * More information for this filter
-   */
-  extras?: Record<string, unknown>;
-  /**
-   * Optional property for the formula type
-   */
-  formulaType?: IFormulaType;
-  /**
-   * Index of the selected Lookup display.
-   * It is mandatory for Lookup column type.
-   */
-  lookupDisplayIndex?: number;
-  /**
-   * Grouping types. Related property for some columns (Date group|Complex Data types)
-   */
-  grouping?: IFilterGrouping;
-  /**
-   * A custom icon for the filter
-   */
-  icon?: string;
-  /**
-   * A custom tooltip for the filter icon
-   */
-  iconTooltip?: string;
-  /**
-   * The Filter ID
-   */
-  id: string;
-  /**
-   * Related operator for this and the next filter. i.e: F1 AND F2
-   */
-  operator: IFilterOperator;
-  /**
-   * Flag to determine the complete selection of values
-   */
-  selectAll?: boolean;
-  /**
-   * The Scope type
-   */
-  scope: IFilterScope;
-  /**
-   * The scope ID
-   */
-  scopeId?: string;
-  /**
-   * Validation Type to operate the filter values
-   */
-  validator: IFilterValidator;
-  /**
-   * Collection of Values.
-   * Depending on the selected validator it changes.
-   * An activated Select All could recieve an empty or undefined values
-   */
-  values?: IFilterValue[];
-}
-
-/**
- * The structure for the filter version and its version
- */
-export interface IFilterVersion<
-  TVersionNumber extends IFilterVersionNumber = IFilterVersionNumber,
-> {
-  version: TVersionNumber;
-  filters?: IFilterVersionMap[TVersionNumber];
-  settings?: IFilterPanelInteractiveTable;
-}
-
-/**
- * Type for the Filter version
- */
-export type IFilterVersionNumber = FILTER_VERSION_TYPE;
-
-/**
- * Enumeration for the Filter version types
- */
-export enum FILTER_VERSION_TYPE {
-  LOGIC = "LOGIC",
-  UI_2 = "UI_2",
-  V3 = "V3",
-  UI_3 = "UI_3",
-}
-
-/**
- * Mapping for the Filter version and its structure
- */
-interface IFilterVersionMap {
-  [FILTER_VERSION_TYPE.LOGIC]: IFilterLogic[];
-  [FILTER_VERSION_TYPE.UI_2]: IFUData;
-  [FILTER_VERSION_TYPE.V3]: IFilter[];
-  [FILTER_VERSION_TYPE.UI_3]: IFilterVisual;
-}
-
-/**
- * The Default Filter object
- */
-export const DEFAULT_FILTER: IFilter = {
-  aggregateType: undefined,
-  collapsed: true,
-  columnId: "",
-  columnType: COLUMN.TEXTFIELD,
-  customLabel: undefined,
-  datasetId: "",
-  deletable: true,
-  displayed: true,
-  editable: true,
-  enabled: true,
-  enableable: true,
-  extras: undefined,
-  grouping: undefined,
-  icon: undefined,
-  iconTooltip: undefined,
-  id: "",
-  lookupDisplayIndex: undefined,
-  operator: FILTER_OPERATOR.AND,
-  selectAll: false,
-  scope: FILTER_SCOPE.GLOBAL,
-  scopeId: undefined,
-  validator: FILTER_VALIDATOR.EQUALS,
-  values: [],
-};
-
-/**
- * Enumeration for the filter type
- */
-export enum FILTER_TYPE {
-  REGULAR = "REGULAR",
-  RANGE = "RANGE",
-  RELATIVE = "RELATIVE",
-  RANKING = "RANKING",
-  NULL = "NULL",
-}
-
-/**
- *
- */
-export const FILTER_TYPE_BY_VALIDATOR: IFilterTypeByValidator = {
-  [FILTER_VALIDATOR.AFTER]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.AFTER_ON]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.BEFORE]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.BEFORE_ON]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.BETWEEN_EXCLUSIVE]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.BETWEEN_INCLUSIVE]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.CONTAINS]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.ENDS_WITH]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.EQUALS]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.GREATER_THAN]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.GREATER_THAN_EQUAL]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.IN]: FILTER_TYPE.RELATIVE,
-  [FILTER_VALIDATOR.IS_NOT_NULL]: FILTER_TYPE.NULL,
-  [FILTER_VALIDATOR.IS_NULL]: FILTER_TYPE.NULL,
-  [FILTER_VALIDATOR.LESS_THAN]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.LESS_THAN_EQUAL]: FILTER_TYPE.RANGE,
-  [FILTER_VALIDATOR.NOT_CONTAIN]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.NOT_END_WITH]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.NOT_EQUAL]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.NOT_START_WITH]: FILTER_TYPE.REGULAR,
-  [FILTER_VALIDATOR.STARTS_WITH]: FILTER_TYPE.REGULAR,
-};

package/src/resources/index.ts

@@ -1,10 +0,0 @@
-export * from "./filter-functions.resources";
-export * from "./filter-grouping.resources";
-export * from "./filter-logic.resources";
-export * from "./filter-operators.resources";
-export * from "./filter-panel.interfaces";
-export * from "./filter-scopes.resources";
-export * from "./filter-validators.resources";
-export * from "./filter-values.resources";
-export * from "./filter-visual.resources";
-export * from "./filters.resources";

package/tests/classes/FilterAdapter.test.ts

@@ -1,124 +0,0 @@
-import { FilterAdapter } from "../../src/classes/FilterAdapter";
-import {
-  FILTER_VERSION_TYPE,
-  IFilterVersion,
-} from "../../src/resources/filters.resources";
-import { __datasets1 } from "../mock/datasets.mock";
-import {
-  __legacyVisualFilters1,
-  __legacyVisualFilters2,
-  __logicFilters1,
-  __logicFilters2,
-  __v3Filters1,
-  __v3Filters2,
-  __visualFilters1,
-  __visualFilters2,
-} from "../mock/filters-adapter.mock";
-import { __interactiveTable1 } from "../mock/filters-interactive-table.mock";
-import { __mockFilters1, __mockFilters5 } from "../mock/filters.mock";
-
-describe("Testing wrong arguments", () => {
-  const emptyFilters: IFilterVersion<FILTER_VERSION_TYPE.V3> = {
-    version: FILTER_VERSION_TYPE.V3,
-    filters: [],
-  };
-  test("Undefined argument", () => {
-    const adapter = new FilterAdapter(undefined);
-    expect(adapter.filters).toEqual(emptyFilters);
-  });
-
-  test("Null argument", () => {
-    // @ts-expect-error: Expected wrong params
-    const adapter = new FilterAdapter(null);
-    expect(adapter.filters).toEqual(emptyFilters);
-  });
-
-  test("Boolean argument", () => {
-    // @ts-expect-error: Expected wrong params
-    const adapter = new FilterAdapter(false);
-    expect(adapter.filters).toEqual(emptyFilters);
-  });
-
-  test("Numeric argument", () => {
-    // @ts-expect-error: Expected wrong params
-    const adapter = new FilterAdapter(0);
-    expect(adapter.filters).toEqual(emptyFilters);
-  });
-
-  test("String argument", () => {
-    // @ts-expect-error: Expected wrong params
-    const adapter = new FilterAdapter("Sales");
-    expect(adapter.filters).toEqual(emptyFilters);
-  });
-
-  test("Function-like argument", () => {
-    // @ts-expect-error: Expected wrong params
-    const adapter = new FilterAdapter(() => "Hola");
-    expect(adapter.filters).toEqual(emptyFilters);
-  });
-});
-
-describe("Adapting Filters 1", () => {
-  let adapter: FilterAdapter;
-  beforeEach(() => {
-    adapter = new FilterAdapter();
-  });
-
-  test("Setting the configuration", () => {
-    adapter.setFilters(__mockFilters1);
-    adapter.setDatasets(__datasets1);
-    adapter.setInteractiveTable(__interactiveTable1);
-
-    const legacy = adapter.legacyVisual;
-    const v3 = adapter.filters;
-    const logic = adapter.logic;
-    const visual = adapter.visual;
-
-    expect(legacy).toEqual(__legacyVisualFilters1);
-    expect(v3).toEqual(__v3Filters1);
-    expect(logic).toEqual(__logicFilters1);
-    expect(visual).toEqual(__visualFilters1);
-  });
-});
-
-describe("Adapting Filters 2", () => {
-  let adapter: FilterAdapter;
-  beforeEach(() => {
-    adapter = new FilterAdapter(
-      __mockFilters1,
-      __datasets1,
-      __interactiveTable1,
-    );
-  });
-
-  test("Getting the adapted filters", () => {
-    const legacy = adapter.legacyVisual;
-    const v3 = adapter.filters;
-    const logic = adapter.logic;
-    const visual = adapter.visual;
-
-    expect(legacy).toEqual(__legacyVisualFilters1);
-    expect(v3).toEqual(__v3Filters1);
-    expect(logic).toEqual(__logicFilters1);
-    expect(visual).toEqual(__visualFilters1);
-  });
-});
-
-describe("Adapting Filters 3 - Existed Filter Formulas", () => {
-  let adapter: FilterAdapter;
-  beforeEach(() => {
-    adapter = new FilterAdapter(__mockFilters5, [], __interactiveTable1);
-  });
-
-  test("Getting the adapted filters", () => {
-    const legacy = adapter.legacyVisual;
-    const v3 = adapter.filters;
-    const logic = adapter.logic;
-    const visual = adapter.visual;
-
-    expect(legacy).toEqual(__legacyVisualFilters2);
-    expect(v3).toEqual(__v3Filters2);
-    expect(logic).toEqual(__logicFilters2);
-    expect(visual).toEqual(__visualFilters2);
-  });
-});