Merge pull request #10 from AddSearch/range-facets

Add range facets

Author: anttiai

README.md

@@ -209,6 +209,20 @@ Use the following function to get more or less facets.
 client.setNumberOfFacets(20);
 ```
 
+#### Numeric range facets
+Group numerical custom fields into range buckets.
+```js
+// Define ranges. E.g. products with price $0-$100, $100-$200, and over $200 (from value is inclusive, to value is exclusive)
+var ranges = [
+  {'to': 100},
+  {'from': 100, 'to': 200},
+  {'from': 200}
+];
+
+// Parameters: field name, range array
+client.addRangeFacet('custom_fields.price', ranges);
+```
+
 ### Search analytics
 #### Send search event to analytics
 When search is executed, send the event to your AddSearch Analytics Dashboard.

src/apifetch.js

@@ -94,6 +94,13 @@ var executeApiFetch = function(sitekey, type, settings, cb, fuzzyRetry) {
         }
       }
 
+
+      // Range facets
+      if (settings.rangeFacets) {
+        qs = qs + '&rangeFacets=' + JSON.stringify(settings.rangeFacets);
+      }
+
+
       // Personalization events
       if (settings.personalizationEvents && Array.isArray(settings.personalizationEvents)) {
         for (var i = 0; i<settings.personalizationEvents.length; i++) {

src/index.js

@@ -109,6 +109,7 @@ var client = function(sitekey) {
   this.setSuggestionsSize = function(size) { this.settings.setSuggestionsSize(size); }
   this.setAutocompleteSize = function(size) { this.settings.setAutocompleteSize(size); }
   this.addFacetField = function(fieldName) { this.settings.addFacetField(fieldName); }
+  this.addRangeFacet = function(field, ranges) { this.settings.addRangeFacet(field, ranges); }
   this.setNumberOfFacets = function(numFacets) { this.settings.setNumberOfFacets(numFacets); }
   this.setResultType = function(type) { this.settings.setResultType(type); }
   this.setPersonalizationEvents = function(events) { this.settings.setPersonalizationEvents(events); }

src/settings.js

@@ -144,6 +144,16 @@ var settings = function() {
     }
   }
 
+  this.addRangeFacet = function(field, ranges) {
+    if (!this.settings.rangeFacets) {
+      this.settings.rangeFacets = [];
+    }
+    this.settings.rangeFacets.push({
+      field: field,
+      ranges: ranges
+    });
+  }
+
   this.setNumberOfFacets = function(numFacets) {
     this.settings.numFacets = numFacets;
   }