@constructor-io/constructorio-client-javascript 2.35.11 → 2.35.13

package/lib/types/autocomplete.d.ts

@@ -4,6 +4,7 @@ import {
   NetworkParameters,
   RequestFeature,
   RequestFeatureVariant,
+  VariationsMap,
 } from '.';
 import EventDispatcher from './event-dispatcher';
 
@@ -14,7 +15,7 @@ export interface IAutocompleteParameters {
   filters?: Record<string, any>;
   resultsPerSection?: Record<string, number>;
   hiddenFields?: string[];
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
 }
 
 declare class Autocomplete {

package/lib/types/browse.d.ts

@@ -11,6 +11,7 @@ import {
   RequestFeatureVariant,
   ResultSources,
   SortOption,
+  VariationsMap,
 } from '.';
 import EventDispatcher from './event-dispatcher';
 
@@ -28,7 +29,7 @@ export interface IBrowseParameters {
   preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
   qsParam?: Record<string, any>;
 }
 
@@ -121,6 +122,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/lib/types/index.d.ts

@@ -204,3 +204,17 @@ export interface SearchSuggestion extends Item {
     total_num_results?: number
   } & ItemData;
 }
+
+export interface VariationsMap {
+  group_by: Array<{
+    name: string,
+    field: string
+  }>;
+  values: {
+    [key: string]: {
+        aggregation: 'first' | 'min' | 'max' | 'all',
+        field: string
+    },
+  },
+  dtype: 'array' | 'object'
+}

package/lib/types/quizzes.d.ts

@@ -114,7 +114,7 @@ export interface SelectQuestion extends BaseQuestion {
 
 export interface OpenQuestion extends BaseQuestion {
   type: 'open'
-  inputPlaceholder?: Nullable<string>;
+  input_placeholder?: Nullable<string>;
 }
 
 export interface CoverQuestion extends BaseQuestion {

package/lib/types/recommendations.d.ts

@@ -1,4 +1,4 @@
-import { ConstructorClientOptions, NetworkParameters } from '.';
+import { ConstructorClientOptions, NetworkParameters, VariationsMap } from '.';
 import EventDispatcher from './event-dispatcher';
 
 export default Recommendations;
@@ -9,7 +9,7 @@ export interface RecommendationsParameters {
   section?: string;
   term?: string;
   filters?: Record<string, any>;
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
   hiddenFields?: string[];
 }
 

package/lib/types/search.d.ts

@@ -10,6 +10,7 @@ import {
   RequestFeatureVariant,
   ResultSources,
   SortOption,
+  VariationsMap,
 } from '.';
 import EventDispatcher from './event-dispatcher';
 
@@ -27,7 +28,7 @@ export interface SearchParameters {
   preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
-  variationsMap?: Record<string, any>;
+  variationsMap?: VariationsMap;
   qsParam?: Record<string, any>;
 }
 declare class Search {
@@ -95,6 +96,7 @@ export interface Result 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/lib/types/tracker.d.ts

@@ -19,9 +19,9 @@ declare class Tracker {
 
   trackItemDetailLoad(
     parameters: {
-      item_name: string;
-      item_id: string;
-      variation_id?: string;
+      itemName: string;
+      itemId: string;
+      variationId?: string;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -29,11 +29,11 @@ declare class Tracker {
   trackAutocompleteSelect(
     term: string,
     parameters: {
-      original_query: string;
+      originalQuery: string;
       section: string;
       tr?: string;
-      group_id?: string;
-      display_name?: string;
+      groupId?: string;
+      displayName?: string;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -41,9 +41,9 @@ declare class Tracker {
   trackSearchSubmit(
     term: string,
     parameters: {
-      original_query: string;
-      group_id?: string;
-      display_name?: string;
+      originalQuery: string;
+      groupId?: string;
+      displayName?: string;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -51,8 +51,8 @@ declare class Tracker {
   trackSearchResultsLoaded(
     term: string,
     parameters: {
-      num_results: number;
-      item_ids?: string[];
+      numResults: number;
+      itemIds?: string[];
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -60,11 +60,11 @@ declare class Tracker {
   trackSearchResultClick(
     term: string,
     parameters: {
-      item_name: string;
-      item_id: string;
-      variation_id?: string;
-      result_id?: string;
-      item_is_convertible?: string;
+      itemName: string;
+      itemId: string;
+      variationId?: string;
+      resultId?: string;
+      itemIsConvertible?: string;
       section?: string;
     },
     networkParameters?: NetworkParameters
@@ -73,14 +73,14 @@ declare class Tracker {
   trackConversion(
     term?: string,
     parameters: {
-      item_id: string;
+      itemId: string;
       revenue?: number;
-      item_name?: string;
-      variation_id?: string;
+      itemName?: string;
+      variationId?: string;
       type?: string;
-      is_custom_type?: boolean;
-      display_name?: string;
-      result_id?: string;
+      isCustomType?: boolean;
+      displayName?: string;
+      resultId?: string;
       section?: string;
     },
     networkParameters?: NetworkParameters
@@ -90,7 +90,7 @@ declare class Tracker {
     parameters: {
       items: object[];
       revenue: number;
-      order_id?: string;
+      orderId?: string;
       section?: string;
     },
     networkParameters?: NetworkParameters
@@ -99,12 +99,12 @@ declare class Tracker {
   trackRecommendationView(
     parameters: {
       url: string;
-      pod_id: string;
-      num_results_viewed: number;
+      podId: string;
+      numResultsViewed: number;
       items?: object[];
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
       section?: string;
     },
     networkParameters?: NetworkParameters
@@ -112,17 +112,17 @@ declare class Tracker {
 
   trackRecommendationClick(
     parameters: {
-      pod_id: string;
-      strategy_id: string;
-      item_id: string;
-      item_name: string;
-      variation_id?: string;
+      podId: string;
+      strategyId: string;
+      itemId: string;
+      itemName: string;
+      variationId?: string;
       section?: string;
-      result_id?: string;
-      result_count?: number;
-      result_page?: number;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
+      resultId?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
@@ -130,15 +130,15 @@ declare class Tracker {
   trackBrowseResultsLoaded(
     parameters: {
       url: string;
-      filter_name: string;
-      filter_value: string;
+      filterName: string;
+      filterValue: string;
       section?: string;
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
-      selected_filters?: object;
-      sort_order?: string;
-      sort_by?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
+      selectedFilters?: object;
+      sortOrder?: string;
+      sortBy?: string;
       items?: object[];
     },
     networkParameters?: NetworkParameters
@@ -146,26 +146,26 @@ declare class Tracker {
 
   trackBrowseResultClick(
     parameters: {
-      filter_name: string;
-      filter_value: string;
-      item_id: string;
+      filterName: string;
+      filterValue: string;
+      itemId: string;
       section?: string;
-      variation_id?: string;
-      result_id?: string;
-      result_count?: number;
-      result_page?: number;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
-      selected_filters?: object;
+      variationId?: string;
+      resultId?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
+      selectedFilters?: object;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
 
   trackGenericResultClick(
     parameters: {
-      item_id: string;
-      item_name?: string;
-      variation_id?: string;
+      itemId: string;
+      itemName?: string;
+      variationId?: string;
       section?: string;
     },
     networkParameters?: NetworkParameters
@@ -173,48 +173,48 @@ declare class Tracker {
 
   trackQuizResultsLoaded(
     parameters: {
-      quiz_id: string;
-      quiz_version_id: string;
-      quiz_session_id: string;
+      quizId: string;
+      quizVersionId: string;
+      quizSessionId: string;
       url: string;
       section?: string;
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
 
   trackQuizResultClick(
     parameters: {
-      quiz_id: string;
-      quiz_version_id: string;
-      quiz_session_id: string;
-      item_id?: string;
-      item_name?: string;
+      quizId: string;
+      quizVersionId: string;
+      quizSessionId: string;
+      itemId?: string;
+      itemName?: string;
       section?: string;
-      result_count?: number;
-      result_page?: number;
-      result_id?: string;
-      result_position_on_page?: number;
-      num_results_per_page?: number;
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
+      resultPositionOnPage?: number;
+      numResultsPerPage?: number;
     },
     networkParameters?: NetworkParameters
   ): true | Error;
 
   trackQuizConversion(
     parameters: {
-      quiz_id: string;
-      quiz_version_id: string;
-      quiz_session_id: string;
-      item_id?: string;
-      item_name?: string;
+      quizId: string;
+      quizVersionId: string;
+      quizSessionId: string;
+      itemId?: string;
+      itemName?: string;
       section?: string;
-      variation_id?: string;
+      variationId?: string;
       revenue?: string;
       type?: string;
-      is_custom_type?: boolean;
-      display_name?: string;
+      isCustomType?: boolean;
+      displayName?: string;
     },
     networkParameters?: NetworkParameters
   ): true | Error;

package/lib/utils/helpers.js

@@ -183,6 +183,20 @@ var utils = {
       }
     });
     return allValues.join('&');
+  },
+  toSnakeCase: function toSnakeCase(camelCasedStr) {
+    return camelCasedStr.replace(/[A-Z]/g, function (prefix) {
+      return "_".concat(prefix.toLowerCase());
+    });
+  },
+  toSnakeCaseKeys: function toSnakeCaseKeys(camelCasedObj) {
+    var toRecurse = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    var snakeCasedObj = {};
+    Object.keys(camelCasedObj).forEach(function (key) {
+      var newKey = utils.toSnakeCase(key);
+      snakeCasedObj[newKey] = toRecurse && (0, _typeof2["default"])(camelCasedObj[key]) === 'object' && !Array.isArray(camelCasedObj[key]) ? utils.toSnakeCaseKeys(camelCasedObj[key], toRecurse) : camelCasedObj[key];
+    });
+    return snakeCasedObj;
   }
 };
 module.exports = utils;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.35.11",
+  "version": "2.35.13",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/constructorio.d.ts",