@constructor-io/constructorio-client-javascript 2.58.5 → 2.59.1

package/lib/modules/quizzes.js

@@ -133,7 +133,7 @@ var Quizzes = /*#__PURE__*/function () {
    * @param {string} quizId - The identifier of the quiz
    * @param {string} [parameters] - Additional parameters to refine result set
    * @param {string} [parameters.section] - Product catalog section
-   * @param {array} [parameters.answers] - An array of answers in the format [[1,2],[1]]
+   * @param {array} [parameters.answers] - An array of answers in the format [[1,2], [1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true"/"false", "seen" or an empty string ("") if skipped
    * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
    * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -183,7 +183,7 @@ var Quizzes = /*#__PURE__*/function () {
      * @description Retrieve quiz recommendation and filter expression from Constructor.io API
      * @param {string} quizId - The identifier of the quiz
      * @param {string} parameters - Additional parameters to refine result set
-     * @param {array} parameters.answers - An array of answers in the format [[1,2],[1]]
+     * @param {array} parameters.answers - An array of answers in the format [[1,2], [1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true"/"false", "seen" or an empty string ("") if skipped
      * @param {string} [parameters.section] - Product catalog section
      * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
      * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes

package/lib/modules/tracker.js

@@ -578,9 +578,9 @@ var Tracker = /*#__PURE__*/function () {
     }
 
     /**
-     * Send search results loaded  event to API
-     *
-     * @function trackSearchResultsLoaded
+     * Send search results loaded v2 event to API
+     * @private
+     * @function trackSearchResultsLoadedV2
      * @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
@@ -598,7 +598,7 @@ var Tracker = /*#__PURE__*/function () {
      * @returns {(true|Error)}
      * @description User viewed a search product listing page
      * @example
-     * constructorio.tracker.trackSearchResultsLoaded(
+     * constructorio.tracker.trackSearchResultsLoadedV2(
      *     'T-Shirt',
      *     {
      *         resultCount: 167,
@@ -611,25 +611,21 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackSearchResultsLoaded",
-    value: function trackSearchResultsLoaded(searchTerm, parameters) {
+    key: "trackSearchResultsLoadedV2",
+    value: function trackSearchResultsLoadedV2(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 _helpers$getWindowLoc2, _ref, _ref2;
           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,
-            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,
+            customer_ids = parameters.customer_ids,
+            item_ids = parameters.item_ids,
             _parameters$items = parameters.items,
             items = _parameters$items === void 0 ? customer_ids || item_ids : _parameters$items,
             result_page = parameters.result_page,
@@ -652,7 +648,7 @@ var Tracker = /*#__PURE__*/function () {
             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;
+            resultCount = _parameters$resultCou === void 0 ? (_ref = (_ref2 = numResults !== null && numResults !== void 0 ? numResults : result_count) !== null && _ref2 !== void 0 ? _ref2 : items === null || items === void 0 ? void 0 : items.length) !== null && _ref !== void 0 ? _ref : 0 : _parameters$resultCou;
           var queryParams = {};
           var transformedItems;
           if (items && Array.isArray(items) && items.length !== 0) {
@@ -681,9 +677,9 @@ var Tracker = /*#__PURE__*/function () {
             sort_order: sortOrder,
             sort_by: sortBy,
             selected_filters: selectedFilters,
-            analytics_tags: analyticsTags,
             url: url,
-            section: section
+            section: section,
+            analytics_tags: analyticsTags
           };
           var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
           var requestMethod = 'POST';
@@ -701,6 +697,82 @@ 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,
+            result_count = parameters.result_count,
+            _parameters$resultCou2 = parameters.resultCount,
+            resultCount = _parameters$resultCou2 === void 0 ? result_count : _parameters$resultCou2,
+            _parameters$numResult2 = parameters.numResults,
+            numResults = _parameters$numResult2 === void 0 ? num_results !== null && num_results !== void 0 ? num_results : resultCount : _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,
+            items = parameters.items;
+          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;
+          } else if (items && Array.isArray(items)) {
+            customerIDs = items.map(function (item) {
+              return item.item_id || item.itemId;
+            });
+          }
+          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
@@ -757,8 +829,8 @@ var Tracker = /*#__PURE__*/function () {
             _parameters$resultId2 = parameters.resultId,
             resultId = _parameters$resultId2 === void 0 ? result_id : _parameters$resultId2,
             result_count = parameters.result_count,
-            _parameters$resultCou2 = parameters.resultCount,
-            resultCount = _parameters$resultCou2 === void 0 ? num_results || result_count : _parameters$resultCou2,
+            _parameters$resultCou3 = parameters.resultCount,
+            resultCount = _parameters$resultCou3 === void 0 ? num_results || result_count : _parameters$resultCou3,
             result_page = parameters.result_page,
             _parameters$resultPag2 = parameters.resultPage,
             resultPage = _parameters$resultPag2 === void 0 ? result_page : _parameters$resultPag2,
@@ -766,8 +838,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$numResult2 = parameters.numResultsPerPage,
-            numResultsPerPage = _parameters$numResult2 === void 0 ? num_results_per_page : _parameters$numResult2,
+            _parameters$numResult3 = parameters.numResultsPerPage,
+            numResultsPerPage = _parameters$numResult3 === void 0 ? num_results_per_page : _parameters$numResult3,
             selected_filters = parameters.selected_filters,
             _parameters$selectedF2 = parameters.selectedFilters,
             selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
@@ -852,8 +924,8 @@ var Tracker = /*#__PURE__*/function () {
             _parameters$itemId5 = parameters.itemId,
             itemId = _parameters$itemId5 === void 0 ? item_id : _parameters$itemId5,
             customer_id = parameters.customer_id,
-            _parameters$customerI2 = parameters.customerId,
-            customerId = _parameters$customerI2 === void 0 ? customer_id || itemId : _parameters$customerI2,
+            _parameters$customerI3 = parameters.customerId,
+            customerId = _parameters$customerI3 === void 0 ? customer_id || itemId : _parameters$customerI3,
             variation_id = parameters.variation_id,
             _parameters$variation4 = parameters.variationId,
             variationId = _parameters$variation4 === void 0 ? variation_id : _parameters$variation4,
@@ -949,8 +1021,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$customerI3 = parameters.customerId,
-          customerId = _parameters$customerI3 === void 0 ? customer_id : _parameters$customerI3,
+          _parameters$customerI4 = parameters.customerId,
+          customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
           item_id = parameters.item_id,
           _parameters$itemId6 = parameters.itemId,
           itemId = _parameters$itemId6 === void 0 ? item_id || customerId : _parameters$itemId6,
@@ -1154,12 +1226,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$numResult3 = parameters.numResultsViewed,
-          numResultsViewed = _parameters$numResult3 === void 0 ? num_results_viewed : _parameters$numResult3,
+          _parameters$numResult4 = parameters.numResultsViewed,
+          numResultsViewed = _parameters$numResult4 === void 0 ? num_results_viewed : _parameters$numResult4,
           items = parameters.items,
           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;
+          _parameters$resultCou4 = parameters.resultCount,
+          resultCount = _parameters$resultCou4 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou4;
         if (!helpers.isNil(resultCount)) {
           bodyParams.result_count = resultCount;
         }
@@ -1258,8 +1330,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$resultId5 = parameters.resultId,
           resultId = _parameters$resultId5 === void 0 ? result_id : _parameters$resultId5,
           result_count = parameters.result_count,
-          _parameters$resultCou4 = parameters.resultCount,
-          resultCount = _parameters$resultCou4 === void 0 ? result_count : _parameters$resultCou4,
+          _parameters$resultCou5 = parameters.resultCount,
+          resultCount = _parameters$resultCou5 === void 0 ? result_count : _parameters$resultCou5,
           result_page = parameters.result_page,
           _parameters$resultPag4 = parameters.resultPage,
           resultPage = _parameters$resultPag4 === void 0 ? result_page : _parameters$resultPag4,
@@ -1267,8 +1339,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$numResult4 = parameters.numResultsPerPage,
-          numResultsPerPage = _parameters$numResult4 === void 0 ? num_results_per_page : _parameters$numResult4,
+          _parameters$numResult5 = parameters.numResultsPerPage,
+          numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
           pod_id = parameters.pod_id,
           _parameters$podId2 = parameters.podId,
           podId = _parameters$podId2 === void 0 ? pod_id : _parameters$podId2,
@@ -1374,6 +1446,7 @@ var Tracker = /*#__PURE__*/function () {
       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 _ref3;
         var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/browse_result_load?");
         var bodyParams = {};
         var _parameters$section4 = parameters.section,
@@ -1403,8 +1476,8 @@ var Tracker = /*#__PURE__*/function () {
           filterValue = _parameters$filterVal === void 0 ? filter_value : _parameters$filterVal,
           items = parameters.items,
           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;
+          _parameters$resultCou6 = parameters.resultCount,
+          resultCount = _parameters$resultCou6 === void 0 ? (_ref3 = result_count !== null && result_count !== void 0 ? result_count : items === null || items === void 0 ? void 0 : items.length) !== null && _ref3 !== void 0 ? _ref3 : 0 : _parameters$resultCou6;
         if (section) {
           bodyParams.section = section;
         }
@@ -1511,8 +1584,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$resultId7 = parameters.resultId,
           resultId = _parameters$resultId7 === void 0 ? result_id : _parameters$resultId7,
           result_count = parameters.result_count,
-          _parameters$resultCou6 = parameters.resultCount,
-          resultCount = _parameters$resultCou6 === void 0 ? result_count : _parameters$resultCou6,
+          _parameters$resultCou7 = parameters.resultCount,
+          resultCount = _parameters$resultCou7 === void 0 ? result_count : _parameters$resultCou7,
           result_page = parameters.result_page,
           _parameters$resultPag6 = parameters.resultPage,
           resultPage = _parameters$resultPag6 === void 0 ? result_page : _parameters$resultPag6,
@@ -1520,8 +1593,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$numResult5 = parameters.numResultsPerPage,
-          numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
+          _parameters$numResult6 = parameters.numResultsPerPage,
+          numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
           selected_filters = parameters.selected_filters,
           _parameters$selectedF4 = parameters.selectedFilters,
           selectedFilters = _parameters$selectedF4 === void 0 ? selected_filters : _parameters$selectedF4,
@@ -1532,8 +1605,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$filterVal2 = parameters.filterValue,
           filterValue = _parameters$filterVal2 === void 0 ? filter_value : _parameters$filterVal2,
           customer_id = parameters.customer_id,
-          _parameters$customerI4 = parameters.customerId,
-          customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
+          _parameters$customerI5 = parameters.customerId,
+          customerId = _parameters$customerI5 === void 0 ? customer_id : _parameters$customerI5,
           item_id = parameters.item_id,
           _parameters$itemId8 = parameters.itemId,
           itemId = _parameters$itemId8 === void 0 ? customerId || item_id : _parameters$itemId8,
@@ -1810,8 +1883,8 @@ var Tracker = /*#__PURE__*/function () {
           _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,
+          _parameters$resultCou8 = parameters.resultCount,
+          resultCount = _parameters$resultCou8 === void 0 ? result_count : _parameters$resultCou8,
           result_id = parameters.result_id,
           _parameters$resultId8 = parameters.resultId,
           resultId = _parameters$resultId8 === void 0 ? result_id : _parameters$resultId8,
@@ -1937,8 +2010,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$itemName8 = parameters.itemName,
           itemName = _parameters$itemName8 === void 0 ? item_name : _parameters$itemName8,
           result_count = parameters.result_count,
-          _parameters$resultCou8 = parameters.resultCount,
-          resultCount = _parameters$resultCou8 === void 0 ? result_count : _parameters$resultCou8,
+          _parameters$resultCou9 = parameters.resultCount,
+          resultCount = _parameters$resultCou9 === void 0 ? result_count : _parameters$resultCou9,
           result_id = parameters.result_id,
           _parameters$resultId9 = parameters.resultId,
           resultId = _parameters$resultId9 === void 0 ? result_id : _parameters$resultId9,
@@ -1946,8 +2019,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$numResult6 = parameters.numResultsPerPage,
-          numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
+          _parameters$numResult7 = parameters.numResultsPerPage,
+          numResultsPerPage = _parameters$numResult7 === void 0 ? num_results_per_page : _parameters$numResult7,
           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/recommendations.d.ts

@@ -11,6 +11,7 @@ export interface RecommendationsParameters {
   filters?: Record<string, any>;
   variationsMap?: VariationsMap;
   hiddenFields?: string[];
+  preFilterExpression?: FilterExpression;
 }
 
 declare class Recommendations {

package/lib/types/tracker.d.ts

@@ -72,7 +72,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackSearchResultsLoaded(
+  trackSearchResultsLoadedV2(
     term: string,
     parameters: {
       url: string;
@@ -89,6 +89,15 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
+  trackSearchResultsLoaded(
+    term: string,
+    parameters: {
+      numResults: number;
+      itemIds: string[];
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
   trackSearchResultClick(
     term: string,
     parameters: {

package/lib/version.js

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

package/package.json

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