@constructor-io/constructorio-client-javascript 2.27.2 → 2.27.6

package/lib/modules/autocomplete.js

@@ -82,7 +82,13 @@ function createAutocompleteUrl(query, parameters, options) {
 
 
     if (hiddenFields) {
-      queryParams.hidden_fields = hiddenFields;
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = {
+          hidden_fields: hiddenFields
+        };
+      }
     }
   }
 

package/lib/modules/browse.js

@@ -12,6 +12,8 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 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 max-len */
+
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 var qs = require('qs');
 
@@ -63,7 +65,8 @@ function createQueryParams(parameters, options) {
         sortOrder = parameters.sortOrder,
         section = parameters.section,
         fmtOptions = parameters.fmtOptions,
-        hiddenFields = parameters.hiddenFields; // Pull page from parameters
+        hiddenFields = parameters.hiddenFields,
+        hiddenFacets = parameters.hiddenFacets; // Pull page from parameters
 
     if (!helpers.isNil(page)) {
       queryParams.page = page;
@@ -100,7 +103,24 @@ function createQueryParams(parameters, options) {
 
 
     if (hiddenFields) {
-      queryParams.hidden_fields = hiddenFields;
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = {
+          hidden_fields: hiddenFields
+        };
+      }
+    } // Pull hidden facets from parameters
+
+
+    if (hiddenFacets) {
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_facets = hiddenFacets;
+      } else {
+        queryParams.fmt_options = {
+          hidden_facets: hiddenFacets
+        };
+      }
     }
   }
 
@@ -154,13 +174,29 @@ function createBrowseUrlForFacets(parameters, options) {
   var queryParams = _objectSpread({}, createQueryParams(parameters, options)); // Endpoint does not accept _dt
 
 
-  delete queryParams._dt; // fmt_options would require a token to be passed along
-
-  delete queryParams.fmt_options;
+  delete queryParams._dt;
   var queryString = qs.stringify(queryParams, {
     indices: false
   });
   return "".concat(serviceUrl, "/browse/facets?").concat(queryString);
+} // Create URL from supplied facet name and parameters
+
+
+function createBrowseUrlForFacetOptions(facetName, parameters, options) {
+  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)); // Endpoint does not accept _dt
+
+
+  delete queryParams._dt;
+  var queryString = qs.stringify(queryParams, {
+    indices: false
+  });
+  return "".concat(serviceUrl, "/browse/facet_options?facet_name=").concat(facetName, "&").concat(queryString);
 }
 /**
  * Interface to browse related API calls
@@ -192,6 +228,7 @@ var Browse = /*#__PURE__*/function () {
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
+   * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -269,6 +306,8 @@ var Browse = /*#__PURE__*/function () {
      * @param {string} [parameters.sortBy='relevance'] - The sort method for results
      * @param {string} [parameters.sortOrder='descending'] - The sort order for results
      * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
+     * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
+     * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}
@@ -402,6 +441,7 @@ var Browse = /*#__PURE__*/function () {
      * @function getBrowseFacets
      * @param {object} [parameters] - Additional parameters to refine result set
      * @param {number} [parameters.page] - The page number of the results
+     * @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
      * @param {number} [parameters.resultsPerPage] - The number of results per page to return
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -456,6 +496,68 @@ var Browse = /*#__PURE__*/function () {
         throw new Error('getBrowseFacets response data is malformed');
       });
     }
+    /**
+     * Retrieve facet options from API
+     *
+     * @function getBrowseFacetOptions
+     * @param {string} facetName - Name of the facet whose options to return
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @param {object} [parameters] - Additional parameters to refine result set
+     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
+     * @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
+     * @param {}
+     * @returns {Promise}
+     * @see https://docs.constructor.io/rest_api/browse/facet_options/
+     * @example
+     * 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 && this.options.fetch || fetchPonyfill({
+        Promise: Promise
+      }).fetch;
+      var signal;
+
+      if (typeof AbortController === 'function') {
+        var controller = new AbortController();
+        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;
 }();

package/lib/modules/search.js

@@ -6,6 +6,8 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
+/* eslint-disable max-len */
+
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 var qs = require('qs');
 
@@ -63,7 +65,8 @@ function createSearchUrl(query, parameters, options) {
         sortOrder = parameters.sortOrder,
         section = parameters.section,
         fmtOptions = parameters.fmtOptions,
-        hiddenFields = parameters.hiddenFields; // Pull page from parameters
+        hiddenFields = parameters.hiddenFields,
+        hiddenFacets = parameters.hiddenFacets; // Pull page from parameters
 
     if (!helpers.isNil(page)) {
       queryParams.page = page;
@@ -101,7 +104,24 @@ function createSearchUrl(query, parameters, options) {
 
 
     if (hiddenFields) {
-      queryParams.hidden_fields = hiddenFields;
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = {
+          hidden_fields: hiddenFields
+        };
+      }
+    } // Pull hidden facets from parameters
+
+
+    if (hiddenFacets) {
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_facets = hiddenFacets;
+      } else {
+        queryParams.fmt_options = {
+          hidden_facets: hiddenFacets
+        };
+      }
     }
   }
 
@@ -142,6 +162,7 @@ var Search = /*#__PURE__*/function () {
    * @param {string} [parameters.section='Products'] - The section name for results
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
+   * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.27.2",
+  "version": "2.27.6",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {
@@ -61,7 +61,7 @@
     "sinon-chai": "^3.7.0"
   },
   "dependencies": {
-    "@constructor-io/constructorio-id": "^2.4.8",
+    "@constructor-io/constructorio-id": "^2.4.9",
     "crc-32": "^1.2.0",
     "es6-promise": "^4.2.8",
     "events": "^3.0.0",