Add functions to define resultType and to set personalizationEvents

Author: anttiai

README.md

@@ -87,6 +87,23 @@ client.setJWT(token);
 client.setUserToken('uuid');
 ```
 
+#### Send personalization events with search query
+In personalized search, user events are typically sent to AddSearch via API and a user token
+is passed with the search query (see setUserToken function). 
+An alternative way is to send user events needed for personalization with the search query.
+
+```js
+// Events depend on the personalization strategy
+// Contact AddSearch for more information
+var events = [
+  {favorite_genre: 'rock'},
+  {favorite_band: 'Red Hot Chili Peppers'},
+  {least_favorite_genre: 'country'}
+];
+
+client.setPersonalizationEvents(events);
+```
+
 #### Define language filter
 ```js
 // Documents in specific language (e.g. "en" or "de")
@@ -143,6 +160,13 @@ client.nextPage();
 client.previousPage();
 ```
 
+#### Set result type
+```js
+// By default, fetch all search results
+// If "organic", Pinned results and Promotions are left out
+client.setResultType('organic');
+```
+
 #### Facets
 ```js
 // Declare fields for faceting. Number of hits found from

src/apifetch.js

@@ -54,6 +54,7 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
         settingToQueryParam(settings.paging.sortBy, 'sort') +
         settingToQueryParam(settings.paging.sortOrder, 'order') +
         settingToQueryParam(settings.jwt, 'jwt') +
+        settingToQueryParam(settings.resultType, 'resultType') +
         settingToQueryParam(settings.userToken, 'userToken');
 
       // Add custom field filters
@@ -65,10 +66,20 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
 
       // Add facet fields
       if (settings.facetFields) {
-        for (var i = 0; i < settings.facetFields.length; i++) {
+        for (var i = 0; i<settings.facetFields.length; i++) {
           qs = qs + '&facet=' + settings.facetFields[i];
         }
       }
+
+      // Personalization events
+      if (settings.personalizationEvents && Array.isArray(settings.personalizationEvents)) {
+        for (var i = 0; i<settings.personalizationEvents.length; i++) {
+          var obj = settings.personalizationEvents[i];
+          var key = Object.keys(obj);
+          qs = qs + '&personalizationEvent=' + encodeURIComponent(key + '=' + obj[key]);
+        }
+      }
+
     }
   }
 

src/index.js

@@ -79,6 +79,8 @@ var client = function(sitekey) {
   this.previousPage = function() { this.settings.previousPage(); }
   this.setSuggestionsSize = function(size) { this.settings.setSuggestionsSize(size); }
   this.addFacetField = function(fieldName) { this.settings.addFacetField(fieldName); }
+  this.setResultType = function(type) { this.settings.setResultType(type); }
+  this.setPersonalizationEvents = function(events) { this.settings.setPersonalizationEvents(events); }
   //this.hitClicked = function(docid, position) { sendClickHit(this.sitekey, this.settings.getSettings().keyword, docid, position); }
 }
 

src/settings.js

@@ -101,6 +101,14 @@ var settings = function() {
     this.settings.userToken = token;
   }
 
+  this.setPersonalizationEvents = function(events) {
+    this.settings.personalizationEvents = events;
+  }
+
+  this.setResultType = function(type) {
+    this.settings.resultType = type;
+  }
+
   this.addFacetField = function(field) {
     this.settings.facetFields.push(field);
   }