@constructor-io/constructorio-node 4.7.4 → 4.8.0

package/package.json

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

package/src/modules/autocomplete.js

@@ -46,13 +46,32 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
   }
 
   if (parameters) {
-    const { numResults, resultsPerSection, filters, hiddenFields, variationsMap } = parameters;
+    const {
+      numResults,
+      resultsPerSection,
+      filters,
+      filtersPerSection,
+      hiddenFields,
+      variationsMap,
+      resultsPerPagePerSection,
+      pagePerSection,
+    } = parameters;
 
     // Pull results number from parameters
     if (numResults) {
       queryParams.num_results = numResults;
     }
 
+    // Pull page per section from parameters
+    if (pagePerSection) {
+      queryParams.page_per_section = pagePerSection;
+    }
+
+    // Pull results number per page per section from parameters
+    if (resultsPerPagePerSection) {
+      queryParams.num_section_results_per_page = resultsPerPagePerSection;
+    }
+
     // Pull results number per section from parameters
     if (resultsPerSection) {
       Object.keys(resultsPerSection).forEach((section) => {
@@ -65,6 +84,13 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
       queryParams.filters = filters;
     }
 
+    // Pull filtersPerSection from parameters
+    if (filtersPerSection) {
+      Object.keys(filtersPerSection).forEach((section) => {
+        queryParams[`filters[${section}]`] = filtersPerSection[section];
+      });
+    }
+
     // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
@@ -108,7 +134,10 @@ class Autocomplete {
    * @param {string} query - Term to use to perform an autocomplete search
    * @param {object} [parameters] - Additional parameters to refine result set
    * @param {number} [parameters.numResults] - The total number of results to return
+   * @param {object} [parameters.pagePerSection] - The page number of the results per section
+   * @param {object} [parameters.resultsPerPagePerSection] - The number of results per page to return per section
    * @param {object} [parameters.filters] - Filters used to refine search
+   * @param {object} [parameters.filtersPerSection] - Filters used to refine search per section
    * @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

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/types/autocomplete.d.ts

@@ -12,7 +12,10 @@ export default Autocomplete;
 export interface AutocompleteParameters {
   numResults?: number;
   filters?: Record<string, any>;
+  filtersPerSection?: Record<string, Record<string, any>>;
   resultsPerSection?: Record<string, number>;
+  pagePerSection?: Record<string, number>;
+  resultsPerPagePerSection?: Record<string, number>;
   hiddenFields?: string[];
   variationsMap?: VariationsMap;
 }

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 {