@constructor-io/constructorio-client-javascript 2.63.0 → 2.64.1

package/lib/modules/browse.js

@@ -4,8 +4,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+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 object-curly-newline, no-underscore-dangle, max-len, complexity */
 var EventDispatcher = require('../utils/event-dispatcher');
 var helpers = require('../utils/helpers');

package/lib/modules/tracker.js

@@ -5,8 +5,8 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+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 */
@@ -280,6 +280,8 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.itemId] - Item id of the selected item
      * @param {string} [parameters.variationId] - Variation id of the selected item
      * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
+     * @param {string} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {string} [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)}
@@ -294,6 +296,8 @@ var Tracker = /*#__PURE__*/function () {
      *          groupId: '88JU230',
      *          itemId: '12345',
      *          variationId: '12345-A',
+     *          slCampaignId: 'Campaign 123',
+     *          slCampaignOwner: 'Store 123',
      *      },
      * );
      */
@@ -324,7 +328,9 @@ var Tracker = /*#__PURE__*/function () {
             itemId = _parameters$itemId2 === void 0 ? item_id : _parameters$itemId2,
             variation_id = parameters.variation_id,
             _parameters$variation2 = parameters.variationId,
-            variationId = _parameters$variation2 === void 0 ? variation_id : _parameters$variation2;
+            variationId = _parameters$variation2 === void 0 ? variation_id : _parameters$variation2,
+            slCampaignId = parameters.slCampaignId,
+            slCampaignOwner = parameters.slCampaignOwner;
           var queryParams = {};
           var bodyParams = {
             user_input: userInput,
@@ -338,6 +344,12 @@ var Tracker = /*#__PURE__*/function () {
           if (section) {
             queryParams.section = section;
           }
+          if (slCampaignId) {
+            bodyParams.sl_campaign_id = slCampaignId;
+          }
+          if (slCampaignOwner) {
+            bodyParams.sl_campaign_owner = slCampaignOwner;
+          }
           var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
           var requestMethod = 'POST';
           var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -366,6 +378,8 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
      * @param {string} [parameters.displayName] - Display name of group of selected item
      * @param {string} [parameters.itemId] - Item id of the selected item
+     * @param {string} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {string} [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)}
@@ -380,6 +394,8 @@ var Tracker = /*#__PURE__*/function () {
      *         groupId: '88JU230',
      *         displayName: 'apparel',
      *         itemId: '12345',
+     *         slCampaignId: 'Campaign 123',
+     *         slCampaignOwner: 'Store 123',
      *      },
      * );
      */
@@ -409,7 +425,9 @@ var Tracker = /*#__PURE__*/function () {
             displayName = _parameters$displayNa === void 0 ? display_name : _parameters$displayNa,
             item_id = parameters.item_id,
             _parameters$itemId3 = parameters.itemId,
-            itemId = _parameters$itemId3 === void 0 ? item_id : _parameters$itemId3;
+            itemId = _parameters$itemId3 === void 0 ? item_id : _parameters$itemId3,
+            slCampaignOwner = parameters.slCampaignOwner,
+            slCampaignId = parameters.slCampaignId;
           if (originalQuery) {
             queryParams.original_query = originalQuery;
           }
@@ -428,6 +446,12 @@ var Tracker = /*#__PURE__*/function () {
           if (itemId) {
             queryParams.item_id = itemId;
           }
+          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;
@@ -719,8 +743,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 {string} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {string} [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)}
@@ -829,8 +853,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 {string} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {string} [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)}
@@ -1496,8 +1520,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 {string} [parameters.slCampaignId] - Pass campaign id of sponsored listing
+     * @param {string} [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)}

package/lib/types/index.d.ts

@@ -37,6 +37,11 @@ export interface IdOptions extends Record<string, any> {
   session_id_storage_location?: string;
 }
 
+export interface EventDispatcherOptions {
+  enabled?: boolean;
+  waitForBeacon?: boolean;
+}
+
 export interface ConstructorClientOptions {
   apiKey: string;
   version?: string;
@@ -53,7 +58,7 @@ export interface ConstructorClientOptions {
   trackingSendDelay?: number;
   sendTrackingEvents?: boolean;
   sendReferrerWithTrackingEvents?: boolean;
-  eventDispatcher?: EventDispatcher;
+  eventDispatcher?: EventDispatcherOptions;
   beaconMode?: boolean;
   networkParameters?: NetworkParameters;
 }

package/lib/types/tracker.d.ts

@@ -45,6 +45,8 @@ declare class Tracker {
       groupId?: string;
       displayName?: string;
       itemId?: 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.63.0';
+var _default = '2.64.1';
 exports["default"] = _default;

package/package.json

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