@constructor-io/constructorio-client-javascript 2.37.0 → 2.37.2

package/lib/modules/search.js

@@ -1,114 +1,109 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 /* eslint-disable complexity */
-
 /* eslint-disable max-len */
-
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 var EventDispatcher = require('../utils/event-dispatcher');
+var helpers = require('../utils/helpers');
 
-var helpers = require('../utils/helpers'); // Create URL from supplied query (term) and parameters
-
-
+// Create URL from supplied query (term) and parameters
 function createSearchUrl(query, parameters, options) {
   var isVoiceSearch = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
   var apiKey = options.apiKey,
-      version = options.version,
-      serviceUrl = options.serviceUrl,
-      sessionId = options.sessionId,
-      clientId = options.clientId,
-      userId = options.userId,
-      segments = options.segments,
-      testCells = options.testCells;
+    version = options.version,
+    serviceUrl = options.serviceUrl,
+    sessionId = options.sessionId,
+    clientId = options.clientId,
+    userId = options.userId,
+    segments = options.segments,
+    testCells = options.testCells;
   var queryParams = {
     c: version
   };
   queryParams.key = apiKey;
   queryParams.i = clientId;
-  queryParams.s = sessionId; // Validate query (term) is provided
+  queryParams.s = sessionId;
 
+  // Validate query (term) is provided
   if (!query || typeof query !== 'string') {
     throw new Error('query is a required parameter of type string');
-  } // Pull test cells from options
-
+  }
 
+  // Pull test cells from options
   if (testCells) {
     Object.keys(testCells).forEach(function (testCellKey) {
       queryParams["ef-".concat(testCellKey)] = testCells[testCellKey];
     });
-  } // Pull user segments from options
-
+  }
 
+  // Pull user segments from options
   if (segments && segments.length) {
     queryParams.us = segments;
-  } // Pull user id from options and ensure string
-
+  }
 
+  // Pull user id from options and ensure string
   if (userId) {
     queryParams.ui = String(userId);
   }
-
   if (parameters) {
     var offset = parameters.offset,
-        page = parameters.page,
-        resultsPerPage = parameters.resultsPerPage,
-        filters = parameters.filters,
-        sortBy = parameters.sortBy,
-        sortOrder = parameters.sortOrder,
-        section = parameters.section,
-        fmtOptions = parameters.fmtOptions,
-        hiddenFields = parameters.hiddenFields,
-        hiddenFacets = parameters.hiddenFacets,
-        variationsMap = parameters.variationsMap,
-        qsParam = parameters.qsParam,
-        preFilterExpression = parameters.preFilterExpression; // Pull offset from parameters
-
+      page = parameters.page,
+      resultsPerPage = parameters.resultsPerPage,
+      filters = parameters.filters,
+      sortBy = parameters.sortBy,
+      sortOrder = parameters.sortOrder,
+      section = parameters.section,
+      fmtOptions = parameters.fmtOptions,
+      hiddenFields = parameters.hiddenFields,
+      hiddenFacets = parameters.hiddenFacets,
+      variationsMap = parameters.variationsMap,
+      qsParam = parameters.qsParam,
+      preFilterExpression = parameters.preFilterExpression;
+
+    // Pull offset from parameters
     if (!helpers.isNil(offset)) {
       queryParams.offset = offset;
-    } // Pull page from parameters
-
+    }
 
+    // Pull page from parameters
     if (!helpers.isNil(page)) {
       queryParams.page = page;
-    } // Pull results per page from parameters
-
+    }
 
+    // Pull results per page from parameters
     if (!helpers.isNil(resultsPerPage)) {
       queryParams.num_results_per_page = resultsPerPage;
-    } // Pull filters from parameters
-
+    }
 
+    // Pull filters from parameters
     if (filters) {
       queryParams.filters = filters;
-    } // Pull sort by from parameters
-
+    }
 
+    // Pull sort by from parameters
     if (sortBy) {
       queryParams.sort_by = sortBy;
-    } // Pull sort order from parameters
-
+    }
 
+    // Pull sort order from parameters
     if (sortOrder) {
       queryParams.sort_order = sortOrder;
-    } // Pull section from parameters
-
+    }
 
+    // Pull section from parameters
     if (section) {
       queryParams.section = section;
-    } // Pull format options from parameters
-
+    }
 
+    // Pull format options from parameters
     if (fmtOptions) {
       queryParams.fmt_options = fmtOptions;
-    } // Pull hidden fields from parameters
-
+    }
 
+    // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
         queryParams.fmt_options.hidden_fields = hiddenFields;
@@ -117,9 +112,9 @@ function createSearchUrl(query, parameters, options) {
           hidden_fields: hiddenFields
         };
       }
-    } // Pull hidden facets from parameters
-
+    }
 
+    // Pull hidden facets from parameters
     if (hiddenFacets) {
       if (queryParams.fmt_options) {
         queryParams.fmt_options.hidden_facets = hiddenFacets;
@@ -128,30 +123,30 @@ function createSearchUrl(query, parameters, options) {
           hidden_facets: hiddenFacets
         };
       }
-    } // Pull variations map from parameters
-
+    }
 
+    // Pull variations map from parameters
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
-    } // Pull pre_filter_expression from parameters
-
+    }
 
+    // Pull pre_filter_expression from parameters
     if (preFilterExpression) {
       queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
-    } // pull qs param from parameters
-
+    }
 
+    // pull qs param from parameters
     if (qsParam) {
       queryParams.qs = JSON.stringify(qsParam);
     }
   }
-
   queryParams._dt = Date.now();
   queryParams = helpers.cleanParams(queryParams);
   var queryString = helpers.stringify(queryParams);
   var searchUrl = isVoiceSearch ? 'search/natural_language' : 'search';
   return "".concat(serviceUrl, "/").concat(searchUrl, "/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query)), "?").concat(queryString);
 }
+
 /**
  * Interface to search related API calls
  *
@@ -159,14 +154,13 @@ function createSearchUrl(query, parameters, options) {
  * @inner
  * @returns {object}
  */
-
-
 var Search = /*#__PURE__*/function () {
   function Search(options) {
     (0, _classCallCheck2["default"])(this, Search);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
+
   /**
    * Retrieve search results from API
    *
@@ -199,38 +193,32 @@ var Search = /*#__PURE__*/function () {
    *     },
    * });
    */
-
-
   (0, _createClass2["default"])(Search, [{
     key: "getSearchResults",
     value: function getSearchResults(query, parameters) {
       var _this = this;
-
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
       var requestUrl;
       var fetch = this.options.fetch;
       var signal;
-
       if (typeof AbortController === 'function') {
         var controller = new AbortController();
-        signal = controller && controller.signal; // Handle network timeout if specified
+        signal = controller && controller.signal;
 
+        // Handle network timeout if specified
         helpers.applyNetworkTimeout(this.options, networkParameters, controller);
       }
-
       try {
         requestUrl = createSearchUrl(query, parameters, this.options);
       } catch (e) {
         return Promise.reject(e);
       }
-
       return fetch(requestUrl, {
         signal: signal
       }).then(function (response) {
         if (response.ok) {
           return response.json();
         }
-
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
         // Search results
@@ -242,22 +230,19 @@ var Search = /*#__PURE__*/function () {
               result.result_id = json.result_id;
             });
           }
-
           _this.eventDispatcher.queue('search.getSearchResults.completed', json);
-
           return json;
-        } // Redirect rules
-
+        }
 
+        // Redirect rules
         if (json.response && json.response.redirect) {
           _this.eventDispatcher.queue('search.getSearchResults.completed', json);
-
           return json;
         }
-
         throw new Error('getSearchResults response data is malformed');
       });
     }
+
     /**
      * Retrieve voice search results from API
      *
@@ -282,38 +267,33 @@ var Search = /*#__PURE__*/function () {
      * @example
      * constructorio.search.getVoiceSearchResults('show me lipstick');
      */
-
   }, {
     key: "getVoiceSearchResults",
     value: function getVoiceSearchResults(query, parameters) {
       var _this2 = this;
-
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
       var requestUrl;
       var fetch = this.options.fetch;
       var signal;
-
       if (typeof AbortController === 'function') {
         var controller = new AbortController();
-        signal = controller && controller.signal; // Handle network timeout if specified
+        signal = controller && controller.signal;
 
+        // Handle network timeout if specified
         helpers.applyNetworkTimeout(this.options, networkParameters, controller);
       }
-
       try {
         var isVoiceSearch = true;
         requestUrl = createSearchUrl(query, parameters, this.options, isVoiceSearch);
       } catch (e) {
         return Promise.reject(e);
       }
-
       return fetch(requestUrl, {
         signal: signal
       }).then(function (response) {
         if (response.ok) {
           return response.json();
         }
-
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
         // Search results
@@ -325,24 +305,19 @@ var Search = /*#__PURE__*/function () {
               result.result_id = json.result_id;
             });
           }
-
           _this2.eventDispatcher.queue('search.getVoiceSearchResults.completed', json);
-
           return json;
-        } // Redirect rules
-
+        }
 
+        // Redirect rules
         if (json.response && json.response.redirect) {
           _this2.eventDispatcher.queue('search.getVoiceSearchResults.completed', json);
-
           return json;
         }
-
         throw new Error('getVoiceSearchResults response data is malformed');
       });
     }
   }]);
   return Search;
 }();
-
 module.exports = Search;