Merge pull request #3 from AddSearch/autocomplete

Autocomplete

Author: anttiai

README.md

@@ -57,18 +57,33 @@ client.search();
 ```
 
 #### Fetch search suggestions
+Search suggestions are keywords and search phrases that real users have used in your search. Configure Search 
+suggestions on AddSearch Dashboard before using this function.
 ```js
-// Configure Search suggestions on AddSearch Dashboard first
 // Get suggestions starting with a specific prefix
 client.suggestions('a', callback);
 ```
 
-#### Number of search suggestions
+#### Set the number of search suggestions to fetch
 ```js
 // Number of search suggestions to fetch (default 10)
 client.setSuggestionsSize(20);
 ```
 
+#### Fetch custom field autocompletion
+Custom fields autocomplete can be used for predictive search. For example, product names or categories can be
+suggested as the keyword is being typed in.
+```js
+// Fetch custom field values starting with a specific prefix. In this example, results could be "adidas, apple, azure"
+client.autocomplete('custom_fields.brand', 'a', callback);
+```
+
+#### Set the number of custom field autocompletion results to fetch
+```js
+// Number of autocompletion results to fetch (default 10)
+client.setAutocompleteSize(20);
+```
+
 #### Search with fuzzy matching
 ```js
 // Enable/disable fuzzy matching. Possible values true/false/"auto" (default: "auto")
@@ -163,6 +178,22 @@ client.removeCustomFieldFilter('city','paris');
 client.removeCustomFieldFilter('city');
 ```
 
+#### Set filtering object
+Set complex filtering object that can contain nested *and*, *or*, *not*, and *range* filters. 
+
+```js
+// Find results where brand is apple, color is not white, and price is between 200 and 500
+var filter = {
+  'and':[
+     {'custom_fields.brand': 'apple'},
+     {'not': {'custom_fields.color': 'white'}},
+     {'range': {'custom_fields.price': {'gt': 200, 'lt':500}}}
+   ]
+};
+
+client.setFilterObject(filter);
+```
+
 #### Manage paging
 Set page number, page size and sorting parameters. It's possible to order results by:
 - relevance (descending)

package.json

@@ -40,16 +40,16 @@
     "isomorphic-fetch": "^2.2.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.3",
-    "@babel/core": "^7.8.3",
-    "@babel/preset-env": "^7.8.3",
-    "@babel/register": "^7.8.3",
+    "@babel/cli": "^7.8.4",
+    "@babel/core": "^7.8.4",
+    "@babel/preset-env": "^7.8.4",
+    "@babel/register": "^7.7.7",
     "babel-loader": "^8.0.6",
     "esm": "^3.2.25",
-    "fetch-mock": "^8.3.1",
-    "mocha": "^7.0.0",
+    "fetch-mock": "^8.3.2",
+    "mocha": "^6.2.2",
     "node-fetch": "^2.6.0",
-    "uglify-js": "^3.7.6",
+    "uglify-js": "^3.7.7",
     "webpack": "^4.41.5",
     "webpack-cli": "^3.3.10"
   }

src/apifetch.js

@@ -20,7 +20,7 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
 
 
   // Validate query type
-  if (type !== 'search' && type !== 'suggest') {
+  if (type !== 'search' && type !== 'suggest' && type !== 'autocomplete') {
     cb({error: {response: RESPONSE_BAD_REQUEST, message: 'invalid query type'}});
     return;
   }
@@ -29,8 +29,14 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
   var kw = '';
   var qs = '';
 
+  // API Path (eq. /search, /suggest, /autocomplete/document-field)
+  var apiPath = null;
+
   // Search
   if (type === 'search') {
+    // Path
+    apiPath = type;
+
     // Keyword
     kw = settings.keyword;
 
@@ -93,13 +99,22 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
 
   // Suggest
   else if (type === 'suggest') {
+    apiPath = type;
     qs = settingToQueryParam(settings.suggestionsSize, 'size');
     kw = settings.suggestionsPrefix;
   }
 
+  // Autocomplete
+  else if (type === 'autocomplete') {
+    apiPath = 'autocomplete/document-field';
+    qs = settingToQueryParam(settings.autocomplete.field, 'source') +
+         settingToQueryParam(settings.autocomplete.size, 'size');
+    kw = settings.autocomplete.prefix;
+  }
+
 
   // Execute API call
-  fetch('https://api.addsearch.com/v1/' + type + '/' + sitekey + '?term=' + kw + qs)
+  fetch('https://api.addsearch.com/v1/' + apiPath + '/' + sitekey + '?term=' + kw + qs)
     .then(function(response) {
       return response.json();
     }).then(function(json) {

src/index.js

@@ -62,6 +62,20 @@ var client = function(sitekey) {
   }
 
 
+  /**
+   * Fetch field autocompletes
+   *
+   * @param keyword
+   */
+  this.autocomplete = function(field, prefix, callback) {
+    if (!field || !prefix || !callback || !util.isFunction(callback)) {
+      throw "Illegal autocomplete parameters. Should be (field, prefix, callbackFunction)";
+    }
+    this.settings.setAutocompleteParams(field, prefix);
+    executeApiFetch(this.sitekey, 'autocomplete', this.settings.getSettings(), callback);
+  }
+
+
   /**
    * Public functions
    */
@@ -78,6 +92,7 @@ var client = function(sitekey) {
   this.nextPage = function() { this.settings.nextPage(); }
   this.previousPage = function() { this.settings.previousPage(); }
   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.setNumberOfFacets = function(numFacets) { this.settings.setNumberOfFacets(numFacets); }
   this.setResultType = function(type) { this.settings.setResultType(type); }

src/settings.js

@@ -14,7 +14,10 @@ var settings = function() {
     customFieldFilters: [],
     userToken: null,
     suggestionsSize: 10,
-    facetFields: []
+    facetFields: [],
+    autocomplete: {
+      size: 10
+    }
   };
 
   this.getSettings = function() {
@@ -37,6 +40,15 @@ var settings = function() {
     this.settings.suggestionsSize = size;
   }
 
+  this.setAutocompleteSize = function(size) {
+    this.settings.autocomplete.size = size;
+  }
+
+  this.setAutocompleteParams = function(field, prefix) {
+    this.settings.autocomplete.field = field;
+    this.settings.autocomplete.prefix = prefix;
+  }
+
   this.setLanguage = function(language) {
     if (language && language.length !== 2) {
       throw "use 2-char language code (e.g. \"en\")";