@qrvey/filters 0.0.44 → 0.1.0

package/dist/classes/FilterBuilder.js

@@ -2,58 +2,30 @@ import { isEmpty, isNaNV2, objectCopy } from "@qrvey/utils";
 import { FilterSearcher } from "./FilterSearcher";
 import { FilterValidation } from "./FilterValidation";
 import { FilterValues } from "./FilterValues";
+import { getFilterGrouping } from "../helpers/filter-builder.helpers";
 import { getEditFiltersSettings, getFilterAddSettings, getFilterCreateSettings, getReplaceByParamsSettings, } from "../helpers/filter-settings.helpers";
 import { getFilterId } from "../helpers/getFilterId";
 import { getFilterType } from "../helpers/getFilterType";
 import { FILTER_OPERATOR } from "../resources/filter-operators.resources";
 import { DEFAULT_FILTER, FILTER_TYPE, } from "../resources/filters.resources";
-import { getFilterGrouping } from "../helpers/filter-builder.helpers";
-/**
- * Class to build new filters and manipulate ones.
- */
 export class FilterBuilder {
     filters;
-    /**
-     * Instance to search filters
-     */
     searchEngine;
-    /**
-     * Constructor
-     * @param filters the collection of filters
-     */
-    constructor(filters = []) {
+    constructor(filters = [], searchEngine) {
         this.filters = filters;
-        this.searchEngine = new FilterSearcher(filters);
+        this.searchEngine = searchEngine ?? new FilterSearcher(filters);
         this.filters = objectCopy(Array.isArray(filters) ? filters : []);
+        this.searchEngine.setFilters(this.filters);
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** 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
-     */
     addMultiple(newFilters, inIndexes, settings) {
         if (isEmpty(newFilters))
             return { resulting: this.filters };
         const filters = objectCopy(this.filters);
         const affected = [];
-        try {
-            newFilters.forEach((newFilter, index) => {
-                const affectedFilter = this.addSingle(newFilter, inIndexes?.[index], settings);
-                affected.push(affectedFilter.affected);
-            });
-        }
-        catch (_error) {
-            this.filters = filters;
-            return { resulting: filters };
-        }
+        newFilters.forEach((newFilter, index) => {
+            const affectedFilter = this.addSingle(newFilter, inIndexes?.[index], settings);
+            affected.push(affectedFilter.affected);
+        });
         this.sync();
         return {
             resulting: this.filters,
@@ -61,17 +33,6 @@ export class FilterBuilder {
             original: filters,
         };
     }
-    /**
-     * 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, inIndex, settings) {
         if (isEmpty(filter))
             return { resulting: this.filters };
@@ -114,12 +75,6 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, value) {
         const index = this.searchEngine.findIndexByParams({ id });
         if (index < 0)
@@ -135,28 +90,15 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, values) {
         const index = this.searchEngine.findIndexByParams({ id });
         if (isEmpty(values) || index < 0)
             return { resulting: this.filters };
-        const filters = objectCopy(this.filters);
         const original = objectCopy(this.filters[index]);
         let affected;
-        try {
-            values.forEach((value) => {
-                affected = this.addValue(id, value).affected;
-            });
-        }
-        catch (_error) {
-            this.filters = filters;
-            return { resulting: filters };
-        }
+        values.forEach((value) => {
+            affected = this.addValue(id, value).affected;
+        });
         this.sync();
         return {
             resulting: this.filters,
@@ -164,17 +106,6 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * **************************************************************************************************
-     **************************************** 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, settings) {
         const original = objectCopy(this.filters);
         const affected = this.searchEngine.filterByParams(params, settings);
@@ -186,26 +117,15 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * Removes various filters from the collection
-     * @param ids a collection of ID to search filters to remove
-     * @returns the new filter collection
-     */
     deleteMultiple(ids) {
         if (!Array.isArray(ids))
             return { resulting: this.filters };
         const filters = objectCopy(this.filters);
         const affected = [];
-        try {
-            ids.forEach((id) => {
-                const deleted = this.deleteSingle(id);
-                affected.push(deleted.affected);
-            });
-        }
-        catch (_error) {
-            this.filters = filters;
-            return { resulting: filters };
-        }
+        ids.forEach((id) => {
+            const deleted = this.deleteSingle(id);
+            affected.push(deleted.affected);
+        });
         this.sync();
         return {
             resulting: this.filters,
@@ -213,11 +133,6 @@ export class FilterBuilder {
             original: filters,
         };
     }
-    /**
-     * Removes one filter from the collection
-     * @param id the ID to search the filter to remove
-     * @returns the new filter collection
-     */
     deleteSingle(id) {
         const index = this.searchEngine.findIndexByParams({ id });
         const original = { ...this.filters[index] };
@@ -232,12 +147,6 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, index) {
         if (!Number.isInteger(index))
             return { resulting: this.filters };
@@ -256,30 +165,16 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, indexes) {
         if (!Array.isArray(indexes))
             return { resulting: this.filters };
-        let sortedIndex = indexes.sort();
-        sortedIndex = indexes.reverse();
-        const filters = objectCopy(this.filters);
+        const sortedIndex = indexes.sort().reverse();
         const original = this.searchEngine.findByParams({
             id,
         });
-        try {
-            sortedIndex.forEach((index) => {
-                this.deleteValue(id, index);
-            });
-        }
-        catch (_error) {
-            this.filters = filters;
-            return { resulting: filters };
-        }
+        sortedIndex.forEach((index) => {
+            this.deleteValue(id, index);
+        });
         this.sync();
         const affected = this.searchEngine.findByParams({ id });
         return {
@@ -288,18 +183,6 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** 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, filters, settings) {
         if (!Array.isArray(ids) ||
             !Array.isArray(filters) ||
@@ -307,16 +190,10 @@ export class FilterBuilder {
             return { resulting: this.filters };
         const originalFilters = objectCopy(this.filters);
         const editedFilters = [];
-        try {
-            ids.forEach((id, index) => {
-                const editedFilter = this.editSingle(id, filters[index], settings);
-                editedFilters.push(editedFilter.affected);
-            });
-        }
-        catch (_error) {
-            this.filters = originalFilters;
-            return { resulting: originalFilters };
-        }
+        ids.forEach((id, index) => {
+            const editedFilter = this.editSingle(id, filters[index], settings);
+            editedFilters.push(editedFilter.affected);
+        });
         this.sync();
         return {
             resulting: this.filters,
@@ -324,13 +201,6 @@ export class FilterBuilder {
             original: originalFilters,
         };
     }
-    /**
-     * 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, filter, settings) {
         if (isEmpty(filter))
             return { resulting: this.filters };
@@ -353,13 +223,6 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, value, index) {
         const filterIndex = this.searchEngine.findIndexByParams({ id });
         if (isEmpty(value) ||
@@ -377,29 +240,16 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, values, indexes) {
         const filterIndex = this.searchEngine.findIndexByParams({ id });
         if (isEmpty(values) || filterIndex < 0 || !Array.isArray(indexes))
             return { resulting: this.filters };
         const original = objectCopy(this.filters);
         let finalAffectedFilter;
-        try {
-            values.forEach((value, index) => {
-                const affectedFilter = this.editValue(id, value, indexes[index]);
-                finalAffectedFilter = affectedFilter.affected;
-            });
-        }
-        catch (_error) {
-            this.filters = original;
-            return { resulting: original };
-        }
+        values.forEach((value, index) => {
+            const affectedFilter = this.editValue(id, value, indexes[index]);
+            finalAffectedFilter = affectedFilter.affected;
+        });
         this.sync();
         return {
             resulting: this.filters,
@@ -407,17 +257,6 @@ export class FilterBuilder {
             original: original[filterIndex],
         };
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** 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, settings) {
         if (isEmpty(filter))
             return { resulting: this.filters };
@@ -430,7 +269,7 @@ export class FilterBuilder {
             validator: filter.validator,
         });
         let original = filter;
-        let affected = filter;
+        let affected;
         if (filterIndex > -1) {
             original = objectCopy(this.filters[filterIndex]);
             const { affected: affectedMergeFilter } = this.mergeValues(this.filters[filterIndex].id, filter.values);
@@ -446,27 +285,15 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * 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, settings) {
         if (!Array.isArray(filters) || isEmpty(filters))
             return { resulting: this.filters };
         const originalFilters = objectCopy(this.filters);
         const mergedFilters = [];
-        try {
-            filters.forEach((filter) => {
-                const mergedFilter = this.mergeSingle(filter, settings);
-                mergedFilters.push(mergedFilter.affected);
-            });
-        }
-        catch (_error) {
-            this.filters = originalFilters;
-            return { resulting: originalFilters };
-        }
+        filters.forEach((filter) => {
+            const mergedFilter = this.mergeSingle(filter, settings);
+            mergedFilters.push(mergedFilter.affected);
+        });
         this.sync();
         return {
             resulting: this.filters,
@@ -474,12 +301,6 @@ export class FilterBuilder {
             original: originalFilters,
         };
     }
-    /**
-     * 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, values) {
         const filterIndex = this.searchEngine.findIndexByParams({ id });
         if (isEmpty(values) || filterIndex < 0)
@@ -518,17 +339,6 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** 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, settings) {
         const newSettings = getFilterCreateSettings(settings);
         const newFilter = {
@@ -544,6 +354,7 @@ export class FilterBuilder {
             editable: filter.editable ?? DEFAULT_FILTER.editable,
             enableable: filter.enableable ?? DEFAULT_FILTER.enableable,
             enabled: filter.enabled ?? DEFAULT_FILTER.enabled,
+            formulaType: filter.formulaType ?? DEFAULT_FILTER.formulaType,
             id: filter.id || "",
             operator: filter.operator || DEFAULT_FILTER.operator,
             scope: filter.scope || DEFAULT_FILTER.scope,
@@ -561,14 +372,6 @@ export class FilterBuilder {
         }
         return newFilter;
     }
-    /**
-     * 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, params, settings) {
         const original = objectCopy(this.filters);
         const newSettings = getReplaceByParamsSettings(settings);
@@ -588,33 +391,12 @@ export class FilterBuilder {
             original,
         };
     }
-    /**
-     * Method to sync the Filter instances
-     */
     sync() {
         this.searchEngine.setFilters(this.filters);
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** Getters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the filter collection
-     * @returns the collection of filters of the context
-     */
     getFilters() {
         return this.filters;
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** Setters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Sets the filters
-     * @param filters the new collection of filters to set
-     */
     setFilters(filters) {
         this.filters = objectCopy(filters);
         this.sync();

package/dist/classes/FilterManager.d.ts

@@ -4,81 +4,26 @@ import { FilterBuilder } from "./FilterBuilder";
 import { FilterSearcher } from "./FilterSearcher";
 import { IFilterPanelInteractiveTable } from "../resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Class to manage the filters
- */
+interface IFilterManagerDependencies {
+    adapt?: FilterAdapter;
+    builder?: FilterBuilder;
+    searchEngine?: FilterSearcher;
+}
 export declare class FilterManager {
     protected _filters: IFilter[];
     protected datasets: IDataset[];
     private _interactiveTable?;
-    /**
-     * Instance to adapt filters
-     */
     private _adapt;
-    /**
-     * Instance to build filters
-     */
     private _builder;
-    /**
-     * Instance to search filters
-     */
     private _searchEngine;
-    /**
-     * 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);
-    /**
-     * **************************************************************************************************
-     ****************************************** Getters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the adapt methods
-     * @returns the adapt methods
-     */
+    constructor(_filters?: IFilter[], datasets?: IDataset[], _interactiveTable?: IFilterPanelInteractiveTable | undefined, dependencies?: IFilterManagerDependencies);
     get adapt(): FilterAdapter;
-    /**
-     * Gets the builder methods
-     * @returns the builder methods
-     */
     get builder(): FilterBuilder;
-    /**
-     * Gets the filter collections
-     * @returns the filters
-     */
     get filters(): IFilter[];
-    /**
-     * Gets the interactive table
-     * @returns the interactive table
-     */
     get interactiveTable(): IFilterPanelInteractiveTable | undefined;
-    /**
-     * Gets the search methods
-     * @returns the search methods
-     */
     get search(): FilterSearcher;
-    /**
-     * **************************************************************************************************
-     ****************************************** Setters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Sets the datasets
-     * @param datasets the collection of dataset info
-     */
     setDatasets(datasets: IDataset[]): void;
-    /**
-     * Sets the filters
-     * @param filters the new collection of filters to set
-     */
     setFilters(filters?: IFilter[]): void;
-    /**
-     * Sets the table of interactive table
-     * @param interactiveTable table of interaction properties for each section
-     */
     setInteractiveTable(interactiveTable: IFilterPanelInteractiveTable): void;
 }
-//# sourceMappingURL=FilterManager.d.ts.map
+export {};

package/dist/classes/FilterManager.js

@@ -1,105 +1,48 @@
 import { FilterAdapter } from "./FilterAdapter";
 import { FilterBuilder } from "./FilterBuilder";
 import { FilterSearcher } from "./FilterSearcher";
-/**
- * Class to manage the filters
- */
 export class FilterManager {
     _filters;
     datasets;
     _interactiveTable;
-    /**
-     * Instance to adapt filters
-     */
     _adapt;
-    /**
-     * Instance to build filters
-     */
     _builder;
-    /**
-     * Instance to search filters
-     */
     _searchEngine;
-    /**
-     * 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) {
+    constructor(_filters = [], datasets = [], _interactiveTable, dependencies) {
         this._filters = _filters;
         this.datasets = datasets;
         this._interactiveTable = _interactiveTable;
-        this._searchEngine = new FilterSearcher(_filters);
-        this._builder = new FilterBuilder(_filters);
-        this._adapt = new FilterAdapter(_filters, datasets, _interactiveTable);
+        this._searchEngine =
+            dependencies?.searchEngine ?? new FilterSearcher(_filters);
+        this._builder = dependencies?.builder ?? new FilterBuilder(_filters);
+        this._adapt =
+            dependencies?.adapt ??
+                new FilterAdapter(_filters, datasets, _interactiveTable);
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** Getters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Gets the adapt methods
-     * @returns the adapt methods
-     */
     get adapt() {
         return this._adapt;
     }
-    /**
-     * Gets the builder methods
-     * @returns the builder methods
-     */
     get builder() {
         return this._builder;
     }
-    /**
-     * Gets the filter collections
-     * @returns the filters
-     */
     get filters() {
         return this._filters;
     }
-    /**
-     * Gets the interactive table
-     * @returns the interactive table
-     */
     get interactiveTable() {
         return this._interactiveTable;
     }
-    /**
-     * Gets the search methods
-     * @returns the search methods
-     */
     get search() {
         return this._searchEngine;
     }
-    /**
-     * **************************************************************************************************
-     ****************************************** Setters *************************************************
-     ****************************************************************************************************
-     */
-    /**
-     * Sets the datasets
-     * @param datasets the collection of dataset info
-     */
     setDatasets(datasets) {
         this._adapt.setDatasets(datasets);
     }
-    /**
-     * Sets the filters
-     * @param filters the new collection of filters to set
-     */
     setFilters(filters = []) {
         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
-     */
     setInteractiveTable(interactiveTable) {
         this._interactiveTable = interactiveTable;
         this._adapt.setInteractiveTable(this._interactiveTable);