@constructor-io/constructorio-client-javascript 2.34.8 → 2.34.9

package/lib/modules/tracker.js

@@ -106,20 +106,41 @@ var Tracker = /*#__PURE__*/function () {
     this.options = options || {};
     this.eventemitter = new EventEmitter();
     this.requests = new RequestQueue(options, this.eventemitter);
+    this.behavioralV2Url = 'https://ac.cnstrc.com/v2/behavioral_action/';
   }
   /**
    * Send session start event to API
-   *
-   * @function trackSessionStart
+   * @private
+   * @function trackSessionStartV2
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
    * @example
-   * constructorio.tracker.trackSessionStart();
+   * constructorio.tracker.trackSessionStartV2();
    */
 
 
   (0, _createClass2["default"])(Tracker, [{
+    key: "trackSessionStartV2",
+    value: function trackSessionStartV2() {
+      var networkParameters = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var url = "".concat(this.behavioralV2Url, "session_start?");
+      this.requests.queue("".concat(url).concat(applyParamsAsString({}, this.options)), 'POST', undefined, networkParameters);
+      this.requests.send();
+      return true;
+    }
+    /**
+     * Send session start event to API
+     *
+     * @function trackSessionStart
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @example
+     * constructorio.tracker.trackSessionStart();
+     */
+
+  }, {
     key: "trackSessionStart",
     value: function trackSessionStart() {
       var networkParameters = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -131,6 +152,43 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return true;
     }
+    /**
+     * Send input focus event to API
+     * @private
+     * @function trackInputFocusV2
+     * @param {string} user_input - Input at the time user focused on the search bar
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User focused on search input element
+     * @example
+     * constructorio.tracker.trackInputFocusV2("text");
+     */
+
+  }, {
+    key: "trackInputFocusV2",
+    value: function trackInputFocusV2() {
+      var user_input = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var baseUrl = "".concat(this.behavioralV2Url, "focus?");
+      var bodyParams = {};
+      var networkParametersNew = networkParameters;
+      var userInputNew = user_input;
+
+      if ((0, _typeof2["default"])(user_input) === 'object') {
+        networkParametersNew = user_input;
+        userInputNew = '';
+      }
+
+      bodyParams.user_input = userInputNew;
+      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.send();
+      return true;
+    }
     /**
      * Send input focus event to API
      *
@@ -229,6 +287,88 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return new Error('parameters are required of type object');
     }
+    /**
+     * Send autocomplete select event to API
+     * @private
+     * @function trackAutocompleteSelectV2
+     * @param {string} item_name - Name of selected autocomplete item
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.user_input - The current autocomplete search query
+     * @param {string} [parameters.section] - Section the selected item resides within
+     * @param {string} [parameters.tr] - Trigger used to select the item (click, etc.)
+     * @param {string} [parameters.item_id] - Item id of the selected item
+     * @param {string} [parameters.variation_id] - Variation id of the selected item
+     * @param {string} [parameters.group_id] - Group identifier of selected item
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User selected (clicked, or navigated to via keyboard) a result that appeared within autocomplete
+     * @example
+     * constructorio.tracker.trackAutocompleteSelectV2(
+     *     'T-Shirt',
+     *      {
+     *          user_input: 'Shirt',
+     *          section: 'Products',
+     *          tr: 'click',
+     *          group_id: '88JU230',
+     *          item_id: '12345',
+     *          variation_id: '12345-A',
+     *      },
+     * );
+     */
+
+  }, {
+    key: "trackAutocompleteSelectV2",
+    value: function trackAutocompleteSelectV2(item_name, parameters) {
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+      // Ensure term is provided (required)
+      if (item_name && typeof item_name === 'string') {
+        // Ensure parameters are provided (required)
+        if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+          var baseUrl = "".concat(this.behavioralV2Url, "autocomplete_select?");
+          var original_query = parameters.original_query,
+              _parameters$user_inpu = parameters.user_input,
+              user_input = _parameters$user_inpu === void 0 ? original_query : _parameters$user_inpu,
+              original_section = parameters.original_section,
+              _parameters$section = parameters.section,
+              section = _parameters$section === void 0 ? original_section : _parameters$section,
+              tr = parameters.tr,
+              group_id = parameters.group_id,
+              item_id = parameters.item_id,
+              variation_id = parameters.variation_id;
+          var queryParams = {};
+          var bodyParams = {
+            user_input: user_input,
+            tr: tr,
+            group_id: group_id,
+            item_id: item_id,
+            variation_id: variation_id,
+            item_name: item_name,
+            section: section
+          };
+
+          if (section) {
+            queryParams.section = section;
+          }
+
+          var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
+          var requestMethod = 'POST';
+          var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+            requestMethod: requestMethod
+          }));
+          this.requests.queue(requestURL, requestMethod, requestBody, 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 autocomplete select event to API
      *
@@ -306,6 +446,77 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return new Error('term is a required parameter of type string');
     }
+    /**
+     * Send autocomplete search event to API
+     * @private
+     * @function trackSearchSubmitV2
+     * @param {string} search_term - Term of submitted autocomplete event
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.user_input - The current autocomplete search query
+     * @param {string} [parameters.group_id] - Group identifier of selected item
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User submitted a search (pressing enter within input element, or clicking submit element)
+     * @example
+     * constructorio.tracker.trackSearchSubmitV2(
+     *     'T-Shirt',
+     *     {
+     *         user_input: 'Shirt',
+     *         group_id: '88JU230',
+     *     },
+     * );
+     */
+
+  }, {
+    key: "trackSearchSubmitV2",
+    value: function trackSearchSubmitV2(search_term, parameters) {
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+      // Ensure term is provided (required)
+      if (search_term && typeof search_term === 'string') {
+        // Ensure parameters are provided (required)
+        if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+          var baseUrl = "".concat(this.behavioralV2Url, "search_submit?");
+          var original_query = parameters.original_query,
+              _parameters$user_inpu2 = parameters.user_input,
+              user_input = _parameters$user_inpu2 === void 0 ? original_query : _parameters$user_inpu2,
+              group_id = parameters.group_id,
+              section = parameters.section;
+          var queryParams = {};
+          var bodyParams = {
+            user_input: user_input,
+            search_term: search_term,
+            section: section
+          };
+
+          if (group_id) {
+            bodyParams.filters = {
+              group_id: group_id
+            };
+          }
+
+          if (section) {
+            queryParams.section = section;
+          }
+
+          var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
+          var requestMethod = 'POST';
+          var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+            requestMethod: requestMethod
+          }));
+          this.requests.queue(requestURL, requestMethod, requestBody, 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 autocomplete search event to API
      *
@@ -368,6 +579,110 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return new Error('term is a required parameter of type string');
     }
+    /**
+     * Send search results loaded v2 event to API
+     * @private
+     * @function trackSearchResultsLoadedV2
+     * @param {string} search_term - Search results query term
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.url - URL of the search results page
+     * @param {number} [parameters.result_count] - Total number of results
+     * @param {number} [parameters.result_page] - Current page of search results
+     * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
+     * @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 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.trackSearchResultsLoadedV2(
+     *     'T-Shirt',
+     *     {
+     *         result_count: 167,
+     *         items: [{item_id: 'KMH876'}, {item_id: 'KMH140'}, {item_id: 'KMH437'}],
+     *         sort_order: 'ascending'
+     *         sort_by: 'price',
+     *         result_page: 3,
+     *         result_count: 20
+     *     },
+     * );
+     */
+
+  }, {
+    key: "trackSearchResultsLoadedV2",
+    value: function trackSearchResultsLoadedV2(search_term, parameters) {
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+      // Ensure term is provided (required)
+      if (search_term && typeof search_term === 'string') {
+        // Ensure parameters are provided (required)
+        if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+          var baseUrl = "".concat(this.behavioralV2Url, "search_result_load?");
+          var num_results = parameters.num_results,
+              _parameters$result_co = parameters.result_count,
+              result_count = _parameters$result_co === void 0 ? num_results : _parameters$result_co,
+              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,
+              result_id = parameters.result_id,
+              sort_order = parameters.sort_order,
+              sort_by = parameters.sort_by,
+              selected_filters = parameters.selected_filters,
+              url = parameters.url,
+              section = parameters.section;
+          var queryParams = {};
+          var transformedItems;
+
+          if (items && Array.isArray(items) && items.length !== 0) {
+            transformedItems = items;
+
+            if (typeof items[0] === 'string' || typeof items[0] === 'number') {
+              transformedItems = items.map(function (itemId) {
+                return {
+                  item_id: String(itemId)
+                };
+              });
+            }
+          }
+
+          if (section) {
+            queryParams.section = section;
+          }
+
+          var bodyParams = {
+            search_term: search_term,
+            result_count: result_count,
+            items: transformedItems,
+            result_page: result_page,
+            result_id: result_id,
+            sort_order: sort_order,
+            sort_by: sort_by,
+            selected_filters: selected_filters,
+            url: url,
+            section: section
+          };
+          var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
+          var requestMethod = 'POST';
+          var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+            requestMethod: requestMethod
+          }));
+          this.requests.queue(requestURL, requestMethod, requestBody, 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 search results loaded event to API
      *
@@ -436,6 +751,97 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return new Error('term is a required parameter of type string');
     }
+    /**
+     * Send click through event to API
+     * @private
+     * @function trackSearchResultClickV2
+     * @param {string} term - Search results query term
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.item_name - Product item name (Either item_name or item_id is required)
+     * @param {string} parameters.item_id - Product item unique identifier
+     * @param {string} [parameters.variation_id] - Product item variation unique identifier
+     * @param {string} [parameters.result_id] - Search result identifier (returned in response from Constructor)
+     * @param {number} [parameters.result_count] - Number of results in total
+     * @param {number} [parameters.result_page] - Current page of results
+     * @param {string} [parameters.result_position_on_page] - Position of selected items on page
+     * @param {string} [parameters.num_results_per_page] - Number of results per page
+     * @param {object} [parameters.selected_filters] - Key - Value map of selected filters
+     * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User clicked a result that appeared within a search product listing page
+     * @example
+     * constructorio.tracker.trackSearchResultClickV2(
+     *     'T-Shirt',
+     *     {
+     *         item_name: 'Red T-Shirt',
+     *         item_id: 'KMH876',
+     *         result_id: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
+     *     },
+     * );
+     */
+
+  }, {
+    key: "trackSearchResultClickV2",
+    value: function trackSearchResultClickV2(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 baseUrl = "".concat(this.behavioralV2Url, "search_result_click?");
+          var customer_id = parameters.customer_id,
+              _parameters$item_id = parameters.item_id,
+              item_id = _parameters$item_id === void 0 ? customer_id : _parameters$item_id,
+              name = parameters.name,
+              _parameters$item_name = parameters.item_name,
+              item_name = _parameters$item_name === void 0 ? name : _parameters$item_name,
+              variation_id = parameters.variation_id,
+              result_id = parameters.result_id,
+              result_count = parameters.result_count,
+              result_page = parameters.result_page,
+              result_position_on_page = parameters.result_position_on_page,
+              num_results_per_page = parameters.num_results_per_page,
+              selected_filters = parameters.selected_filters,
+              section = parameters.section;
+          var bodyParams = {
+            item_name: item_name,
+            item_id: item_id,
+            variation_id: variation_id,
+            result_id: result_id,
+            result_count: result_count,
+            result_page: result_page,
+            result_position_on_page: result_position_on_page,
+            num_results_per_page: num_results_per_page,
+            selected_filters: selected_filters,
+            section: section,
+            search_term: term
+          };
+          var queryParams = {};
+
+          if (section) {
+            queryParams.section = section;
+          }
+
+          var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
+          var requestMethod = 'POST';
+          var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+            requestMethod: requestMethod
+          }));
+          this.requests.queue(requestURL, requestMethod, requestBody, 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
      *
@@ -480,8 +886,8 @@ var Tracker = /*#__PURE__*/function () {
               customer_id = parameters.customer_id,
               variation_id = parameters.variation_id,
               result_id = parameters.result_id,
-              item_is_convertible = parameters.item_is_convertible,
-              section = parameters.section; // Ensure support for both item_name and name as parameters
+              section = parameters.section,
+              item_is_convertible = parameters.item_is_convertible; // Ensure support for both item_name and name as parameters
 
           if (item_name) {
             queryParams.name = item_name;
@@ -576,8 +982,8 @@ var Tracker = /*#__PURE__*/function () {
             customer_id = parameters.customer_id,
             variation_id = parameters.variation_id,
             revenue = parameters.revenue,
-            _parameters$section = parameters.section,
-            section = _parameters$section === void 0 ? 'Products' : _parameters$section,
+            _parameters$section2 = parameters.section,
+            section = _parameters$section2 === void 0 ? 'Products' : _parameters$section2,
             display_name = parameters.display_name,
             type = parameters.type,
             is_custom_type = parameters.is_custom_type; // Ensure support for both item_id and customer_id as parameters
@@ -1276,8 +1682,8 @@ var Tracker = /*#__PURE__*/function () {
             quiz_version_id = parameters.quiz_version_id,
             quiz_session_id = parameters.quiz_session_id,
             url = parameters.url,
-            _parameters$section2 = parameters.section,
-            section = _parameters$section2 === void 0 ? 'Products' : _parameters$section2,
+            _parameters$section3 = parameters.section,
+            section = _parameters$section3 === void 0 ? 'Products' : _parameters$section3,
             result_count = parameters.result_count,
             result_id = parameters.result_id,
             result_page = parameters.result_page;
@@ -1403,8 +1809,8 @@ var Tracker = /*#__PURE__*/function () {
             result_page = parameters.result_page,
             num_results_per_page = parameters.num_results_per_page,
             result_position_on_page = parameters.result_position_on_page,
-            _parameters$section3 = parameters.section,
-            section = _parameters$section3 === void 0 ? 'Products' : _parameters$section3;
+            _parameters$section4 = parameters.section,
+            section = _parameters$section4 === void 0 ? 'Products' : _parameters$section4;
         var queryParams = {};
         var bodyParams = {}; // Ensure required parameters provided
 
@@ -1556,8 +1962,8 @@ var Tracker = /*#__PURE__*/function () {
             item_name = parameters.item_name,
             variation_id = parameters.variation_id,
             revenue = parameters.revenue,
-            _parameters$section4 = parameters.section,
-            section = _parameters$section4 === void 0 ? 'Products' : _parameters$section4,
+            _parameters$section5 = parameters.section,
+            section = _parameters$section5 === void 0 ? 'Products' : _parameters$section5,
             type = parameters.type,
             is_custom_type = parameters.is_custom_type,
             display_name = parameters.display_name;

package/package.json

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

package/lib/types/types.d.ts

@@ -1,126 +0,0 @@
-import EventDispatcher from './event-dispatcher';
-
-export interface ConstructorClientOptions {
-	apiKey: string;
-	version?: string;
-	serviceUrl?: string;
-	// session id is of type string in jsdocs but of type number in code usage
-	sessionId?: string;
-	clientId?: string;
-	userId?: string;
-	segments?: string[];
-	testCells?: Record<string, string>;
-	fetch?: any;
-	trackingSendDelay?: number;
-	sendTrackingEvents?: boolean;
-	sendReferrerWithTrackingEvents?: boolean;
-	eventDispatcher?: EventDispatcher;
-	beaconMode?: boolean;
-	networkParameters?: {
-		timeout: number;
-	};
-}
-
-export interface RequestFeature extends Record<string, any> {
-	query_items: boolean;
-	auto_generated_refined_query_rules: boolean;
-	manual_searchandizing: boolean;
-	personalization: boolean;
-	filter_items: boolean;
-}
-
-export interface RequestFeatureVariant extends Record<string, any> {
-	query_items: string;
-	auto_generated_refined_query_rules: string;
-	manual_searchandizing: string | null;
-	personalization: string;
-	filter_items: string;
-}
-
-export type ErrorData = {
-	message: string;
-	[key: string]: any;
-};
-
-export interface ResultSources extends Record<string, any> {
-	token_match: { count: number; [key: string]: any };
-	embeddings_match: { count: number; [key: string]: any };
-}
-
-export interface SortOption extends Record<string, any> {
-	sort_by: string;
-	display_name: string;
-	sort_order: string;
-	status: string;
-}
-
-export interface Feature extends Record<string, any> {
-	feature_name: string;
-	display_name: string;
-	enabled: boolean;
-	variant: {
-		name: string;
-		display_name: string;
-		[key: string]: any;
-	};
-}
-
-export interface FmtOption extends Record<string, any> {
-	groups_start: string;
-	groups_max_depth: number;
-}
-
-type Facet = RangeFacet | OptionFacet;
-
-export interface BaseFacet extends Record<string, any> {
-	data: Record<string, any>;
-	status: Record<string, any>;
-	display_name: string;
-	name: string;
-	hidden: boolean;
-}
-
-export interface RangeFacet extends BaseFacet, Record<string, any> {
-	max: number;
-	min: number;
-	type: "range";
-}
-
-export interface OptionFacet extends BaseFacet, Record<string, any> {
-	options: FacetOption[];
-	type: "multiple" | "single" | "hierarchical";
-}
-
-export interface FacetOption extends Record<string, any> {
-	count: number;
-	display_name: string;
-	value: string;
-	options?: FacetOption[];
-	range?: ["-inf" | number, "inf" | number];
-	status: string;
-}
-
-export interface Group extends BaseGroup, Record<string, any> {
-	count: number;
-	data: Record<string, any>;
-	parents: BaseGroup[];
-	children: Group[];
-}
-
-export interface Collection extends Record<string, any> {
-	collection_id: string,
-	display_name: string,
-	data: Record<string, any>
-}
-
-export interface BaseGroup extends Record<string, any> {
-	display_name: string;
-	group_id: string;
-}
-
-export interface FmtOptions extends Record<string, any> {
-	
-}
-
-export type Nullable<T> = T | null;
-