Merge branch 'master' into webpack-upgrade-and-eslint

# Conflicts:
#	dist/addsearch-js-client.min.js
#	package-lock.json
#	package.json
#	src/index.js

Author: haoAddsearch

README.md

@@ -265,6 +265,17 @@ is handy for applications like range filtering.
 client.addStatsField('custom_fields.price');
 ```
 
+### Recommendations
+#### Frequently bought together items
+Get frequently bought together items, given "configurationKey" and "itemId"
+```js
+// fetch frequently bought together items
+client.recommendations({
+  configurationKey: "config1",
+  itemId: "1065921"
+});
+```
+
 ### Search analytics
 #### Send search event to analytics
 When search is executed, send the event to your AddSearch Analytics Dashboard.

dist/addsearch-js-client.min.js

@@ -1,6 +1,6 @@
 {
   "name": "addsearch-js-client",
-  "version": "0.6.6",
+  "version": "0.7.1",
   "description": "AddSearch API JavaScript client",
   "main": "index.js",
   "jsdelivr": "./dist/addsearch-js-client.min.js",
@@ -36,8 +36,8 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "axios": "^0.27.2",
     "es6-promise": "^4.2.8",
-    "isomorphic-fetch": "^3.0.0",
     "js-base64": "^3.6.0"
   },
   "devDependencies": {
@@ -51,7 +51,6 @@
     "esm": "^3.2.25",
     "fetch-mock": "^9.11.0",
     "mocha": "^8.2.1",
-    "node-fetch": "^2.6.7",
     "uglify-js": "^3.12.0",
     "webpack": "^5.72.0",
     "webpack-cli": "^3.3.12",

package-lock.json

@@ -1,12 +1,12 @@
 'use strict';
 
 require('es6-promise').polyfill();
-require('isomorphic-fetch');
+const axios = require('axios').default;
 
 /**
  * Fetch search results of search suggestions from the Addsearch API
  */
-var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRetry, customFilterObject) {
+var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRetry, customFilterObject, recommendOptions) {
 
   const RESPONSE_BAD_REQUEST = 400;
   const RESPONSE_SERVER_ERROR = 500;
@@ -20,7 +20,7 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
 
 
   // Validate query type
-  if (type !== 'search' && type !== 'suggest' && type !== 'autocomplete') {
+  if (type !== 'search' && type !== 'suggest' && type !== 'autocomplete' && type !== 'recommend') {
     cb({error: {response: RESPONSE_BAD_REQUEST, message: 'invalid query type'}});
     return;
   }
@@ -30,6 +30,7 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
   var qs = '';
 
   // API Path (eq. /search, /suggest, /autocomplete/document-field)
+  var api = null;
   var apiPath = null;
 
   // Search
@@ -137,7 +138,8 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
   // Suggest
   else if (type === 'suggest') {
     apiPath = type;
-    qs = settingToQueryParam(settings.suggestionsSize, 'size');
+    qs = settingToQueryParam(settings.suggestionsSize, 'size') +
+      settingToQueryParam(settings.lang, 'lang');
     kw = settings.suggestionsPrefix;
   }
 
@@ -149,36 +151,42 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
     kw = settings.autocomplete.prefix;
   }
 
+  else if (type === 'recommend') {
+    apiPath = 'recommendations';
+    qs = settingToQueryParam(recommendOptions.itemId, 'itemId');
+  }
 
   // Execute API call
-  fetch('https://' + apiHostname + '/v1/' + apiPath + '/' + sitekey + '?term=' + kw + qs)
-    .then(function(response) {
-      return response.json();
-    }).then(function(json) {
+  api = type === 'recommend' ?
+    'https://' + apiHostname + '/v1/' + apiPath + '/' + sitekey + '?configurationKey=' + recommendOptions.configurationKey + qs :
+    'https://' + apiHostname + '/v1/' + apiPath + '/' + sitekey + '?term=' + kw + qs;
 
-    // Search again with fuzzy=true if no hits
-    if (type === 'search' && settings.fuzzy === 'retry' && json.total_hits === 0 && fuzzyRetry !== true) {
-      executeApiFetch(apiHostname, sitekey, type, settings, cb, true);
-    }
+  axios.get(api)
+    .then(function(response) {
+      var json = response.data;
+      // Search again with fuzzy=true if no hits
+      if (type === 'search' && settings.fuzzy === 'retry' && json.total_hits === 0 && fuzzyRetry !== true) {
+        executeApiFetch(apiHostname, sitekey, type, settings, cb, true);
+      }
 
-    // Fuzzy not "retry" OR fuzzyRetry already returning
-    else {
+      // Fuzzy not "retry" OR fuzzyRetry already returning
+      else {
 
-      // Cap fuzzy results to one page as quality decreases quickly
-      if (fuzzyRetry === true) {
-        var pageSize = settings.paging.pageSize;
-        if (json.total_hits >= pageSize) {
-          json.total_hits = pageSize;
+        // Cap fuzzy results to one page as quality decreases quickly
+        if (fuzzyRetry === true) {
+          var pageSize = settings.paging.pageSize;
+          if (json.total_hits >= pageSize) {
+            json.total_hits = pageSize;
+          }
         }
-      }
 
-      // Callback
-      cb(json);
-    }
-
-  }).catch(function(ex) {
-    console.log(ex);
-    cb({error: {response: RESPONSE_SERVER_ERROR, message: 'invalid server response'}});
-  });
+        // Callback
+        cb(json);
+      }
+    })
+    .catch(function(ex) {
+      console.log(ex);
+      cb({error: {response: RESPONSE_SERVER_ERROR, message: 'invalid server response'}});
+    });
 };
 module.exports = executeApiFetch;

package.json

@@ -103,6 +103,38 @@ var client = function(sitekey, privatekey) {
     executeApiFetch(this.apiHostname, this.sitekey, 'search', settingsCloned, callback, null, customFilterObject);
   }
 
+  /**
+   * Fetch Range Facets
+   */
+  this.fetchRangeFacets = function(options, customFilterObject, callback) {
+    var settingsCloned = Object.assign({}, this.settings.getSettings());
+
+    if (!settingsCloned.rangeFacets) {
+      settingsCloned.rangeFacets = [];
+    }
+    settingsCloned.rangeFacets.push({
+      field: options.field,
+      ranges: options.ranges
+    });
+    executeApiFetch(this.apiHostname, this.sitekey, 'search', settingsCloned, callback, null, customFilterObject);
+  }
+
+  /**
+   * Fetch recommendations
+   *
+   * @param item
+   */
+  this.recommendations = function(options, callback) {
+    if (!options || !callback || !util.isFunction(callback)) {
+      throw "Illegal recommendations parameters. Should be (options, callbackFunction)";
+    }
+
+    if (!this.throttledSuggestionsFetch) {
+      this.throttledSuggestionsFetch = throttle(this.settings.getSettings().throttleTimeMs, executeApiFetch);
+    }
+    this.throttledSuggestionsFetch(this.apiHostname, this.sitekey, 'recommend', null, callback, false, null, options);
+  }
+
   /**
    * Indexing API functions
    */
@@ -182,19 +214,19 @@ var client = function(sitekey, privatekey) {
         numberOfResults: res.numberOfResults,
         analyticsTag: this.getSettings().analyticsTag
       };
-      sendStats(this.apiHostname, this.sitekey, data);
+      sendStats(this.apiHostname, this.sitekey, payload);
     }
 
     else if (type === 'click') {
-      let data = {
+      var payload = {
         action: 'click',
         session: this.sessionId,
         keyword: keyword,
         docid: res.documentId,
         position: res.position,
         analyticsTag: this.getSettings().analyticsTag
       };
-      sendStats(this.apiHostname, this.sitekey, data);
+      sendStats(this.apiHostname, this.sitekey, payload);
     }
 
     else {

src/apifetch.js

@@ -1,8 +1,8 @@
 'use strict';
 
-require('isomorphic-fetch');
 const util = require('./util');
 const Promise = require('es6-promise').Promise;
+const axios = require('axios').default;
 
 const getHeaders = function(sitekey, privatekey) {
   return {
@@ -18,14 +18,13 @@ const getHeaders = function(sitekey, privatekey) {
 var getDocument = function(apiHostname, sitekey, privatekey, id) {
   const promise = new Promise((resolve, reject) => {
 
-    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/' + id,
+    axios.get('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/' + id,
       {
-        method: 'GET',
         headers: getHeaders(sitekey, privatekey)
       })
       .then((response) => {
         if (response.status == 200) {
-          resolve(response.json());
+          resolve(response.data);
         }
         else {
           reject({status: response.status, text: response.statusText});
@@ -44,14 +43,16 @@ var getDocument = function(apiHostname, sitekey, privatekey, id) {
 var saveDocument = function(apiHostname, sitekey, privatekey, document) {
 
   // If the doc has id or url field, PUT instead of POST
+
   const isPut = document.id || document.url;
 
   const promise = new Promise((resolve, reject) => {
-    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/',
+    axios(
       {
-        method: isPut ? 'PUT' : 'POST',
+        url: 'https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/',
+        method: isPut ? 'put' : 'post',
         headers: getHeaders(sitekey, privatekey),
-        body: JSON.stringify(document)
+        data: document
       })
       .then((response) => {
         if (response.status == 202) {
@@ -61,8 +62,8 @@ var saveDocument = function(apiHostname, sitekey, privatekey, document) {
           reject({status: response.status, text: response.statusText});
         }
       }).catch((ex) => {
-      reject({status: 400, text: ex});
-    });
+        reject({status: 400, text: ex});
+      });
   });
 
   return promise;
@@ -75,11 +76,12 @@ var saveDocument = function(apiHostname, sitekey, privatekey, document) {
 var saveDocumentsBatch = function(apiHostname, sitekey, privatekey, documents) {
 
   const promise = new Promise((resolve, reject) => {
-    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents:batch',
+    axios(
       {
-        method: 'PUT',
+        method: 'put',
+        url: 'https://' + apiHostname + '/v2/indices/' + sitekey + '/documents:batch',
         headers: getHeaders(sitekey, privatekey),
-        body: JSON.stringify(documents)
+        data: documents
       })
       .then((response) => {
         if (response.status == 202) {
@@ -102,9 +104,8 @@ var saveDocumentsBatch = function(apiHostname, sitekey, privatekey, documents) {
  */
 var deleteDocument = function(apiHostname, sitekey, privatekey, id) {
   const promise = new Promise((resolve, reject) => {
-    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/' + id,
+    axios.delete('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/' + id,
       {
-        method: 'DELETE',
         headers: getHeaders(sitekey, privatekey)
       })
       .then((response) => {
@@ -128,11 +129,10 @@ var deleteDocument = function(apiHostname, sitekey, privatekey, id) {
  */
 var deleteDocumentsBatch = function(apiHostname, sitekey, privatekey, batch) {
   const promise = new Promise((resolve, reject) => {
-    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents:batch',
+    axios.delete('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents:batch',
       {
-        method: 'DELETE',
         headers: getHeaders(sitekey, privatekey),
-        body: JSON.stringify(batch)
+        data: batch
       })
       .then((response) => {
         if (response.status == 202) {

src/index.js

@@ -1,23 +1,21 @@
 'use strict';
 
 require('es6-promise').polyfill();
-require('isomorphic-fetch');
+const axios = require('axios').default;
 
-var sendStats = function(apiHostname, sitekey, data) {
+var sendStats = function(apiHostname, sitekey, payload) {
 
   // Beacon in browsers
   if (typeof window !== 'undefined' && window.navigator && window.navigator.sendBeacon) {
-    navigator.sendBeacon('https://' + apiHostname + '/v1/stats/' + sitekey + '/', JSON.stringify(data));
+    navigator.sendBeacon('https://' + apiHostname + '/v1/stats/' + sitekey + '/', JSON.stringify(payload));
   }
 
   // POST in node
   else {
-    fetch('https://' + apiHostname + '/v1/stats/' + sitekey + '/', {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'text/plain',
-        },
-        body: JSON.stringify(data)
+    axios.post('https://' + apiHostname + '/v1/stats/' + sitekey + '/', payload, {
+      headers: {
+        'Content-Type': 'text/plain',
+      }
     });
   }
 };