@qrvey/filters 0.0.45 → 0.1.0

package/dist/cjs/resources/filters.resources.js

@@ -5,9 +5,6 @@ const utils_1 = require("@qrvey/utils");
 const filter_operators_resources_1 = require("./filter-operators.resources");
 const filter_scopes_resources_1 = require("./filter-scopes.resources");
 const filter_validators_resources_1 = require("./filter-validators.resources");
-/**
- * Enumeration for the Filter version types
- */
 var FILTER_VERSION_TYPE;
 (function (FILTER_VERSION_TYPE) {
     FILTER_VERSION_TYPE["LOGIC"] = "LOGIC";
@@ -15,9 +12,6 @@ var FILTER_VERSION_TYPE;
     FILTER_VERSION_TYPE["V3"] = "V3";
     FILTER_VERSION_TYPE["UI_3"] = "UI_3";
 })(FILTER_VERSION_TYPE || (exports.FILTER_VERSION_TYPE = FILTER_VERSION_TYPE = {}));
-/**
- * The Default Filter object
- */
 exports.DEFAULT_FILTER = {
     aggregateType: undefined,
     collapsed: true,
@@ -43,9 +37,6 @@ exports.DEFAULT_FILTER = {
     validator: filter_validators_resources_1.FILTER_VALIDATOR.EQUALS,
     values: [],
 };
-/**
- * Enumeration for the filter type
- */
 var FILTER_TYPE;
 (function (FILTER_TYPE) {
     FILTER_TYPE["REGULAR"] = "REGULAR";
@@ -54,9 +45,6 @@ var FILTER_TYPE;
     FILTER_TYPE["RANKING"] = "RANKING";
     FILTER_TYPE["NULL"] = "NULL";
 })(FILTER_TYPE || (exports.FILTER_TYPE = FILTER_TYPE = {}));
-/**
- *
- */
 exports.FILTER_TYPE_BY_VALIDATOR = {
     [filter_validators_resources_1.FILTER_VALIDATOR.AFTER]: FILTER_TYPE.RANGE,
     [filter_validators_resources_1.FILTER_VALIDATOR.AFTER_ON]: FILTER_TYPE.RANGE,

package/dist/cjs/resources/index.js

@@ -1,26 +1,14 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./filter-functions.resources"), exports);
-__exportStar(require("./filter-grouping.resources"), exports);
-__exportStar(require("./filter-logic.resources"), exports);
-__exportStar(require("./filter-operators.resources"), exports);
-__exportStar(require("./filter-panel.interfaces"), exports);
-__exportStar(require("./filter-scopes.resources"), exports);
-__exportStar(require("./filter-validators.resources"), exports);
-__exportStar(require("./filter-values.resources"), exports);
-__exportStar(require("./filter-visual.resources"), exports);
-__exportStar(require("./filters.resources"), exports);
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./filter-functions.resources"), exports);
+tslib_1.__exportStar(require("./filter-grouping.resources"), exports);
+tslib_1.__exportStar(require("./filter-logic.resources"), exports);
+tslib_1.__exportStar(require("./filter-operators.resources"), exports);
+tslib_1.__exportStar(require("./filter-panel.interfaces"), exports);
+tslib_1.__exportStar(require("./filter-scopes.resources"), exports);
+tslib_1.__exportStar(require("./filter-validators.resources"), exports);
+tslib_1.__exportStar(require("./filter-values.resources"), exports);
+tslib_1.__exportStar(require("./filter-verbose.resources"), exports);
+tslib_1.__exportStar(require("./filter-visual.resources"), exports);
+tslib_1.__exportStar(require("./filters.resources"), exports);

package/dist/classes/FilterAdapter.d.ts

@@ -1,107 +1,27 @@
 import { IDataset, IFUData } from "@qrvey/utils";
 import { IFilterPanelInteractiveTable, IFilterUIToFilter } from "../resources/filter-panel.interfaces";
 import { FILTER_VERSION_TYPE, IFilter, IFilterVersion } from "../resources/filters.resources";
-/**
- * Class to adapt the filters
- */
 export declare class FilterAdapter {
     protected _filters: IFilter[];
     protected datasets: IDataset[];
     protected interactiveTable?: IFilterPanelInteractiveTable | undefined;
-    /**
-     * The Logic filters
-     */
     private _logic?;
-    /**
-     * The visual filters
-     */
     private _visual?;
-    /**
-     * The old Filter Data structure
-     */
     private _legacyVisual?;
-    /**
-     * Constructor
-     * @param _filters the collection of filters
-     * @param datasets the collection of datasets info
-     * @param interactiveTable table of interaction properties for each section
-     */
     constructor(_filters?: IFilter[], datasets?: IDataset[], interactiveTable?: IFilterPanelInteractiveTable | undefined);
-    /**
-     *
-     */
     private sync;
-    /**
-     * Generates a visual filter structure from the filter collection.
-     * @returns a visual Filter structure
-     */
     private filterToLegacyVisual;
-    /**
-     * Generates a logic filters structure from the filter collection.
-     * @returns the Logic Filters
-     */
     private filterToLogic;
-    /**
-     * Generates a visual filter structure from the filter collection.
-     * @returns a visual Filter structure
-     */
     private filterToVisual;
-    /**
-     * Generates the filter collection from the legacy filter
-     * @param legacyVisual the legacy filter
-     * @param interactiveTable the interactive table object
-     * @returns the filter collection
-     */
     static legacyVisualToFilter(legacyVisual: IFUData, interactiveTable?: IFilterPanelInteractiveTable): IFilterUIToFilter;
-    /**
-     * Gets the legacy filter version attribute
-     * @returns the legacy filter version
-     */
     get legacyVisual(): IFilterVersion<FILTER_VERSION_TYPE.UI_2>;
-    /**
-     * Gets the filter logic version
-     * @returns the filter logic version
-     */
     get logic(): IFilterVersion<FILTER_VERSION_TYPE.LOGIC>;
-    /**
-     * Gets the visual filter version
-     * @returns the visual filter version
-     */
     get visual(): IFilterVersion<FILTER_VERSION_TYPE.UI_3>;
-    /**
-     * Gets the filter version 3
-     * @returns the filter version 3
-     */
     get filters(): IFilterVersion<FILTER_VERSION_TYPE.V3>;
-    /**
-     * Sets the datasets atribute
-     * @param datasets the collection of dataset info
-     */
     setDatasets(datasets?: IDataset[]): void;
-    /**
-     * Sets the collection of filters atribute
-     * @param filters the filters
-     */
     setFilters(filters: IFilter[]): void;
-    /**
-     * Sets the table of interactive table attribute
-     * @param interactiveTable table of interaction properties for each section
-     */
     setInteractiveTable(interactiveTable: IFilterPanelInteractiveTable): void;
-    /**
-     * Sets the filter legacy visual attribute
-     * @param legacyVisual the legacy visual filters
-     */
     private setLegacyVisual;
-    /**
-     * Sets the filter logic attribute
-     * @param logic the logic filters
-     */
     private setLogic;
-    /**
-     * Sets the filter visual attribute
-     * @param visual the visual filters
-     */
     private setVisual;
 }
-//# sourceMappingURL=FilterAdapter.d.ts.map

package/dist/classes/FilterAdapter.js

@@ -2,72 +2,33 @@ import { filterToVisual } from "../helpers/filter-adapt.helpers";
 import { filterToLegacyVisual, legacyVisualToFilter, legacyVisualToInteractiveTable, } from "../helpers/filter-adapt.legacy.helpers";
 import { filterToLogic } from "../helpers/filter-adapt.logic.helpers";
 import { FILTER_VERSION_TYPE, } from "../resources/filters.resources";
-/**
- * Class to adapt the filters
- */
 export class FilterAdapter {
     _filters;
     datasets;
     interactiveTable;
-    /**
-     * The Logic filters
-     */
     _logic;
-    /**
-     * The visual filters
-     */
     _visual;
-    /**
-     * The old Filter Data structure
-     */
     _legacyVisual;
-    /**
-     * Constructor
-     * @param _filters the collection of filters
-     * @param datasets the collection of datasets info
-     * @param interactiveTable table of interaction properties for each section
-     */
     constructor(_filters = [], datasets = [], interactiveTable) {
         this._filters = _filters;
         this.datasets = datasets;
         this.interactiveTable = interactiveTable;
         this.setFilters(Array.isArray(_filters) ? _filters : []);
     }
-    /**
-     *
-     */
     sync() {
         this.setVisual(this.filterToVisual());
         this.setLegacyVisual(this.filterToLegacyVisual());
         this.setLogic(this.filterToLogic());
     }
-    /**
-     * Generates a visual filter structure from the filter collection.
-     * @returns a visual Filter structure
-     */
     filterToLegacyVisual() {
         return filterToLegacyVisual(this._filters, this.datasets, this.interactiveTable);
     }
-    /**
-     * Generates a logic filters structure from the filter collection.
-     * @returns the Logic Filters
-     */
     filterToLogic() {
         return filterToLogic(this._filters);
     }
-    /**
-     * Generates a visual filter structure from the filter collection.
-     * @returns a visual Filter structure
-     */
     filterToVisual() {
         return filterToVisual(this._filters, this.datasets, this.interactiveTable);
     }
-    /**
-     * Generates the filter collection from the legacy filter
-     * @param legacyVisual the legacy filter
-     * @param interactiveTable the interactive table object
-     * @returns the filter collection
-     */
     static legacyVisualToFilter(legacyVisual, interactiveTable) {
         const filters = legacyVisualToFilter(legacyVisual);
         const newInteractiveTable = legacyVisualToInteractiveTable(legacyVisual, interactiveTable);
@@ -76,88 +37,48 @@ export class FilterAdapter {
             interactiveTable: newInteractiveTable,
         };
     }
-    /**
-     * Gets the legacy filter version attribute
-     * @returns the legacy filter version
-     */
     get legacyVisual() {
         return {
             filters: this._legacyVisual,
             version: FILTER_VERSION_TYPE.UI_2,
         };
     }
-    /**
-     * Gets the filter logic version
-     * @returns the filter logic version
-     */
     get logic() {
         return {
             filters: this._logic,
             version: FILTER_VERSION_TYPE.LOGIC,
         };
     }
-    /**
-     * Gets the visual filter version
-     * @returns the visual filter version
-     */
     get visual() {
         return {
             filters: this._visual,
             version: FILTER_VERSION_TYPE.UI_3,
         };
     }
-    /**
-     * Gets the filter version 3
-     * @returns the filter version 3
-     */
     get filters() {
         return {
-            filters: this._filters ?? [],
+            filters: this._filters,
             version: FILTER_VERSION_TYPE.V3,
         };
     }
-    /**
-     * Sets the datasets atribute
-     * @param datasets the collection of dataset info
-     */
     setDatasets(datasets = []) {
         this.datasets = datasets;
         this.sync();
     }
-    /**
-     * Sets the collection of filters atribute
-     * @param filters the filters
-     */
     setFilters(filters) {
         this._filters = filters;
         this.sync();
     }
-    /**
-     * Sets the table of interactive table attribute
-     * @param interactiveTable table of interaction properties for each section
-     */
     setInteractiveTable(interactiveTable) {
         this.interactiveTable = interactiveTable;
         this.sync();
     }
-    /**
-     * Sets the filter legacy visual attribute
-     * @param legacyVisual the legacy visual filters
-     */
     setLegacyVisual(legacyVisual) {
         this._legacyVisual = legacyVisual;
     }
-    /**
-     * Sets the filter logic attribute
-     * @param logic the logic filters
-     */
     setLogic(logic) {
         this._logic = logic;
     }
-    /**
-     * Sets the filter visual attribute
-     * @param visual the visual filters
-     */
     setVisual(visual) {
         this._visual = visual;
     }

package/dist/classes/FilterBuilder.d.ts

@@ -1,206 +1,31 @@
 import { IFilterBuilderAdd, IFilterBuilderAddValue, IFilterBuilderDelete, IFilterBuilderDeleteValue, IFilterBuilderEdit, IFilterBuilderEditValue, IFilterBuilderMerge, IFilterBuilderMergeValue, IFilterBuilderMultipleReturn, IFilterBuilderSet, IFilterBuilderSingleReturn } from "../models/filter-builder.models";
+import { IFilterSearchEngine } from "../models/filter-searcher.models";
 import { IFilterAddSettings, IFilterBuilderEditSettings, IFilterCreateSettings, IFilterMergeSettings, IFilterParamSettings, IFilterReplaceParamSettings } from "../resources/filter-functions.resources";
 import { IFilterValue } from "../resources/filter-values.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Class to build new filters and manipulate ones.
- */
 export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderAddValue, IFilterBuilderDelete, IFilterBuilderDeleteValue, IFilterBuilderEdit, IFilterBuilderEditValue, IFilterBuilderMerge, IFilterBuilderMergeValue, IFilterBuilderSet {
     protected filters: IFilter[];
-    /**
-     * Instance to search filters
-     */
     private searchEngine;
-    /**
-     * Constructor
-     * @param filters the collection of filters
-     */
-    constructor(filters?: IFilter[]);
-    /**
-     * **************************************************************************************************
-     ****************************************** Adding **************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Adds various filter into the collection.
-     * Inserts them next to the last similar filter
-     * @param newFilters 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
-     */
+    constructor(filters?: IFilter[], searchEngine?: IFilterSearchEngine);
     addMultiple(newFilters: IFilter[], inIndexes?: number[], settings?: IFilterAddSettings): IFilterBuilderMultipleReturn;
-    /**
-     * Adds one filter into the collection.
-     * - Inserts it next to the last similar filter
-     * - If the new one is match with the last similar filter, the operator will change to OR
-     * - If the id is not provided, a new one is created.
-     * - If the inIndex nunber is provided, this will be the index where the filter is inserted
-     * @param filter the filter to add
-     * @param inIndex the index to add the new filter
-     * @param settings settings object to setup this function
-     * @returns the new collection of filters
-     */
     addSingle(filter: IFilter, inIndex?: number, settings?: IFilterAddSettings): IFilterBuilderSingleReturn;
-    /**
-     * Adds one value from filter
-     * @param id the ID to search the filter to add value
-     * @param value the value to add
-     * @returns the new filter collection
-     */
     addValue(id: string, value: IFilterValue): IFilterBuilderSingleReturn;
-    /**
-     * Adds various values on filter
-     * @param id the ID to search the filter to add value
-     * @param values the collection of value to add
-     * @returns the new filter collection
-     */
     addValues(id: string, values: IFilterValue[]): IFilterBuilderSingleReturn;
-    /**
-     * **************************************************************************************************
-     **************************************** Deleting **************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * 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
-     */
     deleteByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): IFilterBuilderMultipleReturn;
-    /**
-     * 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;
-    /**
-     * 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 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;
-    /**
-     * **************************************************************************************************
-     ****************************************** Editing *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Edits various filters from the collection
-     * @param ids the collection of IDs to search filters to edit
-     * @param filters a collection of object with properties to edit
-     * @param settings settings object for the function
-     * @returns the new filter collection
-     */
     editMultiple(ids: string[], filters: Partial<IFilter>[], settings?: IFilterBuilderEditSettings): IFilterBuilderMultipleReturn;
-    /**
-     * Edits one filter from the collection
-     * @param id the ID to search the filter to edit
-     * @param filter an object with properties to edit
-     * @param settings settings object for the function
-     * @returns the new filter collection
-     */
     editSingle(id: string, filter: Partial<IFilter>, settings?: IFilterBuilderEditSettings): IFilterBuilderSingleReturn;
-    /**
-     * 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;
-    /**
-     * **************************************************************************************************
-     ****************************************** Merging *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * 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;
-    /**
-     * 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): IFilterBuilderSingleReturn;
-    /**
-     * **************************************************************************************************
-     ****************************************** Others **************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Builds an filter structure based on given params
-     * @param filter the partial filter params
-     * @param settings the settings object to setup this function
-     * @returns the complete filter structure
-     */
     static createFilter(filter: Partial<IFilter>, settings?: IFilterCreateSettings): IFilter;
-    /**
-     * 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?: IFilterReplaceParamSettings): IFilterBuilderMultipleReturn;
-    /**
-     * Method to sync the Filter instances
-     */
     private sync;
-    /**
-     * **************************************************************************************************
-     ****************************************** Getters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the filter collection
-     * @returns the collection of filters of the context
-     */
     getFilters(): IFilter[];
-    /**
-     * **************************************************************************************************
-     ****************************************** Setters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Sets the filters
-     * @param filters the new collection of filters to set
-     */
     setFilters(filters: IFilter[]): void;
 }
-//# sourceMappingURL=FilterBuilder.d.ts.map