Merge pull request #21 from AddSearch/default-operator-support

add setting 'searchOperator'

Author: haoAddsearch

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**

dist/addsearch-js-client.min.js

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

src/apifetch.js

@@ -160,6 +160,7 @@ var client = function(sitekey, privatekey) {
   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') {

src/index.js

@@ -19,6 +19,7 @@ var settings = function() {
     autocomplete: {
       size: 10
     },
+    searchOperator: null,
     enableLogicalOperators: false,
     cacheResponseTime: null
   };
@@ -213,6 +214,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;