@constructor-io/constructorio-client-javascript 2.27.11 → 2.28.0

package/lib/modules/autocomplete.js

@@ -18,7 +18,9 @@ var EventDispatcher = require('../utils/event-dispatcher');
 var _require = require('../utils/helpers'),
     throwHttpErrorFromResponse = _require.throwHttpErrorFromResponse,
     cleanParams = _require.cleanParams,
-    applyNetworkTimeout = _require.applyNetworkTimeout; // Create URL from supplied query (term) and parameters
+    applyNetworkTimeout = _require.applyNetworkTimeout,
+    trimNonBreakingSpaces = _require.trimNonBreakingSpaces,
+    encodeURIComponentRFC3986 = _require.encodeURIComponentRFC3986; // Create URL from supplied query (term) and parameters
 
 
 function createAutocompleteUrl(query, parameters, options) {
@@ -97,7 +99,9 @@ function createAutocompleteUrl(query, parameters, options) {
   var queryString = qs.stringify(queryParams, {
     indices: false
   });
-  return "".concat(serviceUrl, "/autocomplete/").concat(encodeURIComponent(query), "?").concat(queryString);
+  var cleanedQuery = query.replace(/^\//, '|'); // For compatibility with backend API
+
+  return "".concat(serviceUrl, "/autocomplete/").concat(encodeURIComponentRFC3986(trimNonBreakingSpaces(cleanedQuery)), "?").concat(queryString);
 }
 /**
  * Interface to autocomplete related API calls.

package/lib/modules/browse.js

@@ -146,7 +146,7 @@ function createBrowseUrlFromFilter(filterName, filterValue, parameters, options)
   var queryString = qs.stringify(queryParams, {
     indices: false
   });
-  return "".concat(serviceUrl, "/browse/").concat(encodeURIComponent(filterName), "/").concat(encodeURIComponent(filterValue), "?").concat(queryString);
+  return "".concat(serviceUrl, "/browse/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterName)), "/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterValue)), "?").concat(queryString);
 } // Create URL from supplied id's
 
 
@@ -189,14 +189,15 @@ function createBrowseUrlForFacetOptions(facetName, parameters, options) {
     throw new Error('facetName is a required parameter of type string');
   }
 
-  var queryParams = _objectSpread({}, createQueryParams(parameters, options)); // Endpoint does not accept _dt
+  var queryParams = _objectSpread({}, createQueryParams(parameters, options));
 
+  queryParams.facet_name = facetName; // 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);
+  return "".concat(serviceUrl, "/browse/facet_options?").concat(queryString);
 }
 /**
  * Interface to browse related API calls
@@ -226,6 +227,7 @@ var Browse = /*#__PURE__*/function () {
    * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
+   * @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
@@ -305,6 +307,7 @@ var Browse = /*#__PURE__*/function () {
      * @param {object} [parameters.filters] - Filters used to refine results
      * @param {string} [parameters.sortBy='relevance'] - The sort method for results
      * @param {string} [parameters.sortOrder='descending'] - The sort order for results
+     * @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
@@ -376,6 +379,7 @@ var Browse = /*#__PURE__*/function () {
      *
      * @function getBrowseGroups
      * @param {object} [parameters.filters] - Filters used to refine results
+     * @param {string} [parameters.section='Products'] - The section name for results
      * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -441,6 +445,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 {string} [parameters.section='Products'] - The section name for 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
@@ -504,6 +509,7 @@ var Browse = /*#__PURE__*/function () {
      * @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 {string} [parameters.section='Products'] - The section name for results
      * @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 {}

package/lib/modules/recommendations.js

@@ -83,7 +83,7 @@ function createRecommendationsUrl(podId, parameters, options) {
   var queryString = qs.stringify(queryParams, {
     indices: false
   });
-  return "".concat(serviceUrl, "/recommendations/v1/pods/").concat(encodeURIComponent(podId), "?").concat(queryString);
+  return "".concat(serviceUrl, "/recommendations/v1/pods/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(podId)), "?").concat(queryString);
 }
 /**
  * Interface to recommendations related API calls

package/lib/modules/search.js

@@ -130,7 +130,7 @@ function createSearchUrl(query, parameters, options) {
   var queryString = qs.stringify(queryParams, {
     indices: false
   });
-  return "".concat(serviceUrl, "/search/").concat(encodeURIComponent(query), "?").concat(queryString);
+  return "".concat(serviceUrl, "/search/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query)), "?").concat(queryString);
 }
 /**
  * Interface to search related API calls

package/lib/modules/tracker.js

@@ -259,7 +259,7 @@ var Tracker = /*#__PURE__*/function () {
       if (term && typeof term === 'string') {
         // Ensure parameters are provided (required)
         if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
-          var url = "".concat(this.options.serviceUrl, "/autocomplete/").concat(helpers.ourEncodeURIComponent(term), "/select?");
+          var url = "".concat(this.options.serviceUrl, "/autocomplete/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term)), "/select?");
           var queryParams = {};
           var original_query = parameters.original_query,
               section = parameters.section,
@@ -332,7 +332,7 @@ var Tracker = /*#__PURE__*/function () {
       if (term && typeof term === 'string') {
         // Ensure parameters are provided (required)
         if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
-          var url = "".concat(this.options.serviceUrl, "/autocomplete/").concat(helpers.ourEncodeURIComponent(term), "/search?");
+          var url = "".concat(this.options.serviceUrl, "/autocomplete/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term)), "/search?");
           var queryParams = {};
           var original_query = parameters.original_query,
               group_id = parameters.group_id,
@@ -463,7 +463,7 @@ var Tracker = /*#__PURE__*/function () {
       if (term && typeof term === 'string') {
         // Ensure parameters are provided (required)
         if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
-          var url = "".concat(this.options.serviceUrl, "/autocomplete/").concat(helpers.ourEncodeURIComponent(term), "/click_through?");
+          var url = "".concat(this.options.serviceUrl, "/autocomplete/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term)), "/click_through?");
           var queryParams = {};
           var item_name = parameters.item_name,
               name = parameters.name,
@@ -547,7 +547,7 @@ var Tracker = /*#__PURE__*/function () {
 
       // Ensure parameters are provided (required)
       if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
-        var searchTerm = helpers.ourEncodeURIComponent(term) || 'TERM_UNKNOWN';
+        var searchTerm = term || 'TERM_UNKNOWN';
         var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/conversion?");
         var queryParams = {};
         var bodyParams = {};

package/lib/utils/helpers.js

@@ -5,27 +5,20 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 /* eslint-disable no-param-reassign */
-var qs = require('qs');
-
 var CRC32 = require('crc-32');
 
 var store = require('./store');
 
 var purchaseEventStorageKey = '_constructorio_purchase_order_ids';
 var utils = {
-  ourEncodeURIComponent: function ourEncodeURIComponent(str) {
-    if (str && typeof str === 'string') {
-      var cleanedString = str.replace(/\[/g, '%5B') // Replace [
-      .replace(/\]/g, '%5D') // Replace ]
-      .replace(/&/g, '%26'); // Replace &
-
-      var trimmedCleanedString = cleanedString.trim();
-      var parsedStrObj = qs.parse("s=".concat(trimmedCleanedString));
-      parsedStrObj.s = parsedStrObj.s.replace(/\s/g, ' ');
-      return qs.stringify(parsedStrObj).split('=')[1];
-    }
-
-    return null;
+  trimNonBreakingSpaces: function trimNonBreakingSpaces(string) {
+    return string.replace(/\s/g, ' ').trim();
+  },
+  // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
+  encodeURIComponentRFC3986: function encodeURIComponentRFC3986(string) {
+    return encodeURIComponent(string).replace(/[!'()*]/g, function (c) {
+      return "%".concat(c.charCodeAt(0).toString(16).toUpperCase());
+    });
   },
   cleanParams: function cleanParams(paramsObj) {
     var cleanedParams = {};
@@ -35,7 +28,7 @@ var utils = {
       if (typeof paramValue === 'string') {
         // Replace non-breaking spaces (or any other type of spaces caught by the regex)
         // - with a regular white space
-        cleanedParams[paramKey] = decodeURIComponent(utils.ourEncodeURIComponent(paramValue));
+        cleanedParams[paramKey] = utils.trimNonBreakingSpaces(paramValue);
       } else {
         cleanedParams[paramKey] = paramValue;
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.27.11",
+  "version": "2.28.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {