@constructor-io/constructorio-node 4.7.5 → 4.9.0

package/package.json

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

package/src/modules/recommendations.js

@@ -38,7 +38,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
   }
 
   if (parameters) {
-    const { numResults, itemIds, section, term, filters, variationsMap } = parameters;
+    const { numResults, itemIds, section, term, filters, variationsMap, hiddenFields } = parameters;
 
     // Pull num results number from parameters
     if (!helpers.isNil(numResults)) {
@@ -65,6 +65,15 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
       queryParams.filters = filters;
     }
 
+    // Pull hidden fields from parameters
+    if (hiddenFields) {
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = { hidden_fields: hiddenFields };
+      }
+    }
+
     // Pull variations map from parameters
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
@@ -102,6 +111,7 @@ class Recommendations {
    * @param {string} [parameters.term] - The term to use to refine results (strategy specific)
    * @param {object} [parameters.filters] - Key / value mapping of filters used to refine results
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
+   * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @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

package/src/modules/tracker.js

@@ -277,6 +277,7 @@ class Tracker {
    * @param {string} parameters.itemId - Product item unique identifier
    * @param {string} parameters.url - Current page URL
    * @param {string} [parameters.variationId] - Product item variation unique identifier
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @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
@@ -317,6 +318,7 @@ class Tracker {
         itemId = item_id || customerId,
         variationId = variation_id,
         url,
+        analyticsTags,
       } = parameters;
 
       // Ensure support for both item_name and name as parameters
@@ -337,6 +339,10 @@ class Tracker {
         bodyParams.url = url;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -759,6 +765,7 @@ class Tracker {
    * @param {boolean} [parameters.isCustomType] - Specify if type is custom conversion type
    * @param {string} [parameters.displayName] - Display name for the custom conversion type
    * @param {string} [parameters.section] - Index section
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @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
@@ -818,6 +825,7 @@ class Tracker {
         type,
         is_custom_type,
         isCustomType = is_custom_type,
+        analyticsTags,
       } = parameters;
 
       // Ensure support for both item_id and customer_id as parameters
@@ -859,6 +867,10 @@ class Tracker {
         bodyParams.display_name = displayName;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString(queryParams, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -887,6 +899,7 @@ class Tracker {
    * @param {number} parameters.revenue - The subtotal (excluding taxes, shipping, etc.) of the entire order
    * @param {string} [parameters.orderId] - Unique order identifier
    * @param {string} [parameters.section] - Index section
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @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
@@ -931,6 +944,7 @@ class Tracker {
         order_id,
         orderId = order_id,
         section,
+        analyticsTags,
       } = parameters;
 
       if (orderId) {
@@ -945,6 +959,10 @@ class Tracker {
         bodyParams.revenue = revenue;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       if (section) {
         queryParams.section = section;
       } else {
@@ -983,6 +1001,7 @@ class Tracker {
    * @param {number} [parameters.resultPage] - Page number of results
    * @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 {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
@@ -1037,6 +1056,7 @@ class Tracker {
         num_results_viewed,
         numResultsViewed = num_results_viewed,
         items,
+        analyticsTags,
       } = parameters;
 
       if (!helpers.isNil(resultCount)) {
@@ -1073,6 +1093,10 @@ class Tracker {
         bodyParams.items = items.slice(0, 100).map((item) => helpers.toSnakeCaseKeys(item, false));
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -1108,6 +1132,7 @@ class Tracker {
    * @param {number} [parameters.resultPage] - Page number of results
    * @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 {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
@@ -1172,6 +1197,7 @@ class Tracker {
         itemId = item_id,
         item_name,
         itemName = item_name,
+        analyticsTags,
       } = parameters;
 
       if (variationId) {
@@ -1220,6 +1246,10 @@ class Tracker {
         bodyParams.item_name = itemName;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -1255,6 +1285,7 @@ class Tracker {
    * @param {object} [parameters.selectedFilters] - Selected filters
    * @param {string} [parameters.sortOrder] - Sort order ('ascending' or 'descending')
    * @param {string} [parameters.sortBy] - Sorting method
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @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
@@ -1318,6 +1349,7 @@ class Tracker {
         filter_value,
         filterValue = filter_value,
         items,
+        analyticsTags,
       } = parameters;
 
       if (section) {
@@ -1366,6 +1398,10 @@ class Tracker {
         bodyParams.items = items.slice(0, 100).map((item) => helpers.toSnakeCaseKeys(item, false));
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -1401,6 +1437,7 @@ class Tracker {
    * @param {number} [parameters.resultPositionOnPage] - Position of clicked item
    * @param {number} [parameters.numResultsPerPage] - Number of results shown
    * @param {object} [parameters.selectedFilters] -  Selected filters
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @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
@@ -1466,6 +1503,7 @@ class Tracker {
         filterValue = filter_value,
         item_id,
         itemId = item_id,
+        analyticsTags,
       } = parameters;
 
       if (section) {
@@ -1514,6 +1552,10 @@ class Tracker {
         bodyParams.item_id = itemId;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -1542,6 +1584,7 @@ class Tracker {
    * @param {string} [parameters.itemName] - Product item name
    * @param {string} [parameters.variationId] - Product item variation unique identifier
    * @param {string} [parameters.section="Products"] - Index section
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @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
@@ -1586,6 +1629,7 @@ class Tracker {
         variation_id,
         variationId = variation_id,
         section,
+        analyticsTags,
       } = parameters;
 
       bodyParams.section = section || 'Products';
@@ -1599,6 +1643,10 @@ class Tracker {
         bodyParams.variation_id = variationId;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });

package/src/types/recommendations.d.ts

@@ -9,6 +9,7 @@ export interface RecommendationsParameters {
   term?: string;
   filters?: Record<string, any>;
   variationsMap?: VariationsMap;
+  hiddenFields?: string[];
 }
 
 declare class Recommendations {

package/src/types/tracker.d.ts

@@ -39,6 +39,7 @@ declare class Tracker {
       itemId: string;
       url: string;
       variationId?: string;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -104,6 +105,7 @@ declare class Tracker {
       displayName?: string;
       resultId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -115,6 +117,7 @@ declare class Tracker {
       revenue: number;
       orderId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -130,6 +133,7 @@ declare class Tracker {
       resultPage?: number;
       resultId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -148,6 +152,7 @@ declare class Tracker {
       resultPage?: number;
       resultPositionOnPage?: number;
       numResultsPerPage?: number;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -166,6 +171,7 @@ declare class Tracker {
       sortOrder?: string;
       sortBy?: string;
       items: ItemTracked[];
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -184,6 +190,7 @@ declare class Tracker {
       resultPositionOnPage?: number;
       numResultsPerPage?: number;
       selectedFilters?: object;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -195,6 +202,7 @@ declare class Tracker {
       itemName?: string;
       variationId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters