@constructor-io/constructorio-client-javascript 2.55.1 → 2.57.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

@@ -570,9 +570,9 @@ var Tracker = /*#__PURE__*/function () {
     }
 
     /**
-     * Send search results loaded v2 event to API
-     * @private
-     * @function trackSearchResultsLoadedV2
+     * Send search results loaded  event to API
+     *
+     * @function trackSearchResultsLoaded
      * @param {string} searchTerm - Search results query term
      * @param {object} parameters - Additional parameters to be sent with request
      * @param {string} parameters.url - URL of the search results page
@@ -584,12 +584,13 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.sortOrder] - Sort order ('ascending' or 'descending')
      * @param {string} [parameters.sortBy] - Sorting method
      * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @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 viewed a search product listing page
      * @example
-     * constructorio.tracker.trackSearchResultsLoadedV2(
+     * constructorio.tracker.trackSearchResultsLoaded(
      *     'T-Shirt',
      *     {
      *         resultCount: 167,
@@ -602,22 +603,25 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackSearchResultsLoadedV2",
-    value: function trackSearchResultsLoadedV2(searchTerm, parameters) {
+    key: "trackSearchResultsLoaded",
+    value: function trackSearchResultsLoaded(searchTerm, parameters) {
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
       // Ensure term is provided (required)
       if (searchTerm && typeof searchTerm === 'string') {
         // Ensure parameters are provided (required)
         if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+          var _helpers$getWindowLoc2;
           var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/search_result_load?");
           var num_results = parameters.num_results,
             _parameters$numResult = parameters.numResults,
             numResults = _parameters$numResult === void 0 ? num_results : _parameters$numResult,
             result_count = parameters.result_count,
-            _parameters$resultCou = parameters.resultCount,
-            resultCount = _parameters$resultCou === void 0 ? numResults || result_count : _parameters$resultCou,
-            customer_ids = parameters.customer_ids,
-            item_ids = parameters.item_ids,
+            customerIds = parameters.customerIds,
+            _parameters$customer_ = parameters.customer_ids,
+            customer_ids = _parameters$customer_ === void 0 ? customerIds : _parameters$customer_,
+            itemIds = parameters.itemIds,
+            _parameters$item_ids = parameters.item_ids,
+            item_ids = _parameters$item_ids === void 0 ? itemIds : _parameters$item_ids,
             _parameters$items = parameters.items,
             items = _parameters$items === void 0 ? customer_ids || item_ids : _parameters$items,
             result_page = parameters.result_page,
@@ -635,20 +639,24 @@ var Tracker = /*#__PURE__*/function () {
             selected_filters = parameters.selected_filters,
             _parameters$selectedF = parameters.selectedFilters,
             selectedFilters = _parameters$selectedF === void 0 ? selected_filters : _parameters$selectedF,
-            url = parameters.url,
-            section = parameters.section;
+            _parameters$url = parameters.url,
+            url = _parameters$url === void 0 ? ((_helpers$getWindowLoc2 = helpers.getWindowLocation()) === null || _helpers$getWindowLoc2 === void 0 ? void 0 : _helpers$getWindowLoc2.href) || 'N/A' : _parameters$url,
+            section = parameters.section,
+            analyticsTags = parameters.analyticsTags,
+            _parameters$resultCou = parameters.resultCount,
+            resultCount = _parameters$resultCou === void 0 ? numResults || result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou;
           var queryParams = {};
           var transformedItems;
           if (items && Array.isArray(items) && items.length !== 0) {
-            transformedItems = items;
+            var trimmedItems = items.slice(0, 100);
             if (typeof items[0] === 'string' || typeof items[0] === 'number') {
-              transformedItems = items.map(function (itemId) {
+              transformedItems = trimmedItems.map(function (itemId) {
                 return {
                   item_id: String(itemId)
                 };
               });
             } else {
-              transformedItems = items.map(function (item) {
+              transformedItems = trimmedItems.map(function (item) {
                 return helpers.toSnakeCaseKeys(item, false);
               });
             }
@@ -665,6 +673,7 @@ var Tracker = /*#__PURE__*/function () {
             sort_order: sortOrder,
             sort_by: sortBy,
             selected_filters: selectedFilters,
+            analytics_tags: analyticsTags,
             url: url,
             section: section
           };
@@ -684,74 +693,6 @@ var Tracker = /*#__PURE__*/function () {
       return new Error('term is a required parameter of type string');
     }
 
-    /**
-     * Send search results loaded event to API
-     *
-     * @function trackSearchResultsLoaded
-     * @param {string} term - Search results query term
-     * @param {object} parameters - Additional parameters to be sent with request
-     * @param {number} parameters.numResults - Total number of results
-     * @param {string[]} parameters.itemIds - List of product item unique identifiers in search results listing
-     * @param {object} [networkParameters] - Parameters relevant to the network request
-     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
-     * @returns {(true|Error)}
-     * @description User viewed a search product listing page
-     * @example
-     * constructorio.tracker.trackSearchResultsLoaded(
-     *     'T-Shirt',
-     *     {
-     *         numResults: 167,
-     *         itemIds: ['KMH876', 'KMH140', 'KMH437'],
-     *     },
-     * );
-     */
-  }, {
-    key: "trackSearchResultsLoaded",
-    value: function trackSearchResultsLoaded(term, parameters) {
-      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-      // Ensure term is provided (required)
-      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, "/behavior?");
-          var queryParams = {
-            action: 'search-results',
-            term: term
-          };
-          var num_results = parameters.num_results,
-            _parameters$numResult2 = parameters.numResults,
-            numResults = _parameters$numResult2 === void 0 ? num_results : _parameters$numResult2,
-            customer_ids = parameters.customer_ids,
-            _parameters$customerI2 = parameters.customerIds,
-            customerIds = _parameters$customerI2 === void 0 ? customer_ids : _parameters$customerI2,
-            item_ids = parameters.item_ids,
-            _parameters$itemIds = parameters.itemIds,
-            itemIds = _parameters$itemIds === void 0 ? item_ids : _parameters$itemIds;
-          var customerIDs;
-          if (!helpers.isNil(numResults)) {
-            queryParams.num_results = numResults;
-          }
-
-          // Ensure support for both item_ids and customer_ids as parameters
-          if (itemIds && Array.isArray(itemIds)) {
-            customerIDs = itemIds;
-          } else if (customerIds && Array.isArray(customerIds)) {
-            customerIDs = customerIds;
-          }
-          if (customerIDs && Array.isArray(customerIDs) && customerIDs.length) {
-            queryParams.customer_ids = customerIDs.slice(0, 100).join(',');
-          }
-          this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
-          this.requests.send();
-          return true;
-        }
-        this.requests.send();
-        return new Error('parameters are required of type object');
-      }
-      this.requests.send();
-      return new Error('term is a required parameter of type string');
-    }
-
     /**
      * Send click through event to API
      * @private
@@ -816,8 +757,8 @@ var Tracker = /*#__PURE__*/function () {
             _parameters$resultPos = parameters.resultPositionOnPage,
             resultPositionOnPage = _parameters$resultPos === void 0 ? result_position_on_page : _parameters$resultPos,
             num_results_per_page = parameters.num_results_per_page,
-            _parameters$numResult3 = parameters.numResultsPerPage,
-            numResultsPerPage = _parameters$numResult3 === void 0 ? num_results_per_page : _parameters$numResult3,
+            _parameters$numResult2 = parameters.numResultsPerPage,
+            numResultsPerPage = _parameters$numResult2 === void 0 ? num_results_per_page : _parameters$numResult2,
             selected_filters = parameters.selected_filters,
             _parameters$selectedF2 = parameters.selectedFilters,
             selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
@@ -899,8 +840,8 @@ var Tracker = /*#__PURE__*/function () {
             _parameters$itemId4 = parameters.itemId,
             itemId = _parameters$itemId4 === void 0 ? item_id : _parameters$itemId4,
             customer_id = parameters.customer_id,
-            _parameters$customerI3 = parameters.customerId,
-            customerId = _parameters$customerI3 === void 0 ? customer_id || itemId : _parameters$customerI3,
+            _parameters$customerI2 = parameters.customerId,
+            customerId = _parameters$customerI2 === void 0 ? customer_id || itemId : _parameters$customerI2,
             variation_id = parameters.variation_id,
             _parameters$variation4 = parameters.variationId,
             variationId = _parameters$variation4 === void 0 ? variation_id : _parameters$variation4,
@@ -992,8 +933,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$itemName4 = parameters.itemName,
           itemName = _parameters$itemName4 === void 0 ? item_name || name : _parameters$itemName4,
           customer_id = parameters.customer_id,
-          _parameters$customerI4 = parameters.customerId,
-          customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
+          _parameters$customerI3 = parameters.customerId,
+          customerId = _parameters$customerI3 === void 0 ? customer_id : _parameters$customerI3,
           item_id = parameters.item_id,
           _parameters$itemId5 = parameters.itemId,
           itemId = _parameters$itemId5 === void 0 ? item_id || customerId : _parameters$itemId5,
@@ -1185,8 +1126,6 @@ var Tracker = /*#__PURE__*/function () {
         var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/recommendation_result_view?");
         var bodyParams = {};
         var result_count = parameters.result_count,
-          _parameters$resultCou3 = parameters.resultCount,
-          resultCount = _parameters$resultCou3 === void 0 ? result_count : _parameters$resultCou3,
           result_page = parameters.result_page,
           _parameters$resultPag3 = parameters.resultPage,
           resultPage = _parameters$resultPag3 === void 0 ? result_page : _parameters$resultPag3,
@@ -1199,10 +1138,12 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$podId = parameters.podId,
           podId = _parameters$podId === void 0 ? pod_id : _parameters$podId,
           num_results_viewed = parameters.num_results_viewed,
-          _parameters$numResult4 = parameters.numResultsViewed,
-          numResultsViewed = _parameters$numResult4 === void 0 ? num_results_viewed : _parameters$numResult4,
+          _parameters$numResult3 = parameters.numResultsViewed,
+          numResultsViewed = _parameters$numResult3 === void 0 ? num_results_viewed : _parameters$numResult3,
           items = parameters.items,
-          analyticsTags = parameters.analyticsTags;
+          analyticsTags = parameters.analyticsTags,
+          _parameters$resultCou3 = parameters.resultCount,
+          resultCount = _parameters$resultCou3 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou3;
         if (!helpers.isNil(resultCount)) {
           bodyParams.result_count = resultCount;
         }
@@ -1310,8 +1251,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$resultPos2 = parameters.resultPositionOnPage,
           resultPositionOnPage = _parameters$resultPos2 === void 0 ? result_position_on_page : _parameters$resultPos2,
           num_results_per_page = parameters.num_results_per_page,
-          _parameters$numResult5 = parameters.numResultsPerPage,
-          numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
+          _parameters$numResult4 = parameters.numResultsPerPage,
+          numResultsPerPage = _parameters$numResult4 === void 0 ? num_results_per_page : _parameters$numResult4,
           pod_id = parameters.pod_id,
           _parameters$podId2 = parameters.podId,
           podId = _parameters$podId2 === void 0 ? pod_id : _parameters$podId2,
@@ -1422,8 +1363,6 @@ var Tracker = /*#__PURE__*/function () {
         var _parameters$section4 = parameters.section,
           section = _parameters$section4 === void 0 ? 'Products' : _parameters$section4,
           result_count = parameters.result_count,
-          _parameters$resultCou5 = parameters.resultCount,
-          resultCount = _parameters$resultCou5 === void 0 ? result_count : _parameters$resultCou5,
           result_page = parameters.result_page,
           _parameters$resultPag5 = parameters.resultPage,
           resultPage = _parameters$resultPag5 === void 0 ? result_page : _parameters$resultPag5,
@@ -1447,7 +1386,9 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$filterVal = parameters.filterValue,
           filterValue = _parameters$filterVal === void 0 ? filter_value : _parameters$filterVal,
           items = parameters.items,
-          analyticsTags = parameters.analyticsTags;
+          analyticsTags = parameters.analyticsTags,
+          _parameters$resultCou5 = parameters.resultCount,
+          resultCount = _parameters$resultCou5 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou5;
         if (section) {
           bodyParams.section = section;
         }
@@ -1563,8 +1504,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$resultPos3 = parameters.resultPositionOnPage,
           resultPositionOnPage = _parameters$resultPos3 === void 0 ? result_position_on_page : _parameters$resultPos3,
           num_results_per_page = parameters.num_results_per_page,
-          _parameters$numResult6 = parameters.numResultsPerPage,
-          numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
+          _parameters$numResult5 = parameters.numResultsPerPage,
+          numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
           selected_filters = parameters.selected_filters,
           _parameters$selectedF4 = parameters.selectedFilters,
           selectedFilters = _parameters$selectedF4 === void 0 ? selected_filters : _parameters$selectedF4,
@@ -1575,8 +1516,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$filterVal2 = parameters.filterValue,
           filterValue = _parameters$filterVal2 === void 0 ? filter_value : _parameters$filterVal2,
           customer_id = parameters.customer_id,
-          _parameters$customerI5 = parameters.customerId,
-          customerId = _parameters$customerI5 === void 0 ? customer_id : _parameters$customerI5,
+          _parameters$customerI4 = parameters.customerId,
+          customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
           item_id = parameters.item_id,
           _parameters$itemId7 = parameters.itemId,
           itemId = _parameters$itemId7 === void 0 ? customerId || item_id : _parameters$itemId7,
@@ -1895,8 +1836,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$resultPag8 = parameters.resultPage,
           resultPage = _parameters$resultPag8 === void 0 ? result_page : _parameters$resultPag8,
           num_results_per_page = parameters.num_results_per_page,
-          _parameters$numResult7 = parameters.numResultsPerPage,
-          numResultsPerPage = _parameters$numResult7 === void 0 ? num_results_per_page : _parameters$numResult7,
+          _parameters$numResult6 = parameters.numResultsPerPage,
+          numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
           result_position_on_page = parameters.result_position_on_page,
           _parameters$resultPos4 = parameters.resultPositionOnPage,
           resultPositionOnPage = _parameters$resultPos4 === void 0 ? result_position_on_page : _parameters$resultPos4,

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/types/tracker.d.ts

@@ -18,11 +18,11 @@ declare class Tracker {
   trackInputFocus(networkParameters?: NetworkParameters): true | Error;
 
   trackInputFocusV2(
-      parameters: {
-        userInput: string;
-        analyticsTags?: Record<string, string>;
-      },
-      networkParameters?: NetworkParameters,
+    parameters: {
+      userInput: string;
+      analyticsTags?: Record<string, string>;
+    },
+    networkParameters?: NetworkParameters,
   ): true | Error;
 
   trackItemDetailLoad(
@@ -71,7 +71,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackSearchResultsLoadedV2(
+  trackSearchResultsLoaded(
     term: string,
     parameters: {
       url: string;
@@ -83,15 +83,7 @@ declare class Tracker {
       sortOrder?: string;
       sortBy?: string;
       section?: string;
-    },
-    networkParameters?: NetworkParameters
-  ): true | Error;
-
-  trackSearchResultsLoaded(
-    term: string,
-    parameters: {
-      numResults: number;
-      itemIds: string[];
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;

package/lib/version.js

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

package/package.json

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