Add search suggestions

Author: anttiai

README.md

@@ -45,6 +45,13 @@ client.search('keyword', callback);
 client.search(callback);
 ```
 
+#### Fetch search suggestions
+```js
+// Configure Search suggestions on AddSearch Dashboard first
+// Get suggestions starting with a specific prefix
+client.suggestions('a', callback);
+```
+
 #### Use fuzzy matching
 ```js
 // Enable/disable fuzzy matching used in typo tolerance (default "true")

src/apifetch.js

@@ -25,36 +25,47 @@ var executeApiFetch = function(sitekey, type, settings, cb) {
     return;
   }
 
-  // Keyword
-  let kw = settings.keyword;
+  // Keyword and query string
+  var kw = '';
+  var qs = '';
 
-  // Boolean operators (AND, OR, NOT) uppercase
-  kw = kw.replace(/ and /g, ' AND ').replace(/ or /g, ' OR ').replace(/ not /g, ' NOT ');
+  // Search
+  if (type === 'search') {
+    // Keyword
+    kw = settings.keyword;
 
-  // Escape
-  kw = encodeURIComponent(kw);
+    // Boolean operators (AND, OR, NOT) uppercase
+    kw = kw.replace(/ and /g, ' AND ').replace(/ or /g, ' OR ').replace(/ not /g, ' NOT ');
 
-  // Construct query string from settings
-  var qs = '';
-  if (type === 'search') {
-    qs = settingToQueryParam(settings.lang, 'lang') +
-         settingToQueryParam(settings.fuzzy, 'fuzzy') +
-         settingToQueryParam(settings.categories, 'categories') +
-         settingToQueryParam(settings.dateFrom, 'dateFrom') +
-         settingToQueryParam(settings.dateTo, 'dateTo') +
-         settingToQueryParam(settings.paging.page, 'page') +
-         settingToQueryParam(settings.paging.pageSize, 'limit') +
-         settingToQueryParam(settings.paging.sortBy, 'sort') +
-         settingToQueryParam(settings.paging.sortOrder, 'order');
+    // Escape
+    kw = encodeURIComponent(kw);
 
-    // Add custom field filters
-    if (settings.customFieldFilters) {
-      for (var i=0; i<settings.customFieldFilters.length; i++) {
-        qs = qs + '&customField=' + settings.customFieldFilters[i];
+    // Construct query string from settings
+    if (type === 'search') {
+      qs = settingToQueryParam(settings.lang, 'lang') +
+        settingToQueryParam(settings.fuzzy, 'fuzzy') +
+        settingToQueryParam(settings.categories, 'categories') +
+        settingToQueryParam(settings.dateFrom, 'dateFrom') +
+        settingToQueryParam(settings.dateTo, 'dateTo') +
+        settingToQueryParam(settings.paging.page, 'page') +
+        settingToQueryParam(settings.paging.pageSize, 'limit') +
+        settingToQueryParam(settings.paging.sortBy, 'sort') +
+        settingToQueryParam(settings.paging.sortOrder, 'order');
+
+      // Add custom field filters
+      if (settings.customFieldFilters) {
+        for (var i = 0; i < settings.customFieldFilters.length; i++) {
+          qs = qs + '&customField=' + settings.customFieldFilters[i];
+        }
       }
     }
   }
 
+  // Suggest
+  else if (type === 'suggest') {
+    kw = settings.suggestionsPrefix;
+  }
+
 
   // Execute API call
   fetch('https://api.addsearch.com/v1/' + type + '/' + sitekey + '?term=' + kw + qs)

src/index.js

@@ -46,7 +46,11 @@ var client = function(sitekey) {
    *
    * @param keyword
    */
-  this.suggest = function(keyword, callback) {
+  this.suggestions = function(prefix, callback) {
+    if (!prefix || !callback || !util.isFunction(callback)) {
+      throw "Illegal suggestions parameters. Should be (prefix, callbackFunction)";
+    }
+    this.settings.setSuggestionsPrefix(prefix);
     executeApiFetch(this.sitekey, 'suggest', this.settings.getSettings(), callback);
   }
 

src/settings.js

@@ -21,6 +21,10 @@ var settings = function() {
     this.settings.keyword = keyword || '*';
   }
 
+  this.setSuggestionsPrefix = function(prefix) {
+    this.settings.suggestionsPrefix = prefix;
+  }
+
   this.setLanguage = function(language) {
     if (language && language.length !== 2) {
       throw "use 2-char language code (e.g. \"en\")";