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

package/lib/modules/tracker.js

@@ -159,6 +159,69 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return true;
     }
+    /**
+     * Send item detail load event to API
+     *
+     * @function trackItemDetailLoad
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.item_name - Product item name
+     * @param {string} parameters.item_id - Product item unique identifier
+     * @param {string} [parameters.variation_id] - Product item variation unique identifier
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User loaded an item detail page
+     * @example
+     * constructorio.tracker.trackItemDetailLoad(
+     *     {
+     *         item_name: 'Red T-Shirt',
+     *         item_id: 'KMH876',
+     *     },
+     * );
+     */
+
+  }, {
+    key: "trackItemDetailLoad",
+    value: function trackItemDetailLoad(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 url = "".concat(this.options.serviceUrl, "/behavior?");
+        var queryParams = {
+          action: 'item_detail_load'
+        };
+        var item_name = parameters.item_name,
+            name = parameters.name,
+            item_id = parameters.item_id,
+            customer_id = parameters.customer_id,
+            variation_id = parameters.variation_id; // Ensure support for both item_name and name as parameters
+
+        if (item_name) {
+          queryParams.name = item_name;
+        } else if (name) {
+          queryParams.name = name;
+        } // Ensure support for both item_id and customer_id as parameters
+
+
+        if (item_id) {
+          queryParams.customer_id = item_id;
+        } else if (customer_id) {
+          queryParams.customer_id = customer_id;
+        }
+
+        if (variation_id) {
+          queryParams.variation_id = variation_id;
+        }
+
+        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');
+    }
     /**
      * Send autocomplete select event to API
      *
@@ -456,7 +519,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {boolean} [parameters.is_custom_type] - Specify if type is custom conversion type
      * @param {string} [parameters.display_name] - Display name for the custom conversion type
      * @param {string} [parameters.result_id] - Result identifier (returned in response from Constructor)
-     * @param {string} [parameters.section] - Index section
+     * @param {string} [parameters.section="Products"] - Index section
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -563,7 +626,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {object[]} parameters.items - List of product item objects
      * @param {number} parameters.revenue - The subtotal (not including taxes, shipping, etc.) of the entire order
      * @param {string} [parameters.order_id] - Unique order identifier
-     * @param {string} [parameters.section] - Index section
+     * @param {string} [parameters.section="Products"] - Index section
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -640,6 +703,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} parameters.url - Current page URL
      * @param {string} parameters.pod_id - Pod identifier
      * @param {number} parameters.num_results_viewed - Number of results viewed
+     * @param {object[]} [parameters.items] - List of Product Item Objects
      * @param {number} [parameters.result_count] - Total number of results
      * @param {number} [parameters.result_page] - Page number of results
      * @param {string} [parameters.result_id] - Recommendation result identifier (returned in response from Constructor)
@@ -651,6 +715,7 @@ var Tracker = /*#__PURE__*/function () {
      * @example
      * constructorio.tracker.trackRecommendationView(
      *     {
+     *         items: [{ item_id: 'KMH876' }, { item_id: 'KMH140' }],
      *         result_count: 22,
      *         result_page: 2,
      *         result_id: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
@@ -676,7 +741,8 @@ var Tracker = /*#__PURE__*/function () {
             section = parameters.section,
             url = parameters.url,
             pod_id = parameters.pod_id,
-            num_results_viewed = parameters.num_results_viewed;
+            num_results_viewed = parameters.num_results_viewed,
+            items = parameters.items;
 
         if (!helpers.isNil(result_count)) {
           bodyParams.result_count = result_count;
@@ -708,6 +774,10 @@ var Tracker = /*#__PURE__*/function () {
           bodyParams.num_results_viewed = num_results_viewed;
         }
 
+        if (items && Array.isArray(items)) {
+          bodyParams.items = items.slice(0, 100);
+        }
+
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -843,7 +913,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {number} [parameters.result_count] - Total number of results
      * @param {number} [parameters.result_page] - Page number of results
      * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
-     * @param {string} [parameters.selected_filters] - Selected filters
+     * @param {object} [parameters.selected_filters] - Selected filters
      * @param {string} [parameters.sort_order] - Sort order ('ascending' or 'descending')
      * @param {string} [parameters.sort_by] - Sorting method
      * @param {object[]} [parameters.items] - List of product item objects

package/package.json

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