@constructor-io/constructorio-node 4.6.5 → 4.6.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.6.5",
+  "version": "4.6.7",
   "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
@@ -1237,6 +1237,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 +1245,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/autocomplete.d.ts

@@ -4,6 +4,7 @@ import {
   RequestFeature,
   RequestFeatureVariant,
   UserParameters,
+  VariationsMap,
 } from '.';
 
 export default Autocomplete;
@@ -13,7 +14,7 @@ export interface AutocompleteParameters {
   filters?: Record<string, any>;
   resultsPerSection?: Record<string, number>;
   hiddenFields?: string[];
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
 }
 
 declare class Autocomplete {

package/src/types/browse.d.ts

@@ -12,6 +12,7 @@ import {
   SortOption,
   FmtOptions,
   FilterExpression,
+  VariationsMap,
 } from '.';
 
 export default Browse;
@@ -28,7 +29,7 @@ export interface BrowseParameters {
   preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
   qsParam?: Record<string, any>;
 }
 
@@ -122,6 +123,7 @@ export interface BrowseResultData extends Record<string, any> {
   is_slotted: false;
   labels: Record<string, any>;
   variations: Record<string, any>[];
+  variations_map: Record<string, any> | Record<string, any>[];
 }
 
 export interface BrowseRequestType extends Record<string, any> {

package/src/types/index.d.ts

@@ -145,6 +145,20 @@ export interface Variation extends Record<string, any> {
   data?: ItemData;
 }
 
+export interface VariationsMap {
+  group_by: Array<{
+    name: string,
+    field: string
+  }>;
+  values: {
+    [key: string]: {
+        aggregation: 'first' | 'min' | 'max' | 'all',
+        field: string
+    },
+  },
+  dtype: 'array' | 'object'
+}
+
 export interface ItemData extends Record<string, any> {
   keywords?: string[];
   url?: string;
@@ -318,3 +332,9 @@ export interface SearchabilityConfiguration {
   displayable?: boolean,
   hidden?: boolean,
 }
+
+export interface ItemTracked {
+  itemName?: string;
+  itemId?: string;
+  variationId?: string;
+}

package/src/types/recommendations.d.ts

@@ -1,4 +1,4 @@
-import { ConstructorClientOptions, NetworkParameters, UserParameters } from '.';
+import { ConstructorClientOptions, NetworkParameters, UserParameters, VariationsMap } from '.';
 
 export default Recommendations;
 
@@ -8,7 +8,7 @@ interface RecommendationsParameters {
   section?: string;
   term?: string;
   filters?: Record<string, any>;
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
 }
 
 declare class Recommendations {

package/src/types/search.d.ts

@@ -11,6 +11,7 @@ import {
   ResultSources,
   SortOption,
   UserParameters,
+  VariationsMap,
 } from '.';
 
 export default Search;
@@ -27,7 +28,7 @@ export interface SearchParameters {
   preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
   qsParam?: Record<string, any>;
 }
 
@@ -94,6 +95,7 @@ export interface SearchResultType extends Record<string, any> {
   is_slotted: false;
   labels: Record<string, any>;
   variations: Record<string, any>[];
+  variations_map: Record<string, any> | Record<string, any>[];
 }
 
 export interface Redirect extends Record<string, any> {

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,6 @@ declare class Tracker {
       url: string;
       podId: string;
       numResultsViewed: number;
-      items?: object[];
       resultCount?: number;
       resultPage?: number;
       resultId?: string;
@@ -165,7 +164,7 @@ declare class Tracker {
       selectedFilters?: object;
       sortOrder?: string;
       sortBy?: string;
-      items?: object[];
+      items: ItemTracked[];
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters