Merge branch 'master' into sticky-facets-enhancement

Author: anttiai

README.md

@@ -99,6 +99,18 @@ Fuzzy matching is used for typo tolerance. There are four options:
 client.setFuzzyMatch(false);  
 ```
 
+#### Search operator
+When a user searches with multiple keywords, we return only documents that contain all the terms which means
+applying the logical operator AND for the query. It is possible to choose which logical operator to use for
+fuzzy results when the fuzzy parameter is set to auto. There are two options:
+- **"or"**: makes fuzzy results broader and includes partial matches of a few search terms
+- **"and"**: makes fuzzy results stricter and includes only mistyped search terms
+
+```js
+// Possible values "and"/"or" (default: "or")
+client.setSearchOperator('and');  
+```
+
 #### Postfix wildcard
 Enable or disable postfix wildcard. I.e. should keyword "add" match to "addsearch" or should it just match to the 
 term **add**
@@ -108,6 +120,24 @@ term **add**
 client.setPostfixWildcard(false);  
 ```
 
+
+#### Set enableLogicalOperators
+```js
+// (default: false)
+// enableLogicalOperators(true) = Support user specified logical operators (and/or/not) in the search query like "cat and dog"
+// enableLogicalOperators(false) = Treat logical operators in the search query as literal strings
+client.enableLogicalOperators(true);
+```
+
+#### Set cacheResponseTime
+Caching the response, define the time-to-live of the cache.
+
+```js
+// Specify time-to-live value in seconds
+client.setCacheResponseTime(3600);  
+```
+
+
 ### Pagination
 Set page number, page size and sorting parameters. It's possible to order results by:
 - relevance (descending)
@@ -197,13 +227,6 @@ client.setFilterObject(filter);
 client.setResultType('organic');
 ```
 
-#### Set enableLogicalOperators
-```js
-// (default: false)
-// enableLogicalOperators(true) = Support user specified logical operators (and/or/not) in the search query like "cat and dog"
-// enableLogicalOperators(false) = Treat logical operators in the search query as literal strings
-client.enableLogicalOperators(true);
-```
 
 ### Facets
 ```js

dist/addsearch-js-client.min.js

@@ -1,6 +1,6 @@
 {
   "name": "addsearch-js-client",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "AddSearch API JavaScript client",
   "main": "index.js",
   "jsdelivr": "./dist/addsearch-js-client.min.js",

package.json

@@ -80,7 +80,10 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
         settingToQueryParam(settings.jwt, 'jwt') +
         settingToQueryParam(settings.resultType, 'resultType') +
         settingToQueryParam(settings.userToken, 'userToken') +
-        settingToQueryParam(settings.numFacets, 'numFacets');
+        settingToQueryParam(settings.numFacets, 'numFacets') +
+        settingToQueryParam(settings.cacheResponseTime, 'cacheResponseWithTtlSeconds') +
+        settingToQueryParam(settings.searchOperator, 'defaultOperator') +
+        settingToQueryParam(settings.analyticsTag, 'analyticsTag');
 
       // Add custom field filters
       if (settings.customFieldFilters) {

src/apifetch.js

@@ -163,19 +163,23 @@ var client = function(sitekey, privatekey) {
   this.setShuffleAndLimitTo = function(shuffleAndLimitTo) { this.settings.setShuffleAndLimitTo(shuffleAndLimitTo); }
   this.setFuzzyMatch = function(fuzzy) { this.settings.setFuzzyMatch(fuzzy); }
   this.setPostfixWildcard = function(wildcard) { this.settings.setPostfixWildcard(wildcard); }
+  this.setCacheResponseTime = function(cacheResponseTime) { this.settings.setCacheResponseTime(cacheResponseTime) }
   this.setCollectAnalytics = function(collectAnalytics) { this.settings.setCollectAnalytics(collectAnalytics); }
+  this.setAnalyticsTag = function(tagName) { this.settings.setAnalyticsTag(tagName) }
   this.setThrottleTime = function(delay) { this.settings.setThrottleTime(delay); }
   this.setStatsSessionId = function(id) { this.sessionId = id; }
   this.getStatsSessionId = function() { return this.sessionId; }
   this.enableLogicalOperators = function(enableLogicalOperators) { this.settings.enableLogicalOperators(enableLogicalOperators) }
+  this.setSearchOperator = function(operator) { this.settings.setSearchOperator(operator) }
 
   this.sendStatsEvent = function(type, keyword, data) {
     if (type === 'search') {
       var data = {
         action: 'search',
         session: this.sessionId,
         keyword: keyword,
-        numberOfResults: data.numberOfResults
+        numberOfResults: data.numberOfResults,
+        analyticsTag: this.getSettings().analyticsTag
       };
       sendStats(this.apiHostname, this.sitekey, data);
     }
@@ -186,7 +190,8 @@ var client = function(sitekey, privatekey) {
         session: this.sessionId,
         keyword: keyword,
         docid: data.documentId,
-        position: data.position
+        position: data.position,
+        analyticsTag: this.getSettings().analyticsTag
       };
       sendStats(this.apiHostname, this.sitekey, data);
     }

src/index.js

@@ -19,7 +19,9 @@ var settings = function() {
     autocomplete: {
       size: 10
     },
-    enableLogicalOperators: false
+    searchOperator: null,
+    enableLogicalOperators: false,
+    cacheResponseTime: null
   };
 
   this.getSettings = function() {
@@ -73,6 +75,10 @@ var settings = function() {
     this.settings.enableLogicalOperators = enableLogicalOperators;
   }
 
+  this.setCacheResponseTime = function(cacheResponseTime) {
+    this.settings.cacheResponseTime = cacheResponseTime;
+  }
+
   this.setPostfixWildcard = function(wildcard) {
     this.settings.postfixWildcard = wildcard;
   }
@@ -81,6 +87,10 @@ var settings = function() {
     this.settings.collectAnalytics = collectAnalytics;
   }
 
+  this.setAnalyticsTag = function(tagName) {
+    this.settings.analyticsTag = tagName;
+  }
+
   this.setCategoryFilters = function(categories) {
     this.settings.categories = categories;
   }
@@ -208,6 +218,13 @@ var settings = function() {
       this.settings.paging.page = this.settings.paging.page - 1;
     }
   }
+
+  this.setSearchOperator = function(operator) {
+    if (operator !== 'and' && operator !== 'or') {
+      throw "operator must be 'and' || 'or'"
+    }
+    this.settings.searchOperator = operator;
+  }
 }
 
 module.exports = settings;