@qrvey/filters 0.0.7 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/cjs/classes/FilterAdapter.d.ts +18 -15
  3. package/dist/cjs/classes/FilterAdapter.d.ts.map +1 -1
  4. package/dist/cjs/classes/FilterAdapter.js +36 -16
  5. package/dist/cjs/classes/FilterBuilder.d.ts +58 -28
  6. package/dist/cjs/classes/FilterBuilder.d.ts.map +1 -1
  7. package/dist/cjs/classes/FilterBuilder.js +141 -105
  8. package/dist/cjs/classes/FilterResources.d.ts +58 -48
  9. package/dist/cjs/classes/FilterResources.d.ts.map +1 -1
  10. package/dist/cjs/classes/FilterResources.js +88 -78
  11. package/dist/cjs/classes/FilterSearcher.d.ts +17 -1
  12. package/dist/cjs/classes/FilterSearcher.d.ts.map +1 -1
  13. package/dist/cjs/classes/FilterSearcher.js +19 -1
  14. package/dist/cjs/models/filter-builder.models.d.ts +1 -1
  15. package/dist/cjs/models/filter-builder.models.d.ts.map +1 -1
  16. package/dist/cjs/models/filter-searcher.models.d.ts +42 -0
  17. package/dist/cjs/models/filter-searcher.models.d.ts.map +1 -0
  18. package/dist/cjs/models/filter-searcher.models.js +2 -0
  19. package/dist/cjs/models/index.d.ts +1 -0
  20. package/dist/cjs/models/index.d.ts.map +1 -1
  21. package/dist/cjs/models/index.js +1 -0
  22. package/dist/cjs/resources/filters.resources.d.ts +51 -1
  23. package/dist/cjs/resources/filters.resources.d.ts.map +1 -1
  24. package/dist/cjs/resources/filters.resources.js +20 -1
  25. package/dist/classes/FilterAdapter.d.ts +18 -15
  26. package/dist/classes/FilterAdapter.d.ts.map +1 -1
  27. package/dist/classes/FilterAdapter.js +36 -16
  28. package/dist/classes/FilterBuilder.d.ts +58 -28
  29. package/dist/classes/FilterBuilder.d.ts.map +1 -1
  30. package/dist/classes/FilterBuilder.js +141 -105
  31. package/dist/classes/FilterResources.d.ts +58 -48
  32. package/dist/classes/FilterResources.d.ts.map +1 -1
  33. package/dist/classes/FilterResources.js +88 -78
  34. package/dist/classes/FilterSearcher.d.ts +17 -1
  35. package/dist/classes/FilterSearcher.d.ts.map +1 -1
  36. package/dist/classes/FilterSearcher.js +20 -2
  37. package/dist/models/filter-builder.models.d.ts +1 -1
  38. package/dist/models/filter-builder.models.d.ts.map +1 -1
  39. package/dist/models/filter-searcher.models.d.ts +42 -0
  40. package/dist/models/filter-searcher.models.d.ts.map +1 -0
  41. package/dist/models/filter-searcher.models.js +1 -0
  42. package/dist/models/index.d.ts +1 -0
  43. package/dist/models/index.d.ts.map +1 -1
  44. package/dist/models/index.js +1 -0
  45. package/dist/resources/filters.resources.d.ts +51 -1
  46. package/dist/resources/filters.resources.d.ts.map +1 -1
  47. package/dist/resources/filters.resources.js +19 -0
  48. package/package.json +1 -1
  49. package/src/classes/FilterAdapter.ts +42 -18
  50. package/src/classes/FilterBuilder.ts +165 -122
  51. package/src/classes/FilterResources.ts +113 -101
  52. package/src/classes/FilterSearcher.ts +27 -4
  53. package/src/models/filter-builder.models.ts +1 -4
  54. package/src/models/filter-searcher.models.ts +61 -0
  55. package/src/models/index.ts +1 -0
  56. package/src/resources/filters.resources.ts +56 -1
  57. package/tests/classes/FilterBuilder.test.ts +184 -0
  58. package/tests/classes/FilterResources.test.ts +171 -0
  59. package/tests/classes/FilterSearcher.test.ts +139 -0
  60. package/tests/mock/filters.mock.ts +111 -0
package/CHANGELOG.md CHANGED
@@ -4,8 +4,16 @@ All notable changes to this project will be documented in this file. Dates are d
4
4
 
5
5
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6
6
 
7
+ #### [v0.0.8](https://bitbucket.org/qrvey/qrvey_filters/compare/v0.0.8..v0.0.7)
8
+
9
+ - test: created some unit tests for the Filter Builder [`aca85d3`](https://bitbucket.org/qrvey/qrvey_filters/commits/aca85d3e3e7f5aafd10be40937323d2474351dfd)
10
+ - test: added unit tests for Filter Resources [`fcf91fc`](https://bitbucket.org/qrvey/qrvey_filters/commits/fcf91fc9f755bdc6f7a624a870de93ec4b971b47)
11
+ - test: added unit tests for Filter Searcher [`d24ba73`](https://bitbucket.org/qrvey/qrvey_filters/commits/d24ba73aed877070c38d069a120d4c4efeecdef1)
12
+
7
13
  #### [v0.0.7](https://bitbucket.org/qrvey/qrvey_filters/compare/v0.0.7..v0.0.6)
8
14
 
15
+ > 23 April 2024
16
+
9
17
  - build: upgraded some dependencies to the latest versions [`66a34a8`](https://bitbucket.org/qrvey/qrvey_filters/commits/66a34a888d846ba6506bbb00ab0c04442ee953e8)
10
18
  - refactor: fixed the ESLint suggestion on getFilterId test [`3733ed2`](https://bitbucket.org/qrvey/qrvey_filters/commits/3733ed288cc48b5a6a2d2376211dfbeef6d28d83)
11
19
  - build: upgraded Qrvey Utils to the next version [`67db4e3`](https://bitbucket.org/qrvey/qrvey_filters/commits/67db4e3b2f630a04d374e4f4e6a85144681a0e75)
@@ -1,13 +1,11 @@
1
1
  import { IDataset, IFUData } from "@qrvey/utils";
2
- import { IFilterLogic } from "../resources/filter-logic.resources";
3
2
  import { IFilterPanelInteractiveTable } from "../resources/filter-panel.interfaces";
4
- import { IFilterVisual } from "../resources/filter-visual.resources";
5
- import { IFilter } from "../resources/filters.resources";
3
+ import { FILTER_VERSION_TYPE, IFilter, IFilterVersion } from "../resources/filters.resources";
6
4
  /**
7
5
  * Class to adapt the filters
8
6
  */
9
7
  export declare class FilterAdapter {
10
- protected filters: IFilter[];
8
+ protected _filters: IFilter[];
11
9
  protected datasets: IDataset[];
12
10
  protected interactiveTable?: IFilterPanelInteractiveTable | undefined;
13
11
  /**
@@ -24,11 +22,11 @@ export declare class FilterAdapter {
24
22
  private _legacyVisual?;
25
23
  /**
26
24
  * Constructor
27
- * @param filters the collection of filters
25
+ * @param _filters the collection of filters
28
26
  * @param datasets the collection of datasets info
29
27
  * @param interactiveTable table of interaction properties for each section
30
28
  */
31
- constructor(filters?: IFilter[], datasets?: IDataset[], interactiveTable?: IFilterPanelInteractiveTable | undefined);
29
+ constructor(_filters?: IFilter[], datasets?: IDataset[], interactiveTable?: IFilterPanelInteractiveTable | undefined);
32
30
  /**
33
31
  *
34
32
  */
@@ -55,20 +53,25 @@ export declare class FilterAdapter {
55
53
  */
56
54
  static legacyVisualToFilter(legacyVisual: IFUData): IFilter[];
57
55
  /**
58
- * Gets the legacy filter visual attribute
59
- * @returns the legacy visual filter
56
+ * Gets the legacy filter version attribute
57
+ * @returns the legacy filter version
60
58
  */
61
- get legacyVisual(): IFUData | undefined;
59
+ get legacyVisual(): IFilterVersion<FILTER_VERSION_TYPE.UI_2>;
62
60
  /**
63
- * Gets the filter logic attribute
64
- * @returns the logic filter
61
+ * Gets the filter logic version
62
+ * @returns the filter logic version
65
63
  */
66
- get logic(): IFilterLogic[] | undefined;
64
+ get logic(): IFilterVersion<FILTER_VERSION_TYPE.LOGIC>;
67
65
  /**
68
- * Gets the filter visual attribute
69
- * @returns the visual filter
66
+ * Gets the visual filter version
67
+ * @returns the visual filter version
70
68
  */
71
- get visual(): IFilterVisual | undefined;
69
+ get visual(): IFilterVersion<FILTER_VERSION_TYPE.UI_3>;
70
+ /**
71
+ * Gets the filter version 3
72
+ * @returns the filter version 3
73
+ */
74
+ get filters(): IFilterVersion<FILTER_VERSION_TYPE.V3>;
72
75
  /**
73
76
  * Sets the datasets atribute
74
77
  * @param datasets the collection of dataset info
@@ -1 +1 @@
1
- {"version":3,"file":"FilterAdapter.d.ts","sourceRoot":"","sources":["../../../src/classes/FilterAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAOjD,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAEzD;;GAEG;AACH,qBAAa,aAAa;IAuBtB,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE;IAC5B,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE;IAC9B,SAAS,CAAC,gBAAgB,CAAC;IAxB7B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,CAAiB;IAEhC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAC,CAAgB;IAEhC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAC,CAAU;IAEhC;;;;;OAKG;gBAES,OAAO,GAAE,OAAO,EAAO,EACvB,QAAQ,GAAE,QAAQ,EAAO,EACzB,gBAAgB,CAAC,0CAA8B;IAK3D;;OAEG;IACH,OAAO,CAAC,IAAI;IAMZ;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAQ5B;;;OAGG;IACH,OAAO,CAAC,aAAa;IAIrB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAItB;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,EAAE;IAI7D;;;OAGG;IACH,IAAI,YAAY,IAAI,OAAO,GAAG,SAAS,CAEtC;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,YAAY,EAAE,GAAG,SAAS,CAEtC;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,aAAa,GAAG,SAAS,CAEtC;IAED;;;OAGG;IACI,WAAW,CAAC,QAAQ,GAAE,QAAQ,EAAO,GAAG,IAAI;IAKnD;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI;IAK3C;;;OAGG;IACI,mBAAmB,CACxB,gBAAgB,EAAE,4BAA4B,GAC7C,IAAI;IAKP;;;OAGG;IACH,OAAO,CAAC,eAAe;IAIvB;;;OAGG;IACH,OAAO,CAAC,QAAQ;IAIhB;;;OAGG;IACH,OAAO,CAAC,SAAS;CAGlB"}
1
+ {"version":3,"file":"FilterAdapter.d.ts","sourceRoot":"","sources":["../../../src/classes/FilterAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAQjD,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AAEpF,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,cAAc,EACf,MAAM,gCAAgC,CAAC;AAExC;;GAEG;AACH,qBAAa,aAAa;IAuBtB,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;IAC7B,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE;IAC9B,SAAS,CAAC,gBAAgB,CAAC;IAxB7B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,CAAiB;IAEhC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAC,CAAgB;IAEhC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAC,CAAU;IAEhC;;;;;OAKG;gBAES,QAAQ,GAAE,OAAO,EAAO,EACxB,QAAQ,GAAE,QAAQ,EAAO,EACzB,gBAAgB,CAAC,0CAA8B;IAK3D;;OAEG;IACH,OAAO,CAAC,IAAI;IAMZ;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAQ5B;;;OAGG;IACH,OAAO,CAAC,aAAa;IAIrB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAItB;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,EAAE;IAI7D;;;OAGG;IACH,IAAI,YAAY,IAAI,cAAc,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAK3D;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,cAAc,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAKrD;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,cAAc,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAKrD;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAKpD;IAED;;;OAGG;IACI,WAAW,CAAC,QAAQ,GAAE,QAAQ,EAAO,GAAG,IAAI;IAKnD;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI;IAK3C;;;OAGG;IACI,mBAAmB,CACxB,gBAAgB,EAAE,4BAA4B,GAC7C,IAAI;IAKP;;;OAGG;IACH,OAAO,CAAC,eAAe;IAIvB;;;OAGG;IACH,OAAO,CAAC,QAAQ;IAIhB;;;OAGG;IACH,OAAO,CAAC,SAAS;CAGlB"}
@@ -2,11 +2,12 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.FilterAdapter = void 0;
4
4
  const filter_adapt_helpers_1 = require("../helpers/filter-adapt.helpers");
5
+ const filters_resources_1 = require("../resources/filters.resources");
5
6
  /**
6
7
  * Class to adapt the filters
7
8
  */
8
9
  class FilterAdapter {
9
- filters;
10
+ _filters;
10
11
  datasets;
11
12
  interactiveTable;
12
13
  /**
@@ -23,12 +24,12 @@ class FilterAdapter {
23
24
  _legacyVisual;
24
25
  /**
25
26
  * Constructor
26
- * @param filters the collection of filters
27
+ * @param _filters the collection of filters
27
28
  * @param datasets the collection of datasets info
28
29
  * @param interactiveTable table of interaction properties for each section
29
30
  */
30
- constructor(filters = [], datasets = [], interactiveTable) {
31
- this.filters = filters;
31
+ constructor(_filters = [], datasets = [], interactiveTable) {
32
+ this._filters = _filters;
32
33
  this.datasets = datasets;
33
34
  this.interactiveTable = interactiveTable;
34
35
  this.sync();
@@ -46,7 +47,7 @@ class FilterAdapter {
46
47
  * @returns a visual Filter structure
47
48
  */
48
49
  filterToLegacyVisual() {
49
- return (0, filter_adapt_helpers_1.filterToLegacyVisual)(this.filters, this.datasets, this.interactiveTable);
50
+ return (0, filter_adapt_helpers_1.filterToLegacyVisual)(this._filters, this.datasets, this.interactiveTable);
50
51
  }
51
52
  /**
52
53
  * Generates a logic filters structure from the filter collection.
@@ -60,7 +61,7 @@ class FilterAdapter {
60
61
  * @returns a visual Filter structure
61
62
  */
62
63
  filterToVisual() {
63
- return (0, filter_adapt_helpers_1.filterToVisual)(this.filters, this.datasets, this.interactiveTable);
64
+ return (0, filter_adapt_helpers_1.filterToVisual)(this._filters, this.datasets, this.interactiveTable);
64
65
  }
65
66
  /**
66
67
  * Generates the filter collection from the legacy filter
@@ -71,25 +72,44 @@ class FilterAdapter {
71
72
  return (0, filter_adapt_helpers_1.legacyVisualToFilter)(legacyVisual);
72
73
  }
73
74
  /**
74
- * Gets the legacy filter visual attribute
75
- * @returns the legacy visual filter
75
+ * Gets the legacy filter version attribute
76
+ * @returns the legacy filter version
76
77
  */
77
78
  get legacyVisual() {
78
- return this._legacyVisual;
79
+ return {
80
+ filters: this._legacyVisual,
81
+ version: filters_resources_1.FILTER_VERSION_TYPE.UI_2,
82
+ };
79
83
  }
80
84
  /**
81
- * Gets the filter logic attribute
82
- * @returns the logic filter
85
+ * Gets the filter logic version
86
+ * @returns the filter logic version
83
87
  */
84
88
  get logic() {
85
- return this._logic;
89
+ return {
90
+ filters: this._logic ?? [],
91
+ version: filters_resources_1.FILTER_VERSION_TYPE.LOGIC,
92
+ };
86
93
  }
87
94
  /**
88
- * Gets the filter visual attribute
89
- * @returns the visual filter
95
+ * Gets the visual filter version
96
+ * @returns the visual filter version
90
97
  */
91
98
  get visual() {
92
- return this._visual;
99
+ return {
100
+ filters: this._visual,
101
+ version: filters_resources_1.FILTER_VERSION_TYPE.UI_3,
102
+ };
103
+ }
104
+ /**
105
+ * Gets the filter version 3
106
+ * @returns the filter version 3
107
+ */
108
+ get filters() {
109
+ return {
110
+ filters: this._filters ?? [],
111
+ version: filters_resources_1.FILTER_VERSION_TYPE.V3,
112
+ };
93
113
  }
94
114
  /**
95
115
  * Sets the datasets atribute
@@ -104,7 +124,7 @@ class FilterAdapter {
104
124
  * @param filters the filters
105
125
  */
106
126
  setFilters(filters) {
107
- this.filters = filters;
127
+ this._filters = filters;
108
128
  this.sync();
109
129
  }
110
130
  /**
@@ -17,13 +17,10 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
17
17
  */
18
18
  constructor(filters?: IFilter[]);
19
19
  /**
20
- * Adds one filter into the collection.
21
- * Inserts it next to the last similar filter
22
- * @param newFilter the filter to add
23
- * @param automaticId flag to generate a new filter ID based on the filter info
24
- * @returns the new collection of filters
20
+ * **************************************************************************************************
21
+ ****************************************** Adding **************************************************
22
+ ****************************************************************************************************
25
23
  */
26
- addSingle(newFilter: IFilter, automaticId?: boolean): IFilterBuilderSingleReturn;
27
24
  /**
28
25
  * Adds various filter into the collection.
29
26
  * Inserts them next to the last similar filter
@@ -32,6 +29,14 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
32
29
  * @returns the new collection of filters
33
30
  */
34
31
  addMutiple(newFilters: IFilter[], automaticId?: boolean): IFilterBuilderMultipleReturn;
32
+ /**
33
+ * Adds one filter into the collection.
34
+ * Inserts it next to the last similar filter
35
+ * @param filter the filter to add
36
+ * @param automaticId flag to generate a new filter ID based on the filter info
37
+ * @returns the new collection of filters
38
+ */
39
+ addSingle(filter: IFilter, automaticId?: boolean): IFilterBuilderSingleReturn;
35
40
  /**
36
41
  * Adds one value from filter
37
42
  * @param id the ID to search the filter to add value
@@ -45,20 +50,19 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
45
50
  * @param values the collection of value to add
46
51
  * @returns the new filter collection
47
52
  */
48
- addValues(id: string, values: IFilterValue[]): IFilterBuilderMultipleReturn;
53
+ addValues(id: string, values: IFilterValue[]): IFilterBuilderSingleReturn;
49
54
  /**
50
- * Builds an filter structure based on given params
51
- * @param filter the partial filter params
52
- * @param automaticId flag to generate a new filter ID based on the filter info
53
- * @returns the complete filter structure
55
+ * **************************************************************************************************
56
+ **************************************** Deleting **************************************************
57
+ ****************************************************************************************************
54
58
  */
55
- static createFilter(filter: Partial<IFilter>, automaticId?: boolean): IFilter;
56
59
  /**
57
- * Removes one filter from the collection
58
- * @param id the ID to search the filter to remove
59
- * @returns the new filter collection
60
+ * Removes various filters by params
61
+ * @param params params to search the filters to delete
62
+ * @param settings settings for this function
63
+ * @returns the new collection of filters
60
64
  */
61
- deleteSingle(id: string): IFilterBuilderSingleReturn;
65
+ deleteByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): IFilterBuilderMultipleReturn;
62
66
  /**
63
67
  * Removes various filters from the collection
64
68
  * @param ids a collection of ID to search filters to remove
@@ -66,12 +70,11 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
66
70
  */
67
71
  deleteMutiple(ids: string[]): IFilterBuilderMultipleReturn;
68
72
  /**
69
- * Removes various filters by params
70
- * @param params params to search the filters to delete
71
- * @param settings settings for this function
72
- * @returns the new collection of filters
73
+ * Removes one filter from the collection
74
+ * @param id the ID to search the filter to remove
75
+ * @returns the new filter collection
73
76
  */
74
- deleteByParams(params: Partial<IFilter>, settings?: IFilterParamSettings): IFilterBuilderMultipleReturn;
77
+ deleteSingle(id: string): IFilterBuilderSingleReturn;
75
78
  /**
76
79
  * Removes one value from filter
77
80
  * @param id the ID to search the filter to remove value
@@ -87,13 +90,10 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
87
90
  */
88
91
  deleteValues(id: string, indexes: number[]): IFilterBuilderMultipleReturn;
89
92
  /**
90
- * Edits one filter from the collection
91
- * @param filter an object with properties to edit
92
- * @param id the ID to search the filter to edit
93
- * @param settings settings object for the function
94
- * @returns the new filter collection
93
+ * **************************************************************************************************
94
+ ****************************************** Editing *************************************************
95
+ ****************************************************************************************************
95
96
  */
96
- editSingle(filter: Partial<IFilter> | IFilter, id: string, settings?: IFilterBuilderEditSettings): IFilterBuilderSingleReturn;
97
97
  /**
98
98
  * Edits various filters from the collection
99
99
  * @param filters a collection of object with properties to edit
@@ -102,6 +102,14 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
102
102
  * @returns the new filter collection
103
103
  */
104
104
  editMutiple(filters: Partial<IFilter>[] | IFilter[], ids: string[], settings?: IFilterBuilderEditSettings): IFilterBuilderMultipleReturn;
105
+ /**
106
+ * Edits one filter from the collection
107
+ * @param filter an object with properties to edit
108
+ * @param id the ID to search the filter to edit
109
+ * @param settings settings object for the function
110
+ * @returns the new filter collection
111
+ */
112
+ editSingle(filter: Partial<IFilter> | IFilter, id: string, settings?: IFilterBuilderEditSettings): IFilterBuilderSingleReturn;
105
113
  /**
106
114
  * Edits one value from filter
107
115
  * @param id the ID to search the filter to edit value
@@ -120,9 +128,16 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
120
128
  editValues(id: string, values: IFilterValue[], indexes: number[]): IFilterBuilderMultipleReturn;
121
129
  /**
122
130
  * **************************************************************************************************
123
- ****************************************** Setters *************************************************
131
+ ****************************************** Others **************************************************
124
132
  ****************************************************************************************************
125
133
  */
134
+ /**
135
+ * Builds an filter structure based on given params
136
+ * @param filter the partial filter params
137
+ * @param automaticId flag to generate a new filter ID based on the filter info
138
+ * @returns the complete filter structure
139
+ */
140
+ static createFilter(filter: Partial<IFilter>, automaticId?: boolean): IFilter;
126
141
  /**
127
142
  * Sets the given filters by param
128
143
  * - Remove the filters by the sucesfull conditions and replace the given ones
@@ -132,6 +147,21 @@ export declare class FilterBuilder implements IFilterBuilderAdd, IFilterBuilderA
132
147
  * @returns the new collection of filters
133
148
  */
134
149
  replaceByParams(filters: IFilter[], params: Partial<IFilter>, settings?: IFilterParamSettings): IFilterBuilderMultipleReturn;
150
+ /**
151
+ * **************************************************************************************************
152
+ ****************************************** Getters *************************************************
153
+ ****************************************************************************************************
154
+ */
155
+ /**
156
+ * Gets the filter collection
157
+ * @returns the collection of filters of the context
158
+ */
159
+ getFilters(): IFilter[];
160
+ /**
161
+ * **************************************************************************************************
162
+ ****************************************** Setters *************************************************
163
+ ****************************************************************************************************
164
+ */
135
165
  /**
136
166
  * Method to sync the Filter instances
137
167
  */
@@ -1 +1 @@
1
- {"version":3,"file":"FilterBuilder.d.ts","sourceRoot":"","sources":["../../../src/classes/FilterBuilder.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,iBAAiB,EACjB,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EACrB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAkB,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAEzE;;GAEG;AACH,qBAAa,aACX,YACE,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB;IAWP,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE;IATxC;;OAEG;IACH,OAAO,CAAC,YAAY,CAAiB;IAErC;;;OAGG;gBACmB,OAAO,GAAE,OAAO,EAAO;IAI7C;;;;;;OAMG;IACI,SAAS,CACd,SAAS,EAAE,OAAO,EAClB,WAAW,UAAO,GACjB,0BAA0B;IAwB7B;;;;;;OAMG;IACI,UAAU,CACf,UAAU,EAAE,OAAO,EAAE,EACrB,WAAW,UAAO,GACjB,4BAA4B;IAiB/B;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,0BAA0B;IAW5E;;;;;OAKG;IACI,SAAS,CACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,YAAY,EAAE,GACrB,4BAA4B;IAoB/B;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,WAAW,UAAO,GAAG,OAAO;IA6B1E;;;;OAIG;IACI,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,0BAA0B;IAW3D;;;;OAIG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,4BAA4B;IAmBjE;;;;;OAKG;IACI,cAAc,CACnB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,4BAA4B;IAQ/B;;;;;OAKG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,0BAA0B;IAazE;;;;;OAKG;IACI,YAAY,CACjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EAAE,GAChB,4BAA4B;IAsB/B;;;;;;OAMG;IACI,UAAU,CACf,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,EAClC,EAAE,EAAE,MAAM,EACV,QAAQ,CAAC,EAAE,0BAA0B,GACpC,0BAA0B;IAqB7B;;;;;;OAMG;IACI,WAAW,CAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,EACvC,GAAG,EAAE,MAAM,EAAE,EACb,QAAQ,CAAC,EAAE,0BAA0B,GACpC,4BAA4B;IA2B/B;;;;;;OAMG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,MAAM,GACZ,0BAA0B;IAgB7B;;;;;;OAMG;IACI,UAAU,CACf,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,YAAY,EAAE,EACtB,OAAO,EAAE,MAAM,EAAE,GAChB,4BAA4B;IAqB/B;;;;OAIG;IAEH;;;;;;;OAOG;IACH,eAAe,CACb,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,4BAA4B;IAQ/B;;OAEG;IACH,OAAO,CAAC,IAAI;IAIZ;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI;CAG5C"}
1
+ {"version":3,"file":"FilterBuilder.d.ts","sourceRoot":"","sources":["../../../src/classes/FilterBuilder.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,iBAAiB,EACjB,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EACrB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAkB,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAEzE;;GAEG;AACH,qBAAa,aACX,YACE,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB;IAWP,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE;IATxC;;OAEG;IACH,OAAO,CAAC,YAAY,CAAiB;IAErC;;;OAGG;gBACmB,OAAO,GAAE,OAAO,EAAO;IAK7C;;;;OAIG;IAEH;;;;;;OAMG;IACI,UAAU,CACf,UAAU,EAAE,OAAO,EAAE,EACrB,WAAW,UAAO,GACjB,4BAA4B;IAmB/B;;;;;;OAMG;IACI,SAAS,CACd,MAAM,EAAE,OAAO,EACf,WAAW,UAAO,GACjB,0BAA0B;IA0B7B;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,0BAA0B;IAW5E;;;;;OAKG;IACI,SAAS,CACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,YAAY,EAAE,GACrB,0BAA0B;IAoB7B;;;;OAIG;IAEH;;;;;OAKG;IACI,cAAc,CACnB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,4BAA4B;IAQ/B;;;;OAIG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,4BAA4B;IAmBjE;;;;OAIG;IACI,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,0BAA0B;IAW3D;;;;;OAKG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,0BAA0B;IAazE;;;;;OAKG;IACI,YAAY,CACjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EAAE,GAChB,4BAA4B;IAsB/B;;;;OAIG;IAEH;;;;;;OAMG;IACI,WAAW,CAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,EACvC,GAAG,EAAE,MAAM,EAAE,EACb,QAAQ,CAAC,EAAE,0BAA0B,GACpC,4BAA4B;IA2B/B;;;;;;OAMG;IACI,UAAU,CACf,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,EAClC,EAAE,EAAE,MAAM,EACV,QAAQ,CAAC,EAAE,0BAA0B,GACpC,0BAA0B;IAqB7B;;;;;;OAMG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,YAAY,EACnB,KAAK,EAAE,MAAM,GACZ,0BAA0B;IAgB7B;;;;;;OAMG;IACI,UAAU,CACf,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,YAAY,EAAE,EACtB,OAAO,EAAE,MAAM,EAAE,GAChB,4BAA4B;IAqB/B;;;;OAIG;IAEH;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,WAAW,UAAO,GAAG,OAAO;IA6B1E;;;;;;;OAOG;IACI,eAAe,CACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,4BAA4B;IAQ/B;;;;OAIG;IAEH;;;OAGG;IACI,UAAU,IAAI,OAAO,EAAE;IAI9B;;;;OAIG;IAEH;;OAEG;IACH,OAAO,CAAC,IAAI;IAIZ;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI;CAG5C"}