@constructor-io/constructorio-client-javascript 2.28.0 → 2.29.0

package/lib/modules/autocomplete.js

@@ -64,7 +64,8 @@ function createAutocompleteUrl(query, parameters, options) {
     var numResults = parameters.numResults,
         resultsPerSection = parameters.resultsPerSection,
         filters = parameters.filters,
-        hiddenFields = parameters.hiddenFields; // Pull results number from parameters
+        hiddenFields = parameters.hiddenFields,
+        variationsMap = parameters.variationsMap; // Pull results number from parameters
 
     if (numResults) {
       queryParams.num_results = numResults;
@@ -91,6 +92,11 @@ function createAutocompleteUrl(query, parameters, options) {
           hidden_fields: hiddenFields
         };
       }
+    } // Pull variations map from parameters
+
+
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
     }
   }
 
@@ -129,6 +135,7 @@ var Autocomplete = /*#__PURE__*/function () {
    * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
    * @param {object} [parameters.resultsPerSection] - Number of results to return (value) per section (key)
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
+   * @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 {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/lib/modules/browse.js

@@ -66,7 +66,8 @@ function createQueryParams(parameters, options) {
         section = parameters.section,
         fmtOptions = parameters.fmtOptions,
         hiddenFields = parameters.hiddenFields,
-        hiddenFacets = parameters.hiddenFacets; // Pull page from parameters
+        hiddenFacets = parameters.hiddenFacets,
+        variationsMap = parameters.variationsMap; // Pull page from parameters
 
     if (!helpers.isNil(page)) {
       queryParams.page = page;
@@ -121,6 +122,11 @@ function createQueryParams(parameters, options) {
           hidden_facets: hiddenFacets
         };
       }
+    } // Pull variations map from parameters
+
+
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
     }
   }
 
@@ -231,6 +237,7 @@ var Browse = /*#__PURE__*/function () {
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
+   * @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 {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -311,6 +318,7 @@ var Browse = /*#__PURE__*/function () {
      * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
      * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
      * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
+     * @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 {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}

package/lib/modules/recommendations.js

@@ -52,7 +52,8 @@ function createRecommendationsUrl(podId, parameters, options) {
         itemIds = parameters.itemIds,
         section = parameters.section,
         term = parameters.term,
-        filters = parameters.filters; // Pull num results number from parameters
+        filters = parameters.filters,
+        variationsMap = parameters.variationsMap; // Pull num results number from parameters
 
     if (!helpers.isNil(numResults)) {
       queryParams.num_results = numResults;
@@ -76,6 +77,11 @@ function createRecommendationsUrl(podId, parameters, options) {
 
     if (filters) {
       queryParams.filters = filters;
+    } // Pull variations map from parameters
+
+
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
     }
   }
 
@@ -112,6 +118,7 @@ var Recommendations = /*#__PURE__*/function () {
    * @param {string} [parameters.section] - The section to return results from
    * @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 (strategy specific)
+   * @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 {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/lib/modules/search.js

@@ -66,7 +66,8 @@ function createSearchUrl(query, parameters, options) {
         section = parameters.section,
         fmtOptions = parameters.fmtOptions,
         hiddenFields = parameters.hiddenFields,
-        hiddenFacets = parameters.hiddenFacets; // Pull page from parameters
+        hiddenFacets = parameters.hiddenFacets,
+        variationsMap = parameters.variationsMap; // Pull page from parameters
 
     if (!helpers.isNil(page)) {
       queryParams.page = page;
@@ -122,6 +123,11 @@ function createSearchUrl(query, parameters, options) {
           hidden_facets: hiddenFacets
         };
       }
+    } // Pull variations map from parameters
+
+
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
     }
   }
 
@@ -163,6 +169,7 @@ var Search = /*#__PURE__*/function () {
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
+   * @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 {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {