@constructor-io/constructorio-node 5.7.0 → 5.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "5.7.0",
+  "version": "5.9.0",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",
@@ -53,13 +53,13 @@
     "sinon": "^7.5.0",
     "sinon-chai": "^3.7.0",
     "tsd": "^0.25.0",
-    "uuid": "^8.3.2"
+    "uuid": "^14.0.0"
   },
   "dependencies": {
     "form-data": "^4.0.0",
     "node-abort-controller": "^3.0.0",
     "node-fetch": "^3.3.2",
-    "qs": "6.14.2"
+    "qs": "6.15.2"
   },
   "tsd": {
     "directory": "src/types/tests"

package/src/modules/autocomplete.js

@@ -16,6 +16,7 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
     userId,
     segments,
     testCells,
+    originReferrer,
   } = userParameters;
   let queryParams = { c: version };
 
@@ -45,6 +46,11 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   if (parameters) {
     const {
       numResults,
@@ -155,6 +161,7 @@ class Autocomplete {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/modules/browse.js

@@ -16,6 +16,7 @@ function createQueryParams(parameters, userParameters, options) {
     userId,
     segments,
     testCells,
+    originReferrer,
   } = userParameters;
   let queryParams = { c: version };
 
@@ -130,6 +131,11 @@ function createQueryParams(parameters, userParameters, options) {
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   queryParams._dt = Date.now();
   queryParams = helpers.cleanParams(queryParams);
 
@@ -265,6 +271,7 @@ class Browse {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -350,6 +357,7 @@ class Browse {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -417,6 +425,7 @@ class Browse {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -480,6 +489,7 @@ class Browse {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -540,6 +550,7 @@ class Browse {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/modules/quizzes.js

@@ -15,6 +15,7 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
     clientId,
     userId,
     segments,
+    originReferrer,
   } = userParameters;
   const serviceUrl = 'https://quizzes.cnstrc.com';
   let queryParams = { c: version };
@@ -34,6 +35,11 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   // Validate quiz id is provided
   if (!quizId || typeof quizId !== 'string') {
     throw new Error('quizId is a required parameter of type string');
@@ -124,6 +130,7 @@ class Quizzes {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -207,6 +214,7 @@ class Quizzes {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/modules/recommendations.js

@@ -15,6 +15,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     clientId,
     userId,
     segments,
+    originReferrer,
   } = userParameters;
   let queryParams = { c: version };
 
@@ -37,6 +38,11 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   if (parameters) {
     const {
       numResults,
@@ -147,6 +153,7 @@ class Recommendations {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

package/src/modules/search.js

@@ -18,6 +18,7 @@ function createSearchUrl(query, parameters, userParameters, options, isVoiceSear
     userId,
     segments,
     testCells,
+    originReferrer,
   } = userParameters;
   let queryParams = { c: version };
 
@@ -47,6 +48,11 @@ function createSearchUrl(query, parameters, userParameters, options, isVoiceSear
     queryParams.ui = String(userId);
   }
 
+  // Pull origin referrer from userParameters
+  if (originReferrer && typeof originReferrer === 'string') {
+    queryParams.origin_referrer = originReferrer;
+  }
+
   if (parameters) {
     const {
       page,
@@ -186,6 +192,7 @@ class Search {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -288,6 +295,7 @@ class Search {
    * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string[]} [userParameters.segments] - User segments
    * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request

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/index.d.ts

@@ -27,6 +27,7 @@ export interface UserParameters {
   userId?: string;
   segments?: string[];
   testCells?: Record<string, any>;
+  originReferrer?: string;
   userIp?: string;
   userAgent?: string;
 }

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