Add facets

Author: anttiai

README.md

@@ -41,11 +41,11 @@ The client provides the following functions.
 // Search with a specific keyword
 client.search('keyword', callback);
 
-// Match all query
-client.search('*', callback);
-
 // Search with the previously used keyword or execute a "match all" query
 client.search(callback);
+
+// Search with the previously used keyword and callback (e.g. after modifying filters)
+client.search();
 ```
 
 #### Fetch search suggestions
@@ -55,9 +55,15 @@ client.search(callback);
 client.suggestions('a', callback);
 ```
 
-#### Use fuzzy matching
+#### Number of search suggestions
+```js
+// Number of search suggestions to fetch (default 10)
+client.setSuggestionsSize(20);
+```
+
+#### Search with fuzzy matching
 ```js
-// Enable/disable fuzzy matching used in typo tolerance (default "true")
+// Enable/disable fuzzy matching for typo tolerance (default "true")
 client.useFuzzyMatch(false);
 ```
 
@@ -129,6 +135,14 @@ client.nextPage();
 client.previousPage();
 ```
 
+#### Facets
+```js
+// Declare fields for faceting. Number of hits found from
+// these fields will be returned
+client.addFacetField('category');
+client.addFacetField('custom_fields.genre');
+```
+
 ## Supported web browsers and node.js versions
 The client is tested on
 - Chrome

src/apifetch.js

@@ -62,11 +62,19 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
           qs = qs + '&customField=' + settings.customFieldFilters[i];
         }
       }
+
+      // Add facet fields
+      if (settings.facetFields) {
+        for (var i = 0; i < settings.facetFields.length; i++) {
+          qs = qs + '&facet=' + settings.facetFields[i];
+        }
+      }
     }
   }
 
   // Suggest
   else if (type === 'suggest') {
+    qs = settingToQueryParam(settings.suggestionsSize, 'size');
     kw = settings.suggestionsPrefix;
   }
 

src/index.js

@@ -32,10 +32,16 @@ var client = function(sitekey) {
       keyword = this.settings.getSettings().keyword;
       callback = a1;
     }
+    // Use previous keyword and callback
+    else if (this.settings.getSettings().callback) {
+      keyword = this.settings.getSettings().keyword;
+      callback = this.settings.getSettings().callback;
+    }
     else {
-      throw "Illegal search parameters. Should be (keyword, callbackFunction) or just (callbackFunction)";
+      throw "Illegal search parameters. Should be (keyword, callbackFunction) or (callbackFunction)";
     }
 
+    this.settings.setCallback(callback);
     this.settings.setKeyword(keyword);
     executeApiFetch(this.sitekey, 'search', this.settings.getSettings(), callback);
   }
@@ -71,6 +77,8 @@ var client = function(sitekey) {
   this.setPaging = function(page, pageSize, sortBy, sortOder) { this.settings.setPaging(page, pageSize, sortBy, sortOder); }
   this.nextPage = function() { this.settings.nextPage(); }
   this.previousPage = function() { this.settings.previousPage(); }
+  this.setSuggestionsSize = function(size) { this.settings.setSuggestionsSize(size); }
+  this.addFacetField = function(fieldName) { this.settings.addFacetField(fieldName); }
   //this.hitClicked = function(docid, position) { sendClickHit(this.sitekey, this.settings.getSettings().keyword, docid, position); }
 }
 

src/settings.js

@@ -3,6 +3,7 @@
 var settings = function() {
   this.settings = {
     keyword: '*',
+    callback: null,
     fuzzy: true,
     paging: {
       page: 1,
@@ -11,7 +12,9 @@ var settings = function() {
       sortOrder: 'desc'
     },
     customFieldFilters: [],
-    userToken: null
+    userToken: null,
+    suggestionsSize: 10,
+    facetFields: []
   };
 
   this.getSettings = function() {
@@ -22,10 +25,18 @@ var settings = function() {
     this.settings.keyword = keyword || '*';
   }
 
+  this.setCallback = function(cb) {
+    this.settings.callback = cb;
+  }
+
   this.setSuggestionsPrefix = function(prefix) {
     this.settings.suggestionsPrefix = prefix;
   }
 
+  this.setSuggestionsSize = function(size) {
+    this.settings.suggestionsSize = size;
+  }
+
   this.setLanguage = function(language) {
     if (language && language.length !== 2) {
       throw "use 2-char language code (e.g. \"en\")";
@@ -90,6 +101,10 @@ var settings = function() {
     this.settings.userToken = token;
   }
 
+  this.addFacetField = function(field) {
+    this.settings.facetFields.push(field);
+  }
+
   this.setPaging = function(page, pageSize, sortBy, sortOrder) {
     // Validate
     if (page < 1) {