FINDO-8454_combine_available_and_selected_filters (Step 1: Refactor the current filter system)

example/response.json

@@ -10,24 +10,6 @@
       "field": "salesfrequency",
       "relevanceBased": true,
       "direction": "DESC"
-    },
-    "selectedFilters": {
-      "cat": [
-        {
-          "value": "Gardening"
-        }
-      ],
-      "price": [
-        {
-          "min": 0.0,
-          "max": 15
-        }
-      ],
-      "vendor": [
-        {
-          "value": "Blubbergurken International Inc."
-        }
-      ]
     }
   },
   "result": {
@@ -80,7 +62,7 @@
         }
       }
     ],
-    "availableFilters": {
+    "filters": {
       "main": [
         {
           "name": "cat",
@@ -96,6 +78,32 @@
           ],
           "pinnedFilterValueCount": 6
         },
+        {
+          "type": "range-slider",
+          "totalRange": {
+            "min": 2.37,
+            "max": 10106.09
+          },
+          "selectedRange": {
+            "min": 2.37,
+            "max": 10106.09
+          },
+          "stepSize": 0.1,
+          "unit": "€",
+          "name": "price",
+          "displayName": "Preis",
+          "selectMode": "single",
+          "values": [
+            {
+              "value": {
+                "min": 2.37,
+                "max": 30.75
+              },
+              "weight": 0.3948,
+              "frequency": null
+            }
+          ]
+        },
         {
           "name": "vendor",
           "displayName": "Brand",
@@ -107,7 +115,8 @@
               "value": "Blubbergurken International Inc.",
               "weight": 0.8,
               "frequency": 5,
-              "selected": true
+              "selected": true,
+              "frequencyType" : "additive"
             }
           ]
         }
@@ -117,6 +126,7 @@
           "name": "color",
           "displayName": "Color",
           "type": "color",
+          "selectMode": "multiple",
           "cssClass": "my-colors",
           "values": [
             {

resources/schema.json

@@ -9,7 +9,7 @@
       "properties": {
         "value": {
           "description": "The filter value, as selected or suitable for visualization.",
-          "type": "string",
+          "type": ["string", "object"],
           "minLength": 1
         },
         "min": {
@@ -36,6 +36,14 @@
           "description": "The number of products matching a filter. Not supported in all configuration constellations.",
           "type": ["number", "null"]
         },
+        "frequencyType": {
+          "type": "string",
+          "enum": [
+            "additive",
+            "absolute"
+          ],
+          "description": "In case of a selected-filter, this property indicates whether the frequency is the number of additional products you'll get after selecting the filter (additive), or whether it's the total number of results you'll have after selecting the filter (absolute)."
+        },
         "colorCode": {
           "description": "For color filters, the hexadecimal code corresponding to the color. The filter's value is the configured color name in such a case.",
           "type": "string",
@@ -52,7 +60,7 @@
       },
       "additionalProperties": false
     },
-    "availableFilter": {
+    "filter": {
       "description": "A selected value, with limited metadata as compared to available filters.",
       "type": "object",
       "properties": {
@@ -71,7 +79,7 @@
           "type": "string",
           "enum": [
             "select",
-            "rangeSlider",
+            "range-slider",
             "color",
             "label",
             "image"
@@ -83,7 +91,7 @@
             "single",
             "multiple"
           ],
-          "description": "Whether one or more filter values can be selected at the same time. Only applies to a subset of available filter types."
+          "description": "Whether one or more filter values can be selected at the same time."
         },
         "cssClass": {
           "type": "string",
@@ -104,6 +112,58 @@
         "pinnedFilterValueCount": {
           "type": "integer",
           "description": "This is the number of filter values that should always be shown, and any more values than that should be hidden, e.g. by putting them in a dropdown."
+        },
+        "combinationOperation": {
+          "type": "string",
+          "enum": [
+            "or",
+            "and"
+          ],
+          "description": "This indicates whether multiple-filters are applied in a OR- or AND-condition and do only apply after a minimum of two filters have been selected. The AND-condition shrinks the result (A and B have to match), while the OR-condition makes it grow (A or B have to match)."
+        },
+        "totalRange": {
+          "description": "The usable range of a range slider.",
+          "properties": {
+            "min": {
+              "type": "number",
+              "description": "The minimum of the possible range."
+            },
+            "max": {
+              "type": "number",
+              "description": "The maximum of the possible range."
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "min",
+            "max"
+          ]
+        },
+        "selectedRange": {
+          "description": "The currently selected range of a range slider.",
+          "properties": {
+            "min": {
+              "type": "number",
+              "description": "The minimum of the selected range."
+            },
+            "max": {
+              "type": "number",
+              "description": "The maximum of the selected range."
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "min",
+            "max"
+          ]
+        },
+        "stepSize": {
+          "type": "number",
+          "description": "The step size for range filters."
+        },
+        "unit": {
+          "type": "string",
+          "description": "The unit for range filters."
         }
       },
       "additionalProperties": false,
@@ -136,7 +196,7 @@
           "description": "Items per page."
         },
         "serviceId": {
-          "description": "Mirrored from the required request parameter \"shopkey\"",
+          "description": "Mirrored from the required request parameter \"shopkey\".",
           "type": "string",
           "pattern": "^[0-9A-F]{32}$"
         },
@@ -186,18 +246,6 @@
             "relevanceBased",
             "direction"
           ]
-        },
-        "selectedFilters": {
-          "description": "Filters that have previously been selected.",
-          "type": "object",
-          "patternProperties": {
-            "^.*$": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/filterMetadata"
-              }
-            }
-          }
         }
       },
       "additionalProperties": false,
@@ -208,8 +256,7 @@
         "serviceId",
         "usergroup",
         "userId",
-        "order",
-        "selectedFilters"
+        "order"
       ]
     },
     "result": {
@@ -380,7 +427,7 @@
                 "minLength": 0
               },
               "properties": {
-                "description": "Non-searchable value exported as properties. Includes additional images, if applicable. The desired values have to be requested with the 'properties[]' parameter",
+                "description": "Non-searchable value exported as properties. Includes additional images, if applicable. The desired values have to be requested with the 'properties[]' parameter.",
                 "type": "object",
                 "properties": {
                   ".*": {
@@ -434,22 +481,22 @@
             ]
           }
         },
-        "availableFilters": {
+        "filters": {
           "description": "Filters available based on the query, and as configured in the filter configuration. Does not include inactive filters.",
           "type": "object",
           "properties": {
             "main": {
               "description": "Filters configured for primary visibility.",
               "type": "array",
               "items": {
-                "$ref": "#/definitions/availableFilter"
+                "$ref": "#/definitions/filter"
               }
             },
             "other": {
               "description": "Filters configured for secondary visibility. Should be initially hidden or collapsed.",
               "type": "array",
               "items": {
-                "$ref": "#/definitions/availableFilter"
+                "$ref": "#/definitions/filter"
               }
             }
           },
@@ -465,7 +512,7 @@
         "metadata",
         "variant",
         "items",
-        "availableFilters"
+        "filters"
       ]
     }
   },