@constructor-io/constructorio-node 5.8.0 → 5.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "5.8.0",
+  "version": "5.9.0",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/modules/tracker.js

@@ -1061,6 +1061,7 @@ class Tracker {
    * @param {string} [parameters.resultId] - Recommendation result identifier (returned in response from Constructor)
    * @param {string} [parameters.section="Products"] - Results section
    * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+   * @param {string[]|string|number} [parameters.seedItemIds] - Item ID(s) used to generate recommendations
    * @param {object} userParameters - Parameters relevant to the user request
    * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
    * @param {string} userParameters.clientId - Client ID, utilized to personalize results
@@ -1087,6 +1088,7 @@ class Tracker {
    *         url: 'https://demo.constructor.io/sandbox/farmstand',
    *         podId: '019927c2-f955-4020',
    *         numResultsViewed: 3,
+   *         seedItemIds: ['UIH976']
    *     },
    *     {
    *         sessionId: 1,
@@ -1117,6 +1119,8 @@ class Tracker {
         numResultsViewed = num_results_viewed,
         items,
         analyticsTags,
+        seed_item_ids,
+        seedItemIds = seed_item_ids,
       } = parameters;
 
       if (!helpers.isNil(resultCount)) {
@@ -1157,6 +1161,12 @@ class Tracker {
         bodyParams.analytics_tags = analyticsTags;
       }
 
+      if ((typeof seedItemIds === 'string' || typeof seedItemIds === 'number') && String(seedItemIds).length) {
+        bodyParams.seed_item_ids = [String(seedItemIds)];
+      } else if (Array.isArray(seedItemIds) && seedItemIds.length) {
+        bodyParams.seed_item_ids = seedItemIds.map(String);
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -1193,6 +1203,7 @@ class Tracker {
    * @param {number} [parameters.resultPositionOnPage] - Position of result on page
    * @param {number} [parameters.numResultsPerPage] - Number of results on page
    * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+   * @param {string[]|string|number} [parameters.seedItemIds] - Item ID(s) used to generate recommendations
    * @param {object} userParameters - Parameters relevant to the user request
    * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
    * @param {string} userParameters.clientId - Client ID, utilized to personalize results
@@ -1221,6 +1232,7 @@ class Tracker {
    *         podId: '019927c2-f955-4020',
    *         strategyId: 'complimentary',
    *         itemId: 'KMH876',
+   *         seedItemIds: ['UIH976']
    *     },
    *     {
    *         sessionId: 1,
@@ -1259,6 +1271,8 @@ class Tracker {
         item_name,
         itemName = item_name,
         analyticsTags,
+        seed_item_ids,
+        seedItemIds = seed_item_ids,
       } = parameters;
 
       if (variationId) {
@@ -1311,6 +1325,12 @@ class Tracker {
         bodyParams.analytics_tags = analyticsTags;
       }
 
+      if ((typeof seedItemIds === 'string' || typeof seedItemIds === 'number') && String(seedItemIds).length) {
+        bodyParams.seed_item_ids = [String(seedItemIds)];
+      } else if (Array.isArray(seedItemIds) && seedItemIds.length) {
+        bodyParams.seed_item_ids = seedItemIds.map(String);
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });

package/src/types/tracker.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'events';
-import { ConstructorClientOptions, NetworkParameters, ItemTracked, ItemTrackedPurchased } from '.';
+import { ConstructorClientOptions, ItemTracked, ItemTrackedPurchased, NetworkParameters } from '.';
 
 export default Tracker;
 
@@ -144,6 +144,7 @@ declare class Tracker {
       resultId?: string;
       section?: string;
       analyticsTags?: Record<string, string>;
+      seedItemIds?: string[] | string | number;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -163,6 +164,7 @@ declare class Tracker {
       resultPositionOnPage?: number;
       numResultsPerPage?: number;
       analyticsTags?: Record<string, string>;
+      seedItemIds?: string[] | string | number;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters