@constructor-io/constructorio-client-javascript 2.59.2 → 2.60.0

package/lib/modules/tracker.js

@@ -7,6 +7,7 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+/* eslint-disable complexity */
 /* eslint-disable max-len */
 /* eslint-disable object-curly-newline, no-underscore-dangle, camelcase, no-unneeded-ternary */
 var EventEmitter = require('../utils/events');
@@ -790,6 +791,8 @@ var Tracker = /*#__PURE__*/function () {
      * @param {object} [parameters.selectedFilters] - Key - Value map of selected filters
      * @param {string} [parameters.section] - The section name for the item Ex. "Products"
      * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+     * @param {object} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {object} [parameters.slCampaignOwner] - Pass campaign owner of sponsored listing
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -801,6 +804,8 @@ var Tracker = /*#__PURE__*/function () {
      *         itemName: 'Red T-Shirt',
      *         itemId: 'KMH876',
      *         resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
+     *         slCampaignId: 'Campaign 123',
+     *         slCampaignOwner: 'Store 123',
      *     },
      * );
      */
@@ -844,8 +849,12 @@ var Tracker = /*#__PURE__*/function () {
             _parameters$selectedF2 = parameters.selectedFilters,
             selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
             section = parameters.section,
-            analyticsTags = parameters.analyticsTags;
+            analyticsTags = parameters.analyticsTags,
+            slCampaignId = parameters.slCampaignId,
+            slCampaignOwner = parameters.slCampaignOwner;
           var bodyParams = {
+            sl_campaign_id: slCampaignId,
+            sl_campaign_owner: slCampaignOwner,
             item_name: itemName,
             item_id: itemId,
             variation_id: variationId,
@@ -892,6 +901,8 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.itemIsConvertible] - Whether or not an item is available for a conversion
      * @param {string} [parameters.section] - The section name for the item Ex. "Products"
      * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+     * @param {object} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {object} [parameters.slCampaignOwner] - Pass campaign owner of sponsored listing
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -903,6 +914,8 @@ var Tracker = /*#__PURE__*/function () {
      *         itemName: 'Red T-Shirt',
      *         itemId: 'KMH876',
      *         resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
+     *         slCampaignId: 'Campaign 123',
+     *         slCampaignOwner: 'Store 123',
      *     },
      * );
      */
@@ -936,7 +949,9 @@ var Tracker = /*#__PURE__*/function () {
             _parameters$itemIsCon = parameters.itemIsConvertible,
             itemIsConvertible = _parameters$itemIsCon === void 0 ? item_is_convertible : _parameters$itemIsCon,
             section = parameters.section,
-            analyticsTags = parameters.analyticsTags;
+            analyticsTags = parameters.analyticsTags,
+            slCampaignOwner = parameters.slCampaignOwner,
+            slCampaignId = parameters.slCampaignId;
 
           // Ensure support for both item_name and name as parameters
           if (itemName) {
@@ -962,6 +977,12 @@ var Tracker = /*#__PURE__*/function () {
           if (analyticsTags) {
             queryParams.analytics_tags = analyticsTags;
           }
+          if (slCampaignId) {
+            queryParams.sl_campaign_id = slCampaignId;
+          }
+          if (slCampaignOwner) {
+            queryParams.sl_campaign_owner = slCampaignOwner;
+          }
           this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
           this.requests.send();
           return true;
@@ -1547,6 +1568,8 @@ var Tracker = /*#__PURE__*/function () {
      * @param {number} [parameters.numResultsPerPage] - Number of results shown
      * @param {object} [parameters.selectedFilters] -  Selected filters
      * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+     * @param {object} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {object} [parameters.slCampaignOwner] - Pass campaign owner of sponsored listing
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -1564,6 +1587,8 @@ var Tracker = /*#__PURE__*/function () {
      *         filterName: 'brand',
      *         filterValue: 'XYZ',
      *         itemId: 'KMH876',
+     *         slCampaignId: 'Campaign 123',
+     *         slCampaignOwner: 'Store 123',
      *     },
      * );
      */
@@ -1614,7 +1639,9 @@ var Tracker = /*#__PURE__*/function () {
           name = parameters.name,
           _parameters$itemName6 = parameters.itemName,
           itemName = _parameters$itemName6 === void 0 ? item_name || name : _parameters$itemName6,
-          analyticsTags = parameters.analyticsTags;
+          analyticsTags = parameters.analyticsTags,
+          slCampaignId = parameters.slCampaignId,
+          slCampaignOwner = parameters.slCampaignOwner;
         if (section) {
           bodyParams.section = section;
         }
@@ -1656,6 +1683,12 @@ var Tracker = /*#__PURE__*/function () {
         if (analyticsTags) {
           bodyParams.analytics_tags = analyticsTags;
         }
+        if (slCampaignId) {
+          bodyParams.sl_campaign_id = slCampaignId;
+        }
+        if (slCampaignOwner) {
+          bodyParams.sl_campaign_owner = slCampaignOwner;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {

package/lib/types/index.d.ts

@@ -233,6 +233,8 @@ export interface ItemTracked {
   itemName?: string;
   itemId?: string;
   variationId?: string;
+  slCampaignId?: string;
+  slCampaignOwner?: string;
 }
 
 export interface ItemTrackedPurchase extends ItemTracked {

package/lib/types/tracker.d.ts

@@ -108,6 +108,8 @@ declare class Tracker {
       itemIsConvertible?: string;
       section?: string;
       analyticsTags?: Record<string, string>;
+      slCampaignId?: string;
+      slCampaignOwner?: string;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -204,6 +206,8 @@ declare class Tracker {
       numResultsPerPage?: number;
       selectedFilters?: object;
       analyticsTags?: Record<string, string>;
+      slCampaignId?: string;
+      slCampaignOwner?: 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.59.2';
+var _default = '2.60.0';
 exports["default"] = _default;

package/package.json

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