@constructor-io/constructorio-client-javascript 2.49.3 → 2.50.0

package/lib/modules/tracker.js

@@ -81,7 +81,6 @@ 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/';
   }
 
   /**
@@ -98,7 +97,7 @@ var Tracker = /*#__PURE__*/function () {
     key: "trackSessionStartV2",
     value: function trackSessionStartV2() {
       var networkParameters = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      var url = "".concat(this.behavioralV2Url, "session_start?");
+      var url = "".concat(this.options.serviceUrl, "/v2/behavioral_action/session_start?");
       this.requests.queue("".concat(url).concat(applyParamsAsString({}, this.options)), 'POST', undefined, networkParameters);
       this.requests.send();
       return true;
@@ -147,7 +146,7 @@ var Tracker = /*#__PURE__*/function () {
       var userInput = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
       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 baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/focus?");
       var bodyParams = {};
       var _parameters$analytics = parameters.analyticsTags,
         analyticsTags = _parameters$analytics === void 0 ? null : _parameters$analytics;
@@ -304,7 +303,7 @@ var Tracker = /*#__PURE__*/function () {
       if (itemName && typeof itemName === 'string') {
         // Ensure parameters are provided (required)
         if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
-          var baseUrl = "".concat(this.behavioralV2Url, "autocomplete_select?");
+          var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/autocomplete_select?");
           var original_query = parameters.original_query,
             _parameters$originalQ = parameters.originalQuery,
             originalQuery = _parameters$originalQ === void 0 ? original_query : _parameters$originalQ,
@@ -460,7 +459,7 @@ var Tracker = /*#__PURE__*/function () {
       if (searchTerm && typeof searchTerm === 'string') {
         // Ensure parameters are provided (required)
         if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
-          var baseUrl = "".concat(this.behavioralV2Url, "search_submit?");
+          var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/search_submit?");
           var original_query = parameters.original_query,
             _parameters$originalQ3 = parameters.originalQuery,
             originalQuery = _parameters$originalQ3 === void 0 ? original_query : _parameters$originalQ3,
@@ -603,7 +602,7 @@ var Tracker = /*#__PURE__*/function () {
       if (searchTerm && typeof searchTerm === '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 baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/search_result_load?");
           var num_results = parameters.num_results,
             _parameters$numResult = parameters.numResults,
             numResults = _parameters$numResult === void 0 ? num_results : _parameters$numResult,
@@ -784,7 +783,7 @@ var Tracker = /*#__PURE__*/function () {
       if (searchTerm && typeof searchTerm === '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 baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/search_result_click?");
           var num_results = parameters.num_results,
             customer_id = parameters.customer_id,
             item_id = parameters.item_id,
@@ -2130,6 +2129,335 @@ var Tracker = /*#__PURE__*/function () {
       return new Error('parameters are required of type object');
     }
 
+    /**
+     * Send ASA request submitted event
+     *
+     * @function trackAssistantSubmit
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.intent - Intent of user request
+     * @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 submitted an assistant search
+     *   (pressing enter within assistant input element, or clicking assistant submit element)
+     * @example
+     * constructorio.tracker.trackAssistantSubmit(
+     *     {
+     *         intent: 'show me a recipe for a cookie',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackAssistantSubmit",
+    value: function trackAssistantSubmit(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        // Ensure parameters are provided (required)
+        var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_submit?");
+        var section = parameters.section,
+          intent = parameters.intent;
+        var bodyParams = {
+          intent: intent,
+          section: section
+        };
+        var requestURL = "".concat(baseUrl).concat(applyParamsAsString({}, 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');
+    }
+
+    /**
+     * Send assistant results page load started
+     *
+     * @function trackAssistantResultLoadStarted
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.intent - Intent of user request
+     * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @param {string} [parameters.intentResultId] - The intent result id from the ASA response
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description Assistant results page load begun (but has not necessarily loaded completely)
+     * @example
+     * constructorio.tracker.trackAssistantResultLoadStarted(
+     *     {
+     *         intent: 'show me a recipe for a cookie',
+     *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackAssistantResultLoadStarted",
+    value: function trackAssistantResultLoadStarted(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        // Ensure parameters are provided (required)
+        var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_result_load_start?");
+        var section = parameters.section,
+          intentResultId = parameters.intentResultId,
+          intent = parameters.intent;
+        var bodyParams = {
+          intent_result_id: intentResultId,
+          intent: intent,
+          section: section
+        };
+        var requestURL = "".concat(baseUrl).concat(applyParamsAsString({}, 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');
+    }
+
+    /**
+     * Send assistant results page load finished
+     *
+     * @function trackAssistantResultLoadFinished
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.intent - Intent of user request
+     * @param {number} parameters.searchResultCount - Number of search results loaded
+     * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @param {string} [parameters.intentResultId] - The intent result id from the ASA response
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description Assistant results page load finished
+     * @example
+     * constructorio.tracker.trackAssistantResultLoadFinished(
+     *     {
+     *         intent: 'show me a recipe for a cookie',
+     *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
+     *         searchResultCount: 5,
+     *     },
+     * );
+     */
+  }, {
+    key: "trackAssistantResultLoadFinished",
+    value: function trackAssistantResultLoadFinished(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 baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_result_load_finish?");
+        var section = parameters.section,
+          searchResultCount = parameters.searchResultCount,
+          intentResultId = parameters.intentResultId,
+          intent = parameters.intent;
+        var bodyParams = {
+          intent_result_id: intentResultId,
+          section: section,
+          intent: intent,
+          search_result_count: searchResultCount
+        };
+        var requestURL = "".concat(baseUrl).concat(applyParamsAsString({}, 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');
+    }
+
+    /**
+     * Send assistant result click event to API
+     *
+     * @function trackAssistantResultClick
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.intent - intent of the user
+     * @param {string} parameters.searchResultId - result_id of the specific search result the clicked item belongs to
+     * @param {string} parameters.itemId - Product item unique identifier
+     * @param {string} parameters.itemName - Product item name
+     * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @param {string} [parameters.variationId] - Product item variation unique identifier
+     * @param {string} [parameters.intentResultId] - Browse result identifier (returned in response from Constructor)
+     * @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 an assistant search result
+     * @example
+     * constructorio.tracker.trackAssistantResultClick(
+     *     {
+     *         variationId: 'KMH879-7632',
+     *         searchResultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
+     *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
+     *         intent: 'show me a recipe for a cookie',
+     *         itemId: 'KMH876',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackAssistantResultClick",
+    value: function trackAssistantResultClick(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 requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_search_result_click?");
+        var _parameters$section10 = parameters.section,
+          section = _parameters$section10 === void 0 ? 'Products' : _parameters$section10,
+          variationId = parameters.variationId,
+          intentResultId = parameters.intentResultId,
+          searchResultId = parameters.searchResultId,
+          itemId = parameters.itemId,
+          itemName = parameters.itemName,
+          intent = parameters.intent;
+        var bodyParams = {
+          section: section,
+          variation_id: variationId,
+          intent_result_id: intentResultId,
+          search_result_id: searchResultId,
+          item_id: itemId,
+          item_name: itemName,
+          intent: intent
+        };
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, 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');
+    }
+
+    /**
+     * Send assistant search result view event to API
+     *
+     * @function trackAssistantResultView
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.intent - intent of the user
+     * @param {string} parameters.searchResultId - result_id of the specific search result the clicked item belongs to
+     * @param {number} parameters.numResultsViewed - Number of items viewed in this search result
+     * @param {object[]} [parameters.items] - List of product item objects viewed
+     * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @param {string} [parameters.intentResultId] - Browse result identifier (returned in response from Constructor)
+     * @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 result within an assistant result
+     * @example
+     * constructorio.tracker.trackAssistantResultView(
+     *     {
+     *         searchResultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
+     *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
+     *         intent: 'show me a recipe for a cookie',
+     *         numResultsViewed: 5,
+     *         items: [{itemId: 'KMH876'}, {itemId: 'KMH140'}, {itemId: 'KMH437'}],
+     *     },
+     * );
+     */
+  }, {
+    key: "trackAssistantResultView",
+    value: function trackAssistantResultView(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 requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_search_result_view?");
+        var _parameters$section11 = parameters.section,
+          section = _parameters$section11 === void 0 ? 'Products' : _parameters$section11,
+          items = parameters.items,
+          numResultsViewed = parameters.numResultsViewed,
+          intentResultId = parameters.intentResultId,
+          searchResultId = parameters.searchResultId,
+          intent = parameters.intent;
+        var bodyParams = {
+          section: section,
+          intent_result_id: intentResultId,
+          search_result_id: searchResultId,
+          num_results_viewed: numResultsViewed,
+          items: items && Array.isArray(items) && items.slice(0, 100).map(function (item) {
+            return helpers.toSnakeCaseKeys(item, false);
+          }),
+          intent: intent
+        };
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, 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');
+    }
+
+    /**
+     * Send ASA search submitted event
+     *
+     * @function trackAssistantSearchSubmit
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.intent - Intent of user request
+     * @param {string} parameters.searchTerm - Term of submitted assistant search event
+     * @param {string} parameters.searchResultId - resultId of search result the clicked item belongs to
+     * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+     * @param {string} [parameters.intentResultId] - intentResultId from the ASA response
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User submitted an alternative assistant search result search term
+     * @example
+     * constructorio.tracker.trackAssistantSearchSubmit({
+     *     {
+     *         searchResultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
+     *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
+     *         intent: 'show me a recipe for a cookie',
+     *         searchTerm: 'flour',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackAssistantSearchSubmit",
+    value: function trackAssistantSearchSubmit(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)) {
+        // Ensure parameters are provided (required)
+        var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/assistant_search_submit?");
+        var section = parameters.section,
+          intent = parameters.intent,
+          searchTerm = parameters.searchTerm,
+          searchResultId = parameters.searchResultId,
+          intentResultId = parameters.intentResultId;
+        var bodyParams = {
+          intent: intent,
+          section: section,
+          search_term: searchTerm,
+          search_result_id: searchResultId,
+          intent_result_id: intentResultId
+        };
+        var requestURL = "".concat(baseUrl).concat(applyParamsAsString({}, 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 is a required parameter of type object');
+    }
+
     /**
      * Subscribe to success or error messages emitted by tracking requests
      *

package/lib/types/index.d.ts

@@ -152,7 +152,7 @@ export interface BaseGroup extends Record<string, any> {
 
 export interface FmtOptions extends Record<string, any> {
   groups_max_depth?: number;
-  groups_start?: 'current' | 'top';
+  groups_start?: 'current' | 'top' | `group_id:${string}`;
   fields?: string[]; // Array of metadata field to be returned in the data response
 }
 

package/lib/types/tracker.d.ts

@@ -253,5 +253,70 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
+  trackAssistantSubmit(
+    parameters: {
+      intent: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackAssistantResultLoadStarted(
+    parameters: {
+      intent: string;
+      section?: string;
+      intentResultId?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackAssistantResultLoadFinished(
+    parameters: {
+      intent: string;
+      searchResultCount: number;
+      section?: string;
+      intentResultId?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackAssistantResultClick(
+    parameters: {
+      intent: string;
+      searchResultId: string;
+      itemId?: string;
+      itemName?: string;
+      variationId?: string;
+      section?: string;
+      intentResultId?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackAssistantResultView(
+    parameters: {
+      intent: string;
+      searchResultId: string;
+      numResultsViewed: number;
+      items?: ItemTracked[];
+      intentResultId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackAssistantSearchSubmit(
+    parameters: {
+      intent: string,
+      searchTerm: string;
+      userInput: string;
+      searchResultId: string;
+      groupId?: string;
+      section?: string;
+      intentResultId?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
   on(messageType: string, callback: Function): true | Error;
 }

package/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = '2.49.3';
+var _default = '2.50.0';
 exports["default"] = _default;

package/package.json

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