@constructor-io/constructorio-client-javascript 2.36.4 → 2.37.1

package/lib/modules/browse.js

@@ -1,108 +1,101 @@
 "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"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
 /* eslint-disable object-curly-newline, no-underscore-dangle, max-len, complexity */
 var EventDispatcher = require('../utils/event-dispatcher');
+var helpers = require('../utils/helpers');
 
-var helpers = require('../utils/helpers'); // Create query params from parameters and options
-
-
+// Create query params from parameters and options
 function createQueryParams(parameters, options) {
   var apiKey = options.apiKey,
-      version = options.version,
-      sessionId = options.sessionId,
-      clientId = options.clientId,
-      userId = options.userId,
-      segments = options.segments,
-      testCells = options.testCells;
+    version = options.version,
+    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; // Pull test cells from options
+  queryParams.s = sessionId;
 
+  // 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 page = parameters.page,
-        offset = parameters.offset,
-        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 page from parameters
-
+      offset = parameters.offset,
+      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 page from parameters
     if (!helpers.isNil(page)) {
       queryParams.page = page;
-    } // Pull offset from parameters
-
+    }
 
+    // Pull offset from parameters
     if (!helpers.isNil(offset)) {
       queryParams.offset = offset;
-    } // Pull results per page from parameters
-
+    }
 
+    // Pull results per page from parameters
     if (!helpers.isNil(resultsPerPage)) {
       queryParams.num_results_per_page = resultsPerPage;
     }
-
     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;
@@ -111,9 +104,9 @@ function createQueryParams(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;
@@ -122,91 +115,89 @@ function createQueryParams(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);
   return queryParams;
-} // Create URL from supplied filter name, value and parameters
-
+}
 
+// Create URL from supplied filter name, value and parameters
 function createBrowseUrlFromFilter(filterName, filterValue, parameters, options) {
-  var serviceUrl = options.serviceUrl; // Validate filter name is provided
+  var serviceUrl = options.serviceUrl;
 
+  // Validate filter name is provided
   if (!filterName || typeof filterName !== 'string') {
     throw new Error('filterName is a required parameter of type string');
-  } // Validate filter value is provided
-
+  }
 
+  // Validate filter value is provided
   if (!filterValue || typeof filterValue !== 'string') {
     throw new Error('filterValue is a required parameter of type string');
   }
-
   var queryParams = createQueryParams(parameters, options);
   var queryString = helpers.stringify(queryParams);
   return "".concat(serviceUrl, "/browse/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterName)), "/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterValue)), "?").concat(queryString);
-} // Create URL from supplied id's
-
+}
 
+// Create URL from supplied id's
 function createBrowseUrlFromIDs(ids, parameters, options) {
-  var serviceUrl = options.serviceUrl; // Validate id's are provided
+  var serviceUrl = options.serviceUrl;
 
+  // Validate id's are provided
   if (!ids || !Array.isArray(ids) || !ids.length) {
     throw new Error('ids is a required parameter of type array');
   }
-
   var queryParams = _objectSpread(_objectSpread({}, createQueryParams(parameters, options)), {}, {
     ids: ids
   });
-
   var queryString = helpers.stringify(queryParams);
   return "".concat(serviceUrl, "/browse/items?").concat(queryString);
-} // Create URL for facets
-
+}
 
+// Create URL for facets
 function createBrowseUrlForFacets(parameters, options) {
   var serviceUrl = options.serviceUrl;
+  var queryParams = _objectSpread({}, createQueryParams(parameters, options));
 
-  var queryParams = _objectSpread({}, createQueryParams(parameters, options)); // Endpoint does not accept _dt
-
-
+  // Endpoint does not accept _dt
   delete queryParams._dt;
   var queryString = helpers.stringify(queryParams);
   return "".concat(serviceUrl, "/browse/facets?").concat(queryString);
-} // Create URL from supplied facet name and parameters
-
+}
 
+// Create URL from supplied facet name and parameters
 function createBrowseUrlForFacetOptions(facetName, parameters, options) {
-  var serviceUrl = options.serviceUrl; // Validate facet name is provided
+  var serviceUrl = options.serviceUrl;
 
+  // Validate facet name is provided
   if (!facetName || typeof facetName !== 'string') {
     throw new Error('facetName is a required parameter of type string');
   }
-
   var queryParams = _objectSpread({}, createQueryParams(parameters, options));
+  queryParams.facet_name = facetName;
 
-  queryParams.facet_name = facetName; // Endpoint does not accept _dt
-
+  // Endpoint does not accept _dt
   delete queryParams._dt;
   var queryString = helpers.stringify(queryParams);
   return "".concat(serviceUrl, "/browse/facet_options?").concat(queryString);
 }
+
 /**
  * Interface to browse related API calls
  *
@@ -214,14 +205,13 @@ function createBrowseUrlForFacetOptions(facetName, parameters, options) {
  * @inner
  * @returns {object}
  */
-
-
 var Browse = /*#__PURE__*/function () {
   function Browse(options) {
     (0, _classCallCheck2["default"])(this, Browse);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
+
   /**
    * Retrieve browse results from API
    *
@@ -255,38 +245,32 @@ var Browse = /*#__PURE__*/function () {
    *     },
    * });
    */
-
-
   (0, _createClass2["default"])(Browse, [{
     key: "getBrowseResults",
     value: function getBrowseResults(filterName, filterValue, parameters) {
       var _this = this;
-
       var networkParameters = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
       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 = createBrowseUrlFromFilter(filterName, filterValue, 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) {
         if (json.response && json.response.results) {
@@ -297,15 +281,13 @@ var Browse = /*#__PURE__*/function () {
               result.result_id = json.result_id;
             });
           }
-
           _this.eventDispatcher.queue('browse.getBrowseResults.completed', json);
-
           return json;
         }
-
         throw new Error('getBrowseResults response data is malformed');
       });
     }
+
     /**
      * Retrieve browse results from API using item id's
      *
@@ -334,37 +316,32 @@ var Browse = /*#__PURE__*/function () {
      *     },
      * });
      */
-
   }, {
     key: "getBrowseResultsForItemIds",
     value: function getBrowseResultsForItemIds(itemIds, 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 {
         requestUrl = createBrowseUrlFromIDs(itemIds, 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) {
         if (json.response && json.response.results) {
@@ -375,15 +352,13 @@ var Browse = /*#__PURE__*/function () {
               result.result_id = json.result_id;
             });
           }
-
           _this2.eventDispatcher.queue('browse.getBrowseResultsForItemIds.completed', json);
-
           return json;
         }
-
         throw new Error('getBrowseResultsForItemIds response data is malformed');
       });
     }
+
     /**
      * Retrieve browse groups from API
      *
@@ -405,25 +380,22 @@ var Browse = /*#__PURE__*/function () {
      *     }
      * });
      */
-
   }, {
     key: "getBrowseGroups",
     value: function getBrowseGroups(parameters) {
       var _this3 = this;
-
       var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var fetch = this.options.fetch;
       var serviceUrl = this.options.serviceUrl;
       var queryParams = createQueryParams(parameters, this.options);
       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);
       }
-
       delete queryParams._dt;
       var queryString = helpers.stringify(queryParams);
       var requestUrl = "".concat(serviceUrl, "/browse/groups?").concat(queryString);
@@ -433,18 +405,16 @@ var Browse = /*#__PURE__*/function () {
         if (response.ok) {
           return response.json();
         }
-
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
         if (json.response && json.response.groups) {
           _this3.eventDispatcher.queue('browse.getBrowseGroups.completed', json);
-
           return json;
         }
-
         throw new Error('getBrowseGroups response data is malformed');
       });
     }
+
     /**
      * Retrieve browse facets from API
      *
@@ -465,47 +435,41 @@ var Browse = /*#__PURE__*/function () {
      *     resultsPerPage: 10,
      * });
      */
-
   }, {
     key: "getBrowseFacets",
     value: function getBrowseFacets(parameters, networkParameters) {
       var _this4 = this;
-
       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 = createBrowseUrlForFacets(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) {
         if (json.response && json.response.facets) {
           _this4.eventDispatcher.queue('browse.getBrowseFacets.completed', json);
-
           return json;
         }
-
         throw new Error('getBrowseFacets response data is malformed');
       });
     }
+
     /**
      * Retrieve facet options from API
      *
@@ -523,51 +487,43 @@ var Browse = /*#__PURE__*/function () {
      * constructorio.browse.getBrowseFacetOptions('price', {
      * });
      */
-
   }, {
     key: "getBrowseFacetOptions",
     value: function getBrowseFacetOptions(facetName) {
       var _this5 = this;
-
       var parameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       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 = createBrowseUrlForFacetOptions(facetName, 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) {
         if (json.response && json.response.facets) {
           _this5.eventDispatcher.queue('browse.getBrowseFacetOptions.completed', json);
-
           return json;
         }
-
         throw new Error('getBrowseFacetOptions response data is malformed');
       });
     }
   }]);
   return Browse;
 }();
-
 module.exports = Browse;