@constructor-io/constructorio-client-javascript 2.42.2 → 2.43.0

package/lib/modules/quizzes.js

@@ -6,6 +6,8 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 /* eslint-disable object-curly-newline, no-underscore-dangle */
+/* eslint-disable max-len */
+/* eslint-disable complexity */
 var EventDispatcher = require('../utils/event-dispatcher');
 var helpers = require('../utils/helpers');
 
@@ -50,7 +52,9 @@ function createQuizUrl(quizId, parameters, options, path) {
       quizVersionId = parameters.quizVersionId,
       page = parameters.page,
       resultsPerPage = parameters.resultsPerPage,
-      filters = parameters.filters;
+      filters = parameters.filters,
+      fmtOptions = parameters.fmtOptions,
+      hiddenFields = parameters.hiddenFields;
 
     // Pull section from parameters
     if (section) {
@@ -88,6 +92,18 @@ function createQuizUrl(quizId, parameters, options, path) {
     if (filters) {
       queryParams.filters = filters;
     }
+    if (fmtOptions) {
+      queryParams.fmt_options = fmtOptions;
+    }
+    if (hiddenFields) {
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = {
+          hidden_fields: hiddenFields
+        };
+      }
+    }
   }
   queryParams._dt = Date.now();
   queryParams = helpers.cleanParams(queryParams);
@@ -179,6 +195,8 @@ var Quizzes = /*#__PURE__*/function () {
      * @param {number} [parameters.page] - The page number of the results
      * @param {number} [parameters.resultsPerPage] - The number of results per page to return
      * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
+     * @param {object} [parameters.fmtOptions] - Key / value mapping (dictionary) of options used for result formatting
+     * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}

package/lib/modules/tracker.js

@@ -1,8 +1,8 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 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(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; }
@@ -131,7 +131,9 @@ var Tracker = /*#__PURE__*/function () {
      * Send input focus event to API
      * @private
      * @function trackInputFocusV2
-     * @param {string} userInput - Input at the time user focused on the search bar
+     * @param {string} userInput - The current autocomplete search query
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @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)}
@@ -143,21 +145,21 @@ var Tracker = /*#__PURE__*/function () {
     key: "trackInputFocusV2",
     value: function trackInputFocusV2() {
       var userInput = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var parameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
       var baseUrl = "".concat(this.behavioralV2Url, "focus?");
       var bodyParams = {};
-      var networkParametersNew = networkParameters;
-      var userInputNew = userInput;
-      if ((0, _typeof2["default"])(userInput) === 'object') {
-        networkParametersNew = userInput;
-        userInputNew = '';
+      var _parameters$analytics = parameters.analyticsTags,
+        analyticsTags = _parameters$analytics === void 0 ? null : _parameters$analytics;
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
       }
-      bodyParams.user_input = userInputNew;
+      bodyParams.user_input = userInput;
       var requestMethod = 'POST';
       var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
         requestMethod: requestMethod
       }));
-      this.requests.queue("".concat(baseUrl).concat(applyParamsAsString({}, this.options)), requestMethod, requestBody, networkParametersNew);
+      this.requests.queue("".concat(baseUrl).concat(applyParamsAsString({}, this.options)), requestMethod, requestBody, networkParameters);
       this.requests.send();
       return true;
     }
@@ -194,6 +196,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} parameters.itemName - Product item name
      * @param {string} parameters.itemId - Product item unique identifier
      * @param {string} parameters.url - Current page URL
+     * @param {object} [parameters.analyticsTags] - Pass additional analytics data
      * @param {string} [parameters.variationId] - Product item variation unique identifier
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -230,7 +233,8 @@ var Tracker = /*#__PURE__*/function () {
           itemId = _parameters$itemId === void 0 ? item_id || customerId : _parameters$itemId,
           _parameters$variation = parameters.variationId,
           variationId = _parameters$variation === void 0 ? variation_id : _parameters$variation,
-          url = parameters.url;
+          url = parameters.url,
+          analyticsTags = parameters.analyticsTags;
 
         // Ensure support for both item_name and name as parameters
         if (itemName) {
@@ -244,6 +248,9 @@ var Tracker = /*#__PURE__*/function () {
         if (variationId) {
           bodyParams.variation_id = variationId;
         }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
         if (url) {
           bodyParams.url = url;
         }
@@ -1051,6 +1058,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {number} parameters.revenue - The subtotal (excluding taxes, shipping, etc.) of the entire order
      * @param {string} [parameters.orderId] - Unique order identifier
      * @param {string} [parameters.section="Products"] - Index section
+     * @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)}
@@ -1079,7 +1087,8 @@ var Tracker = /*#__PURE__*/function () {
           order_id = parameters.order_id,
           _parameters$orderId = parameters.orderId,
           orderId = _parameters$orderId === void 0 ? order_id : _parameters$orderId,
-          section = parameters.section;
+          section = parameters.section,
+          analyticsTags = parameters.analyticsTags;
         if (orderId) {
           // Don't send another purchase event if we have already tracked the order
           if (helpers.hasOrderIdRecord(orderId)) {
@@ -1103,6 +1112,9 @@ var Tracker = /*#__PURE__*/function () {
         } else {
           queryParams.section = 'Products';
         }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString(queryParams, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -1129,6 +1141,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {number} [parameters.resultPage] - Page number of results
      * @param {string} [parameters.resultId] - Recommendation result identifier (returned in response from Constructor)
      * @param {string} [parameters.section="Products"] - Results section
+     * @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)}
@@ -1171,7 +1184,8 @@ var Tracker = /*#__PURE__*/function () {
           num_results_viewed = parameters.num_results_viewed,
           _parameters$numResult4 = parameters.numResultsViewed,
           numResultsViewed = _parameters$numResult4 === void 0 ? num_results_viewed : _parameters$numResult4,
-          items = parameters.items;
+          items = parameters.items,
+          analyticsTags = parameters.analyticsTags;
         if (!helpers.isNil(resultCount)) {
           bodyParams.result_count = resultCount;
         }
@@ -1200,6 +1214,9 @@ var Tracker = /*#__PURE__*/function () {
             return helpers.toSnakeCaseKeys(item, false);
           });
         }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -1229,6 +1246,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {number} [parameters.resultPage] - Page number of results
      * @param {number} [parameters.resultPositionOnPage] - Position of result on page
      * @param {number} [parameters.numResultsPerPage] - Number of results on page
+     * @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)}
@@ -1288,7 +1306,8 @@ var Tracker = /*#__PURE__*/function () {
           itemId = _parameters$itemId6 === void 0 ? item_id : _parameters$itemId6,
           item_name = parameters.item_name,
           _parameters$itemName5 = parameters.itemName,
-          itemName = _parameters$itemName5 === void 0 ? item_name : _parameters$itemName5;
+          itemName = _parameters$itemName5 === void 0 ? item_name : _parameters$itemName5,
+          analyticsTags = parameters.analyticsTags;
         if (variationId) {
           bodyParams.variation_id = variationId;
         }
@@ -1322,6 +1341,9 @@ var Tracker = /*#__PURE__*/function () {
         if (itemName) {
           bodyParams.item_name = itemName;
         }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -1351,6 +1373,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {object} [parameters.selectedFilters] - Selected filters
      * @param {string} [parameters.sortOrder] - Sort order ('ascending' or 'descending')
      * @param {string} [parameters.sortBy] - Sorting method
+     * @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)}
@@ -1406,7 +1429,8 @@ var Tracker = /*#__PURE__*/function () {
           filter_value = parameters.filter_value,
           _parameters$filterVal = parameters.filterValue,
           filterValue = _parameters$filterVal === void 0 ? filter_value : _parameters$filterVal,
-          items = parameters.items;
+          items = parameters.items,
+          analyticsTags = parameters.analyticsTags;
         if (section) {
           bodyParams.section = section;
         }
@@ -1442,6 +1466,9 @@ var Tracker = /*#__PURE__*/function () {
             return helpers.toSnakeCaseKeys(item, false);
           });
         }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -1472,6 +1499,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {number} [parameters.resultPositionOnPage] - Position of clicked item
      * @param {number} [parameters.numResultsPerPage] - Number of results shown
      * @param {object} [parameters.selectedFilters] -  Selected filters
+     * @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)}
@@ -1538,7 +1566,8 @@ var Tracker = /*#__PURE__*/function () {
           item_name = parameters.item_name,
           name = parameters.name,
           _parameters$itemName6 = parameters.itemName,
-          itemName = _parameters$itemName6 === void 0 ? item_name || name : _parameters$itemName6;
+          itemName = _parameters$itemName6 === void 0 ? item_name || name : _parameters$itemName6,
+          analyticsTags = parameters.analyticsTags;
         if (section) {
           bodyParams.section = section;
         }
@@ -1577,6 +1606,9 @@ var Tracker = /*#__PURE__*/function () {
         if (itemName) {
           bodyParams.item_name = itemName;
         }
+        if (analyticsTags) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
@@ -1599,6 +1631,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.itemName] - Product item name
      * @param {string} [parameters.variationId] - Product item variation unique identifier
      * @param {string} [parameters.section="Products"] - Index section
+     * @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)}
@@ -1630,7 +1663,8 @@ var Tracker = /*#__PURE__*/function () {
           _parameters$variation8 = parameters.variationId,
           variationId = _parameters$variation8 === void 0 ? variation_id : _parameters$variation8,
           _parameters$section6 = parameters.section,
-          section = _parameters$section6 === void 0 ? 'Products' : _parameters$section6;
+          section = _parameters$section6 === void 0 ? 'Products' : _parameters$section6,
+          analyticsTags = parameters.analyticsTags;
         if (itemId) {
           bodyParams.section = section;
           bodyParams.item_id = itemId;
@@ -1640,6 +1674,9 @@ var Tracker = /*#__PURE__*/function () {
           if (variationId) {
             bodyParams.variation_id = variationId;
           }
+          if (analyticsTags) {
+            bodyParams.analytics_tags = analyticsTags;
+          }
           var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
           var requestMethod = 'POST';
           var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {

package/lib/types/quizzes.d.ts

@@ -21,11 +21,18 @@ export interface QuizzesParameters {
   quizSessionId?: string;
 }
 
+export interface QuizResultsFmtOptions {
+  hidden_fields?: string[];
+  fields?: string[];
+}
+
 export interface QuizzesResultsParameters extends QuizzesParameters {
   answers: any[];
   page?: number;
   resultsPerPage?: number;
   filters?: Record<string, any>;
+  fmtOptions?: QuizResultsFmtOptions;
+  hiddenFields?: string[];
 }
 
 declare class Quizzes {

package/lib/types/tracker.d.ts

@@ -17,12 +17,21 @@ declare class Tracker {
 
   trackInputFocus(networkParameters?: NetworkParameters): true | Error;
 
+  trackInputFocusV2(
+      parameters: {
+        userInput: string;
+        analyticsTags?: Record<string, string>;
+      },
+      networkParameters?: NetworkParameters,
+  ): true | Error;
+
   trackItemDetailLoad(
     parameters: {
       itemName: string;
       itemId: string;
       url: string;
       variationId?: string;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -109,6 +118,7 @@ declare class Tracker {
       revenue: number;
       orderId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -123,6 +133,7 @@ declare class Tracker {
       resultPage?: number;
       resultId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -140,6 +151,7 @@ declare class Tracker {
       resultPage?: number;
       resultPositionOnPage?: number;
       numResultsPerPage?: number;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -157,6 +169,7 @@ declare class Tracker {
       sortOrder?: string;
       sortBy?: string;
       items: ItemTracked[];
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -174,6 +187,7 @@ declare class Tracker {
       resultPositionOnPage?: number;
       numResultsPerPage?: number;
       selectedFilters?: object;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -184,6 +198,7 @@ declare class Tracker {
       itemName?: string;
       variationId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;

package/package.json

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