@constructor-io/constructorio-node 4.6.6 → 4.6.8

package/package.json

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

package/src/modules/autocomplete.js

@@ -133,10 +133,6 @@ class Autocomplete {
    *     filters: {
    *         size: 'medium'
    *     },
-   * }, {
-   *     testCells: {
-   *         testName: 'cellName',
-   *    },
    * });
    */
   getAutocompleteResults(query, parameters = {}, userParameters = {}, networkParameters = {}) {

package/src/modules/browse.js

@@ -277,10 +277,6 @@ class Browse {
    *     filters: {
    *         size: 'medium'
    *     },
-   * }, {
-   *     testCells: {
-   *         testName: 'cellName',
-   *    },
    * });
    */
   getBrowseResults(filterName, filterValue, parameters = {}, userParameters = {}, networkParameters = {}) {
@@ -361,10 +357,6 @@ class Browse {
    *     filters: {
    *         size: 'medium'
    *     },
-   * }, {
-   *     testCells: {
-   *         'testName': 'cellName',
-   *    },
    * });
    */
   getBrowseResultsForItemIds(itemIds, parameters = {}, userParameters = {}, networkParameters = {}) {
@@ -433,10 +425,6 @@ class Browse {
    *     fmtOptions: {
    *         groups_max_depth: 2
    *     }
-   * }, {
-   *     testCells: {
-   *         'testName': 'cellName',
-   *    },
    * });
    */
   getBrowseGroups(parameters = {}, userParameters = {}, networkParameters = {}) {
@@ -492,10 +480,6 @@ class Browse {
    * constructorio.browse.getBrowseFacets({
    *     page: 1,
    *     resultsPerPage: 10,
-   * }, {
-   *     testCells: {
-   *         'testName': 'cellName',
-   *    },
    * });
    */
   getBrowseFacets(parameters = {}, userParameters = {}, networkParameters = {}) {

package/src/modules/recommendations.js

@@ -120,10 +120,6 @@ class Recommendations {
    *     filters: {
    *         size: 'medium'
    *     },
-   * }, {
-   *     testCells: {
-   *         testName: 'cellName',
-   *    },
    * });
    */
   getRecommendations(podId, parameters = {}, userParameters = {}, networkParameters = {}) {

package/src/modules/search.js

@@ -197,10 +197,6 @@ class Search {
    *     filters: {
    *         size: 'medium'
    *     },
-   * }, {
-   *     testCells: {
-   *         testName: 'cellName',
-   *    },
    * });
    */
 

package/src/modules/tracker.js

@@ -548,7 +548,7 @@ class Tracker {
    * @param {string} term - Search results query term
    * @param {object} parameters - Additional parameters to be sent with request
    * @param {number} parameters.numResults - Total number of results
-   * @param {string[]} [parameters.itemIds] - List of product item unique identifiers in search results listing
+   * @param {string[]} parameters.itemIds - List of product item unique identifiers in search results listing
    * @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
@@ -975,6 +975,7 @@ class Tracker {
    * @param {string} parameters.url - Current page URL
    * @param {string} parameters.podId - Pod identifier
    * @param {number} parameters.numResultsViewed - Number of results viewed
+   * @param {object[]} [parameters.items] - List of Product Item objects
    * @param {number} [parameters.resultCount] - Total number of results
    * @param {number} [parameters.resultPage] - Page number of results
    * @param {string} [parameters.resultId] - Recommendation result identifier (returned in response from Constructor)
@@ -997,6 +998,7 @@ class Tracker {
    * @example
    * constructorio.tracker.trackRecommendationView(
    *     {
+   *         items: [{ itemId: 'KMH876' }, { itemId: 'KMH140' }],
    *         resultCount: 22,
    *         resultPage: 2,
    *         resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
@@ -1031,6 +1033,7 @@ class Tracker {
         podId = pod_id,
         num_results_viewed,
         numResultsViewed = num_results_viewed,
+        items,
       } = parameters;
 
       if (!helpers.isNil(resultCount)) {
@@ -1063,6 +1066,10 @@ class Tracker {
         bodyParams.num_results_viewed = numResultsViewed;
       }
 
+      if (items && Array.isArray(items)) {
+        bodyParams.items = items.slice(0, 100).map((item) => helpers.toSnakeCaseKeys(item, false));
+      }
+
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
@@ -1237,6 +1244,7 @@ class Tracker {
    * @param {string} parameters.url - Current page URL
    * @param {string} parameters.filterName - Filter name
    * @param {string} parameters.filterValue - Filter value
+   * @param {object[]} parameters.items - List of product item objects
    * @param {string} [parameters.section="Products"] - Index section
    * @param {number} [parameters.resultCount] - Total number of results
    * @param {number} [parameters.resultPage] - Page number of results
@@ -1244,7 +1252,6 @@ 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.items] - List of product item objects
    * @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/types/index.d.ts

@@ -332,3 +332,9 @@ export interface SearchabilityConfiguration {
   displayable?: boolean,
   hidden?: boolean,
 }
+
+export interface ItemTracked {
+  itemName?: string;
+  itemId?: string;
+  variationId?: string;
+}

package/src/types/tracker.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'events';
-import { ConstructorClientOptions, NetworkParameters } from '.';
+import { ConstructorClientOptions, NetworkParameters, ItemTracked } from '.';
 
 export default Tracker;
 
@@ -72,7 +72,7 @@ declare class Tracker {
     term: string,
     parameters: {
       numResults: number;
-      itemIds?: string[];
+      itemIds: string[];
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -111,7 +111,7 @@ declare class Tracker {
 
   trackPurchase(
     parameters: {
-      items: object[];
+      items: ItemTracked & {quantity: number}[];
       revenue: number;
       orderId?: string;
       section?: string;
@@ -125,7 +125,7 @@ declare class Tracker {
       url: string;
       podId: string;
       numResultsViewed: number;
-      items?: object[];
+      items?: ItemTracked[];
       resultCount?: number;
       resultPage?: number;
       resultId?: string;
@@ -165,7 +165,7 @@ declare class Tracker {
       selectedFilters?: object;
       sortOrder?: string;
       sortBy?: string;
-      items?: object[];
+      items: ItemTracked[];
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters