@constructor-io/constructorio-client-javascript 2.66.1 → 2.67.0

package/lib/constructorio.js

@@ -17,6 +17,7 @@ var helpers = require('./utils/helpers');
 var _require = require('./version'),
   packageVersion = _require["default"];
 var Quizzes = require('./modules/quizzes');
+var Agent = require('./modules/agent');
 var Assistant = require('./modules/assistant');
 
 // Compute package version string
@@ -41,7 +42,8 @@ var ConstructorIO = /*#__PURE__*/function () {
    * @param {string} parameters.apiKey - Constructor.io API key
    * @param {string} [parameters.serviceUrl='https://ac.cnstrc.com'] - API URL endpoint
    * @param {string} [parameters.quizzesServiceUrl='https://quizzes.cnstrc.com'] - Quizzes API URL endpoint
-   * @param {string} [parameters.assistantServiceUrl='https://assistant.cnstrc.com'] - AI Assistant API URL endpoint
+   * @param {string} [parameters.agentServiceUrl='https://agent.cnstrc.com'] - AI Shopping Agent API URL endpoint
+   * @param {string} [parameters.assistantServiceUrl='https://assistant.cnstrc.com'] - AI Shopping Assistant API URL endpoint @deprecated This parameter is deprecated and will be removed in a future version. Use parameters.agentServiceUrl instead.
    * @param {array} [parameters.segments] - User segments
    * @param {object} [parameters.testCells] - User test cells
    * @param {string} [parameters.clientId] - Client ID, defaults to value supplied by 'constructorio-id' module
@@ -63,7 +65,8 @@ var ConstructorIO = /*#__PURE__*/function () {
    * @property {object} recommendations - Interface to {@link module:recommendations}
    * @property {object} tracker - Interface to {@link module:tracker}
    * @property {object} quizzes - Interface to {@link module:quizzes}
-   * @property {object} assistant - Interface to {@link module:assistant}
+   * @property {object} agent - Interface to {@link module:agent}
+   * @property {object} assistant - Interface to {@link module:assistant} @deprecated This property is deprecated and will be removed in a future version. Use the agent property instead.
    * @returns {class}
    */
   function ConstructorIO() {
@@ -73,6 +76,7 @@ var ConstructorIO = /*#__PURE__*/function () {
       versionFromOptions = options.version,
       serviceUrl = options.serviceUrl,
       quizzesServiceUrl = options.quizzesServiceUrl,
+      agentServiceUrl = options.agentServiceUrl,
       assistantServiceUrl = options.assistantServiceUrl,
       segments = options.segments,
       testCells = options.testCells,
@@ -116,6 +120,7 @@ var ConstructorIO = /*#__PURE__*/function () {
       version: versionFromOptions || versionFromGlobal || computePackageVersion(),
       serviceUrl: helpers.addHTTPSToString(normalizedServiceUrl) || 'https://ac.cnstrc.com',
       quizzesServiceUrl: quizzesServiceUrl && quizzesServiceUrl.replace(/\/$/, '') || 'https://quizzes.cnstrc.com',
+      agentServiceUrl: agentServiceUrl && agentServiceUrl.replace(/\/$/, '') || 'https://agent.cnstrc.com',
       assistantServiceUrl: assistantServiceUrl && assistantServiceUrl.replace(/\/$/, '') || 'https://assistant.cnstrc.com',
       sessionId: sessionId || session_id,
       clientId: clientId || client_id,
@@ -139,6 +144,7 @@ var ConstructorIO = /*#__PURE__*/function () {
     this.recommendations = new Recommendations(this.options);
     this.tracker = new Tracker(this.options);
     this.quizzes = new Quizzes(this.options);
+    this.agent = new Agent(this.options);
     this.assistant = new Assistant(this.options);
 
     // Dispatch initialization event

package/lib/modules/agent.js

@@ -0,0 +1,208 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _require = require('../utils/helpers'),
+  cleanParams = _require.cleanParams,
+  trimNonBreakingSpaces = _require.trimNonBreakingSpaces,
+  encodeURIComponentRFC3986 = _require.encodeURIComponentRFC3986,
+  stringify = _require.stringify;
+
+// Create URL from supplied intent (term) and parameters
+function createAgentUrl(intent, parameters, options) {
+  var apiKey = options.apiKey,
+    version = options.version,
+    sessionId = options.sessionId,
+    clientId = options.clientId,
+    userId = options.userId,
+    segments = options.segments,
+    testCells = options.testCells,
+    agentServiceUrl = options.agentServiceUrl,
+    assistantServiceUrl = options.assistantServiceUrl;
+  var queryParams = {
+    c: version
+  };
+  queryParams.key = apiKey;
+  queryParams.i = clientId;
+  queryParams.s = sessionId;
+  var serviceUrl = agentServiceUrl || assistantServiceUrl;
+
+  // Validate intent is provided
+  if (!intent || typeof intent !== 'string') {
+    throw new Error('intent is a required parameter of type string');
+  }
+
+  // Validate domain is provided
+  if (!parameters.domain || typeof parameters.domain !== 'string') {
+    throw new Error('parameters.domain is a required parameter of type string');
+  }
+
+  // Pull test cells from options
+  if (testCells) {
+    Object.keys(testCells).forEach(function (testCellKey) {
+      queryParams["ef-".concat(testCellKey)] = testCells[testCellKey];
+    });
+  }
+
+  // Pull user segments from options
+  if (segments && segments.length) {
+    queryParams.us = segments;
+  }
+
+  // Pull user id from options and ensure string
+  if (userId) {
+    queryParams.ui = String(userId);
+  }
+  if (parameters) {
+    var domain = parameters.domain,
+      numResultsPerPage = parameters.numResultsPerPage;
+
+    // Pull domain from parameters
+    if (domain) {
+      queryParams.domain = domain;
+    }
+
+    // Pull results number from parameters
+    if (numResultsPerPage) {
+      queryParams.num_results_per_page = numResultsPerPage;
+    }
+  }
+
+  // eslint-disable-next-line no-underscore-dangle
+  queryParams._dt = Date.now();
+  queryParams = cleanParams(queryParams);
+  var queryString = stringify(queryParams);
+  var cleanedQuery = intent.replace(/^\//, '|'); // For compatibility with backend API
+
+  return "".concat(serviceUrl, "/v1/intent/").concat(encodeURIComponentRFC3986(trimNonBreakingSpaces(cleanedQuery)), "?").concat(queryString);
+}
+
+// Add event listeners to custom SSE that pushes data to the stream
+function setupEventListeners(eventSource, controller, eventTypes) {
+  var addListener = function addListener(type) {
+    eventSource.addEventListener(type, function (event) {
+      var data = JSON.parse(event.data);
+      controller.enqueue({
+        type: type,
+        data: data
+      }); // Enqueue data into the stream
+    });
+  };
+
+  // Set up listeners for all event types except END
+  Object.values(eventTypes).forEach(function (type) {
+    if (type !== eventTypes.END) {
+      addListener(type);
+    }
+  });
+
+  // Handle the END event separately to close the stream
+  eventSource.addEventListener(eventTypes.END, function () {
+    controller.close(); // Close the stream
+    eventSource.close(); // Close the EventSource connection
+  });
+
+  // Handle errors from the EventSource
+  // eslint-disable-next-line no-param-reassign
+  eventSource.onerror = function (error) {
+    controller.error(error); // Pass the error to the stream
+    eventSource.close(); // Close the EventSource connection
+  };
+}
+
+/**
+ * Interface to agent SSE.
+ * Replaces the previous Assistant module.
+ *
+ * @module agent
+ * @inner
+ * @returns {object}
+ */
+var Agent = /*#__PURE__*/function () {
+  function Agent(options) {
+    (0, _classCallCheck2["default"])(this, Agent);
+    this.options = options || {};
+  }
+  (0, _createClass2["default"])(Agent, [{
+    key: "getAgentResultsStream",
+    value:
+    /**
+     * Retrieve agent results from EventStream
+     *
+     * @function getAgentResultsStream
+     * @description Retrieve a stream of agent results from Constructor.io API
+     * @param {string} intent - Intent to use to perform an intent based recommendations
+     * @param {object} [parameters] - Additional parameters to refine result set
+     * @param {string} [parameters.domain] - domain name e.g. swimming sports gear, groceries
+     * @param {number} [parameters.numResultsPerPage] - The total number of results to return
+     * @returns {ReadableStream} Returns a ReadableStream.
+     * @example
+     * const readableStream = constructorio.agent.getAgentResultsStream('I want to get shoes', {
+     *     domain: "nike_sportswear",
+     * });
+     * const reader = readableStream.getReader();
+     * const { value, done } = await reader.read();
+     */
+    function getAgentResultsStream(query, parameters) {
+      var eventSource;
+      var readableStream;
+      try {
+        var requestUrl = createAgentUrl(query, parameters, this.options);
+
+        // Create an EventSource that connects to the Server Sent Events API
+        eventSource = new EventSource(requestUrl);
+
+        // Create a readable stream that data will be pushed into
+        readableStream = new ReadableStream({
+          // To be called on stream start
+          start: function start(controller) {
+            // Listen to events emitted from ASA Server Sent Events and push data to the ReadableStream
+            setupEventListeners(eventSource, controller, Agent.EventTypes);
+          },
+          // To be called on stream cancelling
+          cancel: function cancel() {
+            // Close the EventSource connection when the stream is prematurely canceled
+            eventSource.close();
+          }
+        });
+      } catch (e) {
+        if (readableStream) {
+          var _readableStream;
+          (_readableStream = readableStream) === null || _readableStream === void 0 ? void 0 : _readableStream.cancel();
+        } else {
+          var _eventSource;
+          // If the stream was not successfully created, close the EventSource directly
+          (_eventSource = eventSource) === null || _eventSource === void 0 ? void 0 : _eventSource.close();
+        }
+        throw new Error(e.message);
+      }
+      return readableStream;
+    }
+  }]);
+  return Agent;
+}();
+(0, _defineProperty2["default"])(Agent, "EventTypes", {
+  START: 'start',
+  // Denotes the start of the stream
+  GROUP: 'group',
+  // Represents a semantic grouping of search results, optionally having textual explanation
+  SEARCH_RESULT: 'search_result',
+  // Represents a set of results with metadata (used to show results with search refinements)
+  ARTICLE_REFERENCE: 'article_reference',
+  // Represents a set of content with metadata
+  RECIPE_INFO: 'recipe_info',
+  // Represents recipes' auxiliary information like cooking times & serving sizes
+  RECIPE_INSTRUCTIONS: 'recipe_instructions',
+  // Represents recipe instructions
+  SERVER_ERROR: 'server_error',
+  // Server Error event
+  IMAGE_META: 'image_meta',
+  // This event type is used for enhancing recommendations with media content such as images
+  END: 'end' // Represents the end of data stream
+});
+
+module.exports = Agent;
+module.exports.createAgentUrl = createAgentUrl;
+module.exports.setupEventListeners = setupEventListeners;

package/lib/modules/assistant.js

@@ -3,124 +3,38 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _require = require('../utils/helpers'),
-  cleanParams = _require.cleanParams,
-  trimNonBreakingSpaces = _require.trimNonBreakingSpaces,
-  encodeURIComponentRFC3986 = _require.encodeURIComponentRFC3986,
-  stringify = _require.stringify;
-
-// Create URL from supplied intent (term) and parameters
-function createAssistantUrl(intent, parameters, options) {
-  var apiKey = options.apiKey,
-    version = options.version,
-    sessionId = options.sessionId,
-    clientId = options.clientId,
-    userId = options.userId,
-    segments = options.segments,
-    testCells = options.testCells,
-    assistantServiceUrl = options.assistantServiceUrl;
-  var queryParams = {
-    c: version
-  };
-  queryParams.key = apiKey;
-  queryParams.i = clientId;
-  queryParams.s = sessionId;
-
-  // Validate intent is provided
-  if (!intent || typeof intent !== 'string') {
-    throw new Error('intent is a required parameter of type string');
-  }
-
-  // Validate domain is provided
-  if (!parameters.domain || typeof parameters.domain !== 'string') {
-    throw new Error('parameters.domain is a required parameter of type string');
-  }
-
-  // Pull test cells from options
-  if (testCells) {
-    Object.keys(testCells).forEach(function (testCellKey) {
-      queryParams["ef-".concat(testCellKey)] = testCells[testCellKey];
-    });
-  }
-
-  // Pull user segments from options
-  if (segments && segments.length) {
-    queryParams.us = segments;
-  }
-
-  // Pull user id from options and ensure string
-  if (userId) {
-    queryParams.ui = String(userId);
-  }
-  if (parameters) {
-    var domain = parameters.domain,
-      numResultsPerPage = parameters.numResultsPerPage;
-
-    // Pull domain from parameters
-    if (domain) {
-      queryParams.domain = domain;
-    }
-
-    // Pull results number from parameters
-    if (numResultsPerPage) {
-      queryParams.num_results_per_page = numResultsPerPage;
-    }
-  }
-
-  // eslint-disable-next-line no-underscore-dangle
-  queryParams._dt = Date.now();
-  queryParams = cleanParams(queryParams);
-  var queryString = stringify(queryParams);
-  var cleanedQuery = intent.replace(/^\//, '|'); // For compatibility with backend API
-
-  return "".concat(assistantServiceUrl, "/v1/intent/").concat(encodeURIComponentRFC3986(trimNonBreakingSpaces(cleanedQuery)), "?").concat(queryString);
-}
-
-// Add event listeners to custom SSE that pushes data to the stream
-function setupEventListeners(eventSource, controller, eventTypes) {
-  var addListener = function addListener(type) {
-    eventSource.addEventListener(type, function (event) {
-      var data = JSON.parse(event.data);
-      controller.enqueue({
-        type: type,
-        data: data
-      }); // Enqueue data into the stream
-    });
-  };
-
-  // Set up listeners for all event types except END
-  Object.values(eventTypes).forEach(function (type) {
-    if (type !== eventTypes.END) {
-      addListener(type);
-    }
-  });
-
-  // Handle the END event separately to close the stream
-  eventSource.addEventListener(eventTypes.END, function () {
-    controller.close(); // Close the stream
-    eventSource.close(); // Close the EventSource connection
-  });
-
-  // Handle errors from the EventSource
-  // eslint-disable-next-line no-param-reassign
-  eventSource.onerror = function (error) {
-    controller.error(error); // Pass the error to the stream
-    eventSource.close(); // Close the EventSource connection
-  };
-}
+function _createSuper(t) { var r = _isNativeReflectConstruct(); return function () { var e, o = (0, _getPrototypeOf2["default"])(t); if (r) { var s = (0, _getPrototypeOf2["default"])(this).constructor; e = Reflect.construct(o, arguments, s); } else e = o.apply(this, arguments); return (0, _possibleConstructorReturn2["default"])(this, e); }; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var Agent = require('./agent');
+var _require = require('./agent'),
+  createAgentUrl = _require.createAgentUrl,
+  setupEventListeners = _require.setupEventListeners;
 
 /**
+ * @deprecated This module is deprecated and will be removed in a future version. Use the Agent module instead.
  * Interface to assistant SSE.
  *
  * @module assistant
  * @inner
  * @returns {object}
  */
-var Assistant = /*#__PURE__*/function () {
-  function Assistant(options) {
+var Assistant = /*#__PURE__*/function (_Agent) {
+  (0, _inherits2["default"])(Assistant, _Agent);
+  var _super = _createSuper(Assistant);
+  function Assistant() {
+    var _this;
     (0, _classCallCheck2["default"])(this, Assistant);
-    this.options = options || {};
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    _this = _super.call.apply(_super, [this].concat(args));
+    (0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "EventTypes", Agent.EventTypes);
+    return _this;
   }
   (0, _createClass2["default"])(Assistant, [{
     key: "getAssistantResultsStream",
@@ -128,6 +42,7 @@ var Assistant = /*#__PURE__*/function () {
     /**
      * Retrieve assistant results from EventStream
      *
+     * @deprecated Use getAssistantResultsStream from the Agent module instead.
      * @function getAssistantResultsStream
      * @description Retrieve a stream of assistant results from Constructor.io API
      * @param {string} intent - Intent to use to perform an intent based recommendations
@@ -143,63 +58,11 @@ var Assistant = /*#__PURE__*/function () {
      * const { value, done } = await reader.read();
      */
     function getAssistantResultsStream(query, parameters) {
-      var eventSource;
-      var readableStream;
-      try {
-        var requestUrl = createAssistantUrl(query, parameters, this.options);
-
-        // Create an EventSource that connects to the Server Sent Events API
-        eventSource = new EventSource(requestUrl);
-
-        // Create a readable stream that data will be pushed into
-        readableStream = new ReadableStream({
-          // To be called on stream start
-          start: function start(controller) {
-            // Listen to events emitted from ASA Server Sent Events and push data to the ReadableStream
-            setupEventListeners(eventSource, controller, Assistant.EventTypes);
-          },
-          // To be called on stream cancelling
-          cancel: function cancel() {
-            // Close the EventSource connection when the stream is prematurely canceled
-            eventSource.close();
-          }
-        });
-      } catch (e) {
-        if (readableStream) {
-          var _readableStream;
-          (_readableStream = readableStream) === null || _readableStream === void 0 ? void 0 : _readableStream.cancel();
-        } else {
-          var _eventSource;
-          // If the stream was not successfully created, close the EventSource directly
-          (_eventSource = eventSource) === null || _eventSource === void 0 ? void 0 : _eventSource.close();
-        }
-        throw new Error(e.message);
-      }
-      return readableStream;
+      return this.getAgentResultsStream(query, parameters);
     }
   }]);
   return Assistant;
-}();
-(0, _defineProperty2["default"])(Assistant, "EventTypes", {
-  START: 'start',
-  // Denotes the start of the stream
-  GROUP: 'group',
-  // Represents a semantic grouping of search results, optionally having textual explanation
-  SEARCH_RESULT: 'search_result',
-  // Represents a set of results with metadata (used to show results with search refinements)
-  ARTICLE_REFERENCE: 'article_reference',
-  // Represents a set of content with metadata
-  RECIPE_INFO: 'recipe_info',
-  // Represents recipes' auxiliary information like cooking times & serving sizes
-  RECIPE_INSTRUCTIONS: 'recipe_instructions',
-  // Represents recipe instructions
-  SERVER_ERROR: 'server_error',
-  // Server Error event
-  IMAGE_META: 'image_meta',
-  // This event type is used for enhancing recommendations with media content such as images
-  END: 'end' // Represents the end of data stream
-});
-
+}(Agent);
 module.exports = Assistant;
-module.exports.createAssistantUrl = createAssistantUrl;
+module.exports.createAssistantUrl = createAgentUrl;
 module.exports.setupEventListeners = setupEventListeners;

package/lib/modules/tracker.js

@@ -993,7 +993,6 @@ var Tracker = /*#__PURE__*/function () {
      *         itemName: 'Red T-Shirt',
      *         variationId: 'KMH879-7632',
      *         type: 'like',
-     *         resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
      *         section: 'Products',
      *     },
      * );
@@ -2276,25 +2275,25 @@ var Tracker = /*#__PURE__*/function () {
     /**
      * Send ASA request submitted event
      *
-     * @function trackAssistantSubmit
+     * @function trackAgentSubmit
      * @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)
+     * @description User submitted an agent search
+     *   (pressing enter within agent input element, or clicking agent submit element)
      * @example
-     * constructorio.tracker.trackAssistantSubmit(
+     * constructorio.tracker.trackAgentSubmit(
      *     {
      *         intent: 'show me a recipe for a cookie',
      *     },
      * );
      */
   }, {
-    key: "trackAssistantSubmit",
-    value: function trackAssistantSubmit(parameters) {
+    key: "trackAgentSubmit",
+    value: function trackAgentSubmit(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)
@@ -2319,9 +2318,9 @@ var Tracker = /*#__PURE__*/function () {
     }
 
     /**
-     * Send assistant results page load started
+     * Send agent results page load started
      *
-     * @function trackAssistantResultLoadStarted
+     * @function trackAgentResultLoadStarted
      * @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"
@@ -2329,9 +2328,9 @@ var Tracker = /*#__PURE__*/function () {
      * @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)
+     * @description Agent results page load begun (but has not necessarily loaded completely)
      * @example
-     * constructorio.tracker.trackAssistantResultLoadStarted(
+     * constructorio.tracker.trackAgentResultLoadStarted(
      *     {
      *         intent: 'show me a recipe for a cookie',
      *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
@@ -2339,8 +2338,8 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackAssistantResultLoadStarted",
-    value: function trackAssistantResultLoadStarted(parameters) {
+    key: "trackAgentResultLoadStarted",
+    value: function trackAgentResultLoadStarted(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)
@@ -2367,9 +2366,9 @@ var Tracker = /*#__PURE__*/function () {
     }
 
     /**
-     * Send assistant results page load finished
+     * Send agent results page load finished
      *
-     * @function trackAssistantResultLoadFinished
+     * @function trackAgentResultLoadFinished
      * @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
@@ -2378,9 +2377,9 @@ var Tracker = /*#__PURE__*/function () {
      * @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
+     * @description Agent results page load finished
      * @example
-     * constructorio.tracker.trackAssistantResultLoadFinished(
+     * constructorio.tracker.trackAgentResultLoadFinished(
      *     {
      *         intent: 'show me a recipe for a cookie',
      *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
@@ -2389,8 +2388,8 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackAssistantResultLoadFinished",
-    value: function trackAssistantResultLoadFinished(parameters) {
+    key: "trackAgentResultLoadFinished",
+    value: function trackAgentResultLoadFinished(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)) {
@@ -2419,9 +2418,9 @@ var Tracker = /*#__PURE__*/function () {
     }
 
     /**
-     * Send assistant result click event to API
+     * Send agent result click event to API
      *
-     * @function trackAssistantResultClick
+     * @function trackAgentResultClick
      * @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
@@ -2433,9 +2432,9 @@ var Tracker = /*#__PURE__*/function () {
      * @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
+     * @description User clicked a result that appeared within an agent search result
      * @example
-     * constructorio.tracker.trackAssistantResultClick(
+     * constructorio.tracker.trackAgentResultClick(
      *     {
      *         variationId: 'KMH879-7632',
      *         searchResultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
@@ -2446,8 +2445,8 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackAssistantResultClick",
-    value: function trackAssistantResultClick(parameters) {
+    key: "trackAgentResultClick",
+    value: function trackAgentResultClick(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)) {
@@ -2483,9 +2482,9 @@ var Tracker = /*#__PURE__*/function () {
     }
 
     /**
-     * Send assistant search result view event to API
+     * Send agent search result view event to API
      *
-     * @function trackAssistantResultView
+     * @function trackAgentResultView
      * @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
@@ -2496,9 +2495,9 @@ var Tracker = /*#__PURE__*/function () {
      * @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
+     * @description User viewed a search result within an agent result
      * @example
-     * constructorio.tracker.trackAssistantResultView(
+     * constructorio.tracker.trackAgentResultView(
      *     {
      *         searchResultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
      *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
@@ -2509,8 +2508,8 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackAssistantResultView",
-    value: function trackAssistantResultView(parameters) {
+    key: "trackAgentResultView",
+    value: function trackAgentResultView(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)) {
@@ -2548,19 +2547,19 @@ var Tracker = /*#__PURE__*/function () {
     /**
      * Send ASA search submitted event
      *
-     * @function trackAssistantSearchSubmit
+     * @function trackAgentSearchSubmit
      * @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.searchTerm - Term of submitted agent 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
+     * @description User submitted an alternative agent search result search term
      * @example
-     * constructorio.tracker.trackAssistantSearchSubmit({
+     * constructorio.tracker.trackAgentSearchSubmit({
      *     {
      *         searchResultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
      *         intentResultId: 'Zde93fd-f955-4020-8b8d-6b21b93cb5a2',
@@ -2570,8 +2569,8 @@ var Tracker = /*#__PURE__*/function () {
      * );
      */
   }, {
-    key: "trackAssistantSearchSubmit",
-    value: function trackAssistantSearchSubmit(parameters) {
+    key: "trackAgentSearchSubmit",
+    value: function trackAgentSearchSubmit(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)) {
@@ -2602,6 +2601,192 @@ var Tracker = /*#__PURE__*/function () {
       return new Error('parameters is a required parameter of type object');
     }
 
+    /**
+     * Send ASA request submitted event
+     *
+     * @deprecated This method will be removed in a future version. Use trackAgentSubmit instead.
+     * @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] : {};
+      return this.trackAgentSubmit(parameters, networkParameters);
+    }
+
+    /**
+     * Send assistant results page load started
+     *
+     * @deprecated This method will be removed in a future version. Use trackAgentResultLoadStarted instead.
+     * @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] : {};
+      return this.trackAgentResultLoadStarted(parameters, networkParameters);
+    }
+
+    /**
+     * Send assistant results page load finished
+     *
+     * @deprecated This method will be removed in a future version. Use trackAgentResultLoadFinished instead.
+     * @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] : {};
+      return this.trackAgentResultLoadFinished(parameters, networkParameters);
+    }
+
+    /**
+     * Send assistant result click event to API
+     *
+     * @deprecated This method will be removed in a future version. Use trackAgentResultClick instead.
+     * @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] : {};
+      return this.trackAgentResultClick(parameters, networkParameters);
+    }
+
+    /**
+     * Send assistant search result view event to API
+     *
+     * @deprecated This method will be removed in a future version. Use trackAgentResultView instead.
+     * @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] : {};
+      return this.trackAgentResultView(parameters, networkParameters);
+    }
+
+    /**
+     * Send ASA search submitted event
+     *
+     * @deprecated This method will be removed in a future version. Use trackAgentSearchSubmit instead.
+     * @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] : {};
+      return this.trackAgentSearchSubmit(parameters, networkParameters);
+    }
+
     /**
      * Send product insights agent view events
      *

package/lib/types/agent.d.ts

@@ -0,0 +1,22 @@
+import {
+  ConstructorClientOptions,
+} from '.';
+
+export default Agent;
+
+export interface IAgentParameters {
+  domain: string;
+  numResultsPerPage?: number;
+  filters?: Record<string, any>;
+}
+
+declare class Agent {
+  constructor(options: ConstructorClientOptions);
+
+  options: ConstructorClientOptions;
+
+  getAgentResultsStream(
+    intent: string,
+    parameters?: IAgentParameters,
+  ): ReadableStream;
+}

package/lib/types/constructorio.d.ts

@@ -3,6 +3,7 @@ import Browse from './browse';
 import Autocomplete from './autocomplete';
 import Recommendations from './recommendations';
 import Quizzes from './quizzes';
+import Agent from './agent';
 import Assistant from './assistant';
 import Tracker from './tracker';
 import { ConstructorClientOptions } from '.';
@@ -24,6 +25,8 @@ declare class ConstructorIO {
 
   quizzes: Quizzes;
 
+  agent: Agent;
+
   assistant: Assistant;
 
   tracker: Tracker;
@@ -32,5 +35,5 @@ declare class ConstructorIO {
 }
 
 declare namespace ConstructorIO {
-  export { Search, Browse, Autocomplete, Recommendations, Quizzes, Tracker, Assistant };
+  export { Search, Browse, Autocomplete, Recommendations, Quizzes, Tracker, Agent, Assistant };
 }

package/lib/types/index.d.ts

@@ -47,7 +47,8 @@ export interface ConstructorClientOptions {
   version?: string;
   serviceUrl?: string;
   quizzesServiceUrl?: string;
-  assistantServiceUrl?: string,
+  agentServiceUrl?: string;
+  assistantServiceUrl?: string;
   sessionId?: number;
   clientId?: string;
   userId?: string;

package/lib/types/tracker.d.ts

@@ -266,7 +266,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackAssistantSubmit(
+  trackAgentSubmit(
     parameters: {
       intent: string;
       section?: string;
@@ -274,7 +274,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackAssistantResultLoadStarted(
+  trackAgentResultLoadStarted(
     parameters: {
       intent: string;
       section?: string;
@@ -283,7 +283,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackAssistantResultLoadFinished(
+  trackAgentResultLoadFinished(
     parameters: {
       intent: string;
       searchResultCount: number;
@@ -293,7 +293,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackAssistantResultClick(
+  trackAgentResultClick(
     parameters: {
       intent: string;
       searchResultId: string;
@@ -306,7 +306,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackAssistantResultView(
+  trackAgentResultView(
     parameters: {
       intent: string;
       searchResultId: string;
@@ -318,7 +318,7 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackAssistantSearchSubmit(
+  trackAgentSearchSubmit(
     parameters: {
       intent: string;
       searchTerm: string;
@@ -331,71 +331,107 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
-  trackProductInsightsAgentViews(parameters: {
-    questions: Question[];
-    itemId: string;
-    itemName: string;
-    viewTimespans: TimeSpan[];
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentView(parameters: {
-    questions: Question[];
-    itemId: string;
-    itemName: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentOutOfView(parameters: {
-    itemId: string;
-    itemName: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentFocus(parameters: {
-    itemId: string;
-    itemName: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentQuestionClick(parameters: {
-    itemId: string;
-    itemName: string;
-    question: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentQuestionSubmit(parameters: {
-    itemId: string;
-    itemName: string;
-    question: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentAnswerView(parameters: {
-    itemId: string;
-    itemName: string;
-    question: string;
-    answerText: string;
-    qnaResultId?: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
-
-  trackProductInsightsAgentAnswerFeedback(parameters: {
-    itemId: string;
-    itemName: string;
-    feedbackLabel: string;
-    qnaResultId?: string;
-    variationId?: string;
-    section?: string;
-  }, networkParameters?: NetworkParameters): true | Error;
+  trackAssistantSubmit: typeof Tracker.prototype.trackAgentSubmit;
+
+  trackAssistantResultLoadStarted: typeof Tracker.prototype.trackAgentResultLoadStarted;
+
+  trackAssistantResultLoadFinished: typeof Tracker.prototype.trackAgentResultLoadFinished;
+
+  trackAssistantResultClick: typeof Tracker.prototype.trackAgentResultClick;
+
+  trackAssistantResultView: typeof Tracker.prototype.trackAgentResultView;
+
+  trackAssistantSearchSubmit: typeof Tracker.prototype.trackAgentSearchSubmit;
+
+  trackProductInsightsAgentViews(
+    parameters: {
+      questions: Question[];
+      itemId: string;
+      itemName: string;
+      viewTimespans: TimeSpan[];
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentView(
+    parameters: {
+      questions: Question[];
+      itemId: string;
+      itemName: string;
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentOutOfView(
+    parameters: {
+      itemId: string;
+      itemName: string;
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentFocus(
+    parameters: {
+      itemId: string;
+      itemName: string;
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentQuestionClick(
+    parameters: {
+      itemId: string;
+      itemName: string;
+      question: string;
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentQuestionSubmit(
+    parameters: {
+      itemId: string;
+      itemName: string;
+      question: string;
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentAnswerView(
+    parameters: {
+      itemId: string;
+      itemName: string;
+      question: string;
+      answerText: string;
+      qnaResultId?: string;
+      variationId?: string;
+      section?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackProductInsightsAgentAnswerFeedback(
+    parameters: {
+      itemId: string;
+      itemName: string;
+      feedbackLabel: string;
+      qnaResultId?: string;
+      variationId?: string;
+      section?: 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.66.1';
+var _default = '2.67.0';
 exports["default"] = _default;

package/package.json

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