@constructor-io/constructorio-client-javascript 2.56.0 → 2.58.0

package/lib/modules/autocomplete.js

@@ -59,7 +59,8 @@ function createAutocompleteUrl(query, parameters, options) {
       hiddenFields = parameters.hiddenFields,
       variationsMap = parameters.variationsMap,
       preFilterExpression = parameters.preFilterExpression,
-      qsParam = parameters.qsParam;
+      qsParam = parameters.qsParam,
+      fmtOptions = parameters.fmtOptions;
 
     // Pull results number from parameters
     if (numResults) {
@@ -90,6 +91,11 @@ function createAutocompleteUrl(query, parameters, options) {
       queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
     }
 
+    // Pull format options from parameters
+    if (fmtOptions) {
+      queryParams.fmt_options = fmtOptions;
+    }
+
     // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
@@ -144,6 +150,7 @@ var Autocomplete = /*#__PURE__*/function () {
    * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
    * @param {object} [parameters.filtersPerSection] - Filters used to refine results per section
    * @param {object} [parameters.resultsPerSection] - Number of results to return (value) per section (key)
+   * @param {object} [parameters.fmtOptions] - An object containing options to format different aspects of the response. Please refer to https://docs.constructor.com/reference/v1-autocomplete-get-autocomplete-results for details
    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope autocomplete results. Please refer to https://docs.constructor.com/reference/configuration-collections for details
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details

package/lib/modules/tracker.js

@@ -1580,6 +1580,100 @@ var Tracker = /*#__PURE__*/function () {
       return new Error('parameters are required of type object');
     }
 
+    /**
+     * Send browse redirect event to API
+     * @private
+     * @function trackBrowseRedirect
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.searchTerm - The search query that caused redirect
+     * @param {string} parameters.filterName - Filter name
+     * @param {string} parameters.filterValue - Filter value
+     * @param {string} [parameters.userInput] - The text that a user had typed at the moment when submitting search request
+     * @param {string} [parameters.redirectToUrl] - URL of the  page to which user is redirected
+     * @param {string} [parameters.section="Products"] - Index section
+     * @param {object} [parameters.selectedFilters] - Selected filters
+     * @param {string} [parameters.sortOrder] - Sort order ('ascending' or 'descending')
+     * @param {string} [parameters.sortBy] - Sorting method
+     * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User got redirected to a browse product listing page
+     * @example
+     * constructorio.tracker.trackBrowseRedirect(
+     *     {
+     *         searchTerm: "books",
+     *         filterName: 'brand',
+     *         filterValue: 'XYZ',
+     *         redirectToUrl: 'https://demo.constructor.io/books',
+     *         selectedFilters: { brand: ['foo'], color: ['black'] },
+     *         sortOrder: 'ascending',
+     *         sortBy: 'price',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackBrowseRedirect",
+    value: function trackBrowseRedirect(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      // Ensure parameters are provided (required)
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/browse_redirect?");
+        var bodyParams = {};
+        var searchTerm = parameters.searchTerm,
+          userInput = parameters.userInput,
+          _parameters$section6 = parameters.section,
+          section = _parameters$section6 === void 0 ? 'Products' : _parameters$section6,
+          selectedFilters = parameters.selectedFilters,
+          redirectToUrl = parameters.redirectToUrl,
+          sortOrder = parameters.sortOrder,
+          sortBy = parameters.sortBy,
+          filterName = parameters.filterName,
+          filterValue = parameters.filterValue,
+          analyticsTags = parameters.analyticsTags;
+        if (searchTerm) {
+          bodyParams.search_term = searchTerm;
+        }
+        if (userInput) {
+          bodyParams.user_input = userInput;
+        }
+        if (redirectToUrl) {
+          bodyParams.redirect_to_url = redirectToUrl;
+        }
+        if (section) {
+          bodyParams.section = section;
+        }
+        if (selectedFilters) {
+          bodyParams.selected_filters = selectedFilters;
+        }
+        if (sortOrder) {
+          bodyParams.sort_order = sortOrder;
+        }
+        if (sortBy) {
+          bodyParams.sort_by = sortBy;
+        }
+        if (filterName) {
+          bodyParams.filter_name = filterName;
+        }
+        if (filterValue) {
+          bodyParams.filter_value = filterValue;
+        }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
+        var requestMethod = 'POST';
+        var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+          requestMethod: requestMethod
+        }));
+        this.requests.queue(requestURL, requestMethod, requestBody, networkParameters);
+        this.requests.send();
+        return true;
+      }
+      this.requests.send();
+      return new Error('parameters are required of type object');
+    }
+
     /**
      * Send generic result click event to API
      *
@@ -1620,8 +1714,8 @@ var Tracker = /*#__PURE__*/function () {
           variation_id = parameters.variation_id,
           _parameters$variation8 = parameters.variationId,
           variationId = _parameters$variation8 === void 0 ? variation_id : _parameters$variation8,
-          _parameters$section6 = parameters.section,
-          section = _parameters$section6 === void 0 ? 'Products' : _parameters$section6,
+          _parameters$section7 = parameters.section,
+          section = _parameters$section7 === void 0 ? 'Products' : _parameters$section7,
           analyticsTags = parameters.analyticsTags;
         if (itemId) {
           bodyParams.section = section;
@@ -1697,8 +1791,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$quizSessi = parameters.quizSessionId,
           quizSessionId = _parameters$quizSessi === void 0 ? quiz_session_id : _parameters$quizSessi,
           url = parameters.url,
-          _parameters$section7 = parameters.section,
-          section = _parameters$section7 === void 0 ? 'Products' : _parameters$section7,
+          _parameters$section8 = parameters.section,
+          section = _parameters$section8 === void 0 ? 'Products' : _parameters$section8,
           result_count = parameters.result_count,
           _parameters$resultCou7 = parameters.resultCount,
           resultCount = _parameters$resultCou7 === void 0 ? result_count : _parameters$resultCou7,
@@ -1841,8 +1935,8 @@ var Tracker = /*#__PURE__*/function () {
           result_position_on_page = parameters.result_position_on_page,
           _parameters$resultPos4 = parameters.resultPositionOnPage,
           resultPositionOnPage = _parameters$resultPos4 === void 0 ? result_position_on_page : _parameters$resultPos4,
-          _parameters$section8 = parameters.section,
-          section = _parameters$section8 === void 0 ? 'Products' : _parameters$section8,
+          _parameters$section9 = parameters.section,
+          section = _parameters$section9 === void 0 ? 'Products' : _parameters$section9,
           variationId = parameters.variationId;
         var queryParams = {};
         var bodyParams = {};
@@ -1988,8 +2082,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$variation9 = parameters.variationId,
           variationId = _parameters$variation9 === void 0 ? variation_id : _parameters$variation9,
           revenue = parameters.revenue,
-          _parameters$section9 = parameters.section,
-          section = _parameters$section9 === void 0 ? 'Products' : _parameters$section9,
+          _parameters$section10 = parameters.section,
+          section = _parameters$section10 === void 0 ? 'Products' : _parameters$section10,
           type = parameters.type,
           is_custom_type = parameters.is_custom_type,
           _parameters$isCustomT2 = parameters.isCustomType,
@@ -2256,8 +2350,8 @@ var Tracker = /*#__PURE__*/function () {
       // Ensure parameters are provided (required)
       if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
         var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_search_result_click?");
-        var _parameters$section10 = parameters.section,
-          section = _parameters$section10 === void 0 ? 'Products' : _parameters$section10,
+        var _parameters$section11 = parameters.section,
+          section = _parameters$section11 === void 0 ? 'Products' : _parameters$section11,
           variationId = parameters.variationId,
           intentResultId = parameters.intentResultId,
           searchResultId = parameters.searchResultId,
@@ -2319,8 +2413,8 @@ var Tracker = /*#__PURE__*/function () {
       // Ensure parameters are provided (required)
       if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
         var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_search_result_view?");
-        var _parameters$section11 = parameters.section,
-          section = _parameters$section11 === void 0 ? 'Products' : _parameters$section11,
+        var _parameters$section12 = parameters.section,
+          section = _parameters$section12 === void 0 ? 'Products' : _parameters$section12,
           items = parameters.items,
           numResultsViewed = parameters.numResultsViewed,
           intentResultId = parameters.intentResultId,

package/lib/types/autocomplete.d.ts

@@ -20,6 +20,7 @@ export interface IAutocompleteParameters {
   variationsMap?: VariationsMap;
   preFilterExpression?: FilterExpression;
   qsParam?: Record<string, any>;
+  fmtOptions?: FmtOptions;
 }
 
 declare class Autocomplete {

package/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = '2.56.0';
+var _default = '2.58.0';
 exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.56.0",
+  "version": "2.58.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/index.d.ts",