#436: filter appliance based on value

CHANGELOG.md

@@ -13,12 +13,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-* Remove Travis CI - [products/#97](https://github.com/ripe-tech/products/issues/97)
+*
 
 ### Fixed
 
 *
 
+## [0.13.0] - 2023-11-27
+
+### Added
+
+* `removeFunc` to specify which fields to remove (not filter for) based on functions - [ripe-pulse/#436](https://github.com/ripe-tech/ripe-pulse/issues/436)
+
+### Changed
+
+* Remove Travis CI - [products/#97](https://github.com/ripe-tech/products/issues/97)
+
 ## [0.12.4] - 2022-12-19
 
 ### Added

js/filter.js

@@ -63,7 +63,8 @@ export const filterToParams = (
     nameFunc = {},
     filterFields = {},
     keywordFields = {},
-    { imperfectFilterFields = null, keywords = FILTER_KEYWORDS } = {}
+    { imperfectFilterFields = null, keywords = FILTER_KEYWORDS } = {},
+    removeFunc = {}
 ) => {
     let operator = "$or";
     const { sort, reverse, filter, start, limit } = options;
@@ -85,7 +86,10 @@ export const filterToParams = (
             const fieldFunc = nameFunc[field];
             value = keywords[value] || !fieldFunc ? value : fieldFunc(value);
             arithOp = arithOp === "=" ? filterFields[field] : OP_ALIAS[arithOp];
-            if (!field || !arithOp) continue;
+
+            const remove = removeFunc[field] ? removeFunc[field](value) : false;
+            if (remove || !field || !arithOp) continue;
+
             filters.push(
                 ..._buildFilter(field, arithOp, value, keywordFields, { keywords: keywords })
             );
@@ -107,17 +111,22 @@ export const filterToParams = (
             ...flatMap(
                 ([field, operator]) =>
                     _buildFilter(field, operator, filterS, keywordFields, { keywords: keywords }),
-                Object.entries(imperfectFilterFields)
+                Object.entries(imperfectFilterFields).filter(
+                    ([field, _]) => !removeFunc[field] || !removeFunc[field](filterS)
+                )
             )
         );
     }
+
     if (sort) {
         params.sort = sortS;
     }
+
     if (filterS && filters.length > 0) {
         params["filters[]"] = filters;
         params.filter_operator = operator;
     }
+
     return params;
 };
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "ripe-commons",
-    "version": "0.12.4",
+    "version": "0.13.0",
     "description": "The RIPE Commons library",
     "keywords": [
         "commons",

test/filter.js

@@ -552,5 +552,88 @@ describe("Filter", function() {
                 start_record: 0
             });
         });
+
+        it("should not leave out filter fields when applicable to the searched value", () => {
+            const options = {
+                filter: "friends=13",
+                limit: 5,
+                start: 0
+            };
+            const filterFields = {
+                friends: "in"
+            };
+            const removeFunc = {
+                friends: value => isNaN(parseInt(value))
+            };
+            const result = ripeCommons.filterToParams(
+                options,
+                {},
+                {},
+                filterFields,
+                {},
+                {},
+                removeFunc
+            );
+            assert.deepStrictEqual(result, {
+                filter_operator: "$and",
+                "filters[]": ["friends:in:13"],
+                number_records: 5,
+                start_record: 0
+            });
+        });
+
+        it("should leave out filter fields not applicable to the searched value", () => {
+            const options = {
+                filter: "friends=john",
+                limit: 5,
+                start: 0
+            };
+            const filterFields = {
+                friends: "in"
+            };
+            const removeFunc = {
+                friends: value => isNaN(parseInt(value))
+            };
+            const result = ripeCommons.filterToParams(
+                options,
+                {},
+                {},
+                filterFields,
+                {},
+                {},
+                removeFunc
+            );
+            assert.deepStrictEqual(result, {
+                number_records: 5,
+                start_record: 0
+            });
+        });
+
+        it("should leave out imperfect filter strings not applicable to the searched value", () => {
+            const options = {
+                filter: "john",
+                limit: 5,
+                start: 0
+            };
+            const filterFields = {
+                friends: "in"
+            };
+            const removeFunc = {
+                friends: value => isNaN(parseInt(value))
+            };
+            const result = ripeCommons.filterToParams(
+                options,
+                {},
+                {},
+                filterFields,
+                {},
+                {},
+                removeFunc
+            );
+            assert.deepStrictEqual(result, {
+                number_records: 5,
+                start_record: 0
+            });
+        });
     });
 });

test/time.js

@@ -28,7 +28,7 @@ describe("Time", function() {
         });
 
         it("should format simple date strings and reverse the output", () => {
-            const result = ripeCommons.dateStringUTC(new Date("10/12/2020") / 1000, "-", {
+            const result = ripeCommons.dateStringUTC(new Date("10/12/2020Z") / 1000, "-", {
                 reverseDate: true
             });
             assert.deepStrictEqual(result, "2020-10-12");

types/filter.d.ts

@@ -14,5 +14,13 @@ export declare function filterToParams(
     nameAlias: Record<string, string>,
     nameFunc: Record<string, () => unknown>,
     filterFields: Record<string, string>,
-    keywordFields: Record<string, string[]>
+    keywordFields: Record<string, string[]>,
+    {
+        imperfectFilterFields,
+        keywords
+    }: {
+        imperfectFilterFields: Record<string, string>;
+        keywords: Record<string, () => unknown>;
+    } = {},
+    removeFunc: Record<string, () => boolean>
 ): FilterParams;