@constructor-io/constructorio-node 4.10.1 → 4.11.1

package/package.json

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

package/src/modules/autocomplete.js

@@ -53,6 +53,7 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
       filtersPerSection,
       hiddenFields,
       variationsMap,
+      preFilterExpression,
       resultsPerPagePerSection,
       pagePerSection,
     } = parameters;
@@ -104,6 +105,11 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
     }
+
+    // Pull filter expression from parameters
+    if (preFilterExpression) {
+      queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
+    }
   }
 
   queryParams._dt = Date.now();
@@ -142,6 +148,7 @@ class Autocomplete {
    * @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} [parameters.preFilterExpression] - Faceting expression to scope autocomplete results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
    * @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/modules/browse.js

@@ -153,7 +153,7 @@ function createBrowseUrlFromFilter(filterName, filterValue, parameters, userPara
   const queryParams = createQueryParams(parameters, userParameters, options);
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/browse/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterName))}/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterValue))}?${queryString}`;
+  return `${serviceUrl}/browse/${helpers.encodeURIComponentRFC3986(helpers.normalizeSpaces(filterName).trim())}/${helpers.encodeURIComponentRFC3986(helpers.normalizeSpaces(filterValue).trim())}?${queryString}`;
 }
 
 // Create URL from supplied IDs and parameters

package/src/modules/recommendations.js

@@ -84,7 +84,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
 
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/recommendations/v1/pods/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(podId))}?${queryString}`;
+  return `${serviceUrl}/recommendations/v1/pods/${helpers.encodeURIComponentRFC3986(helpers.normalizeSpaces(podId).trim())}?${queryString}`;
 }
 
 /**

package/src/modules/tracker.js

@@ -418,7 +418,7 @@ class Tracker {
     if (term && typeof term === 'string') {
       // Ensure parameters are provided (required)
       if (parameters && typeof parameters === 'object' && !Array.isArray(parameters)) {
-        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term))}/select?`;
+        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.normalizeSpaces(term))}/select?`;
         const queryParams = {};
         const {
           original_query,
@@ -516,7 +516,7 @@ class Tracker {
     if (term && typeof term === 'string') {
       // Ensure parameters are provided (required)
       if (parameters && typeof parameters === 'object' && !Array.isArray(parameters)) {
-        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term))}/search?`;
+        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.normalizeSpaces(term))}/search?`;
         const queryParams = {};
         const {
           original_query,
@@ -700,7 +700,7 @@ class Tracker {
     if (term && typeof term === 'string') {
       // Ensure parameters are provided (required)
       if (parameters && typeof parameters === 'object' && !Array.isArray(parameters)) {
-        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term))}/click_through?`;
+        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.normalizeSpaces(term))}/click_through?`;
         const queryParams = {};
         const {
           item_name,

package/src/types/autocomplete.d.ts

@@ -18,6 +18,7 @@ export interface AutocompleteParameters {
   resultsPerPagePerSection?: Record<string, number>;
   hiddenFields?: string[];
   variationsMap?: VariationsMap;
+  preFilterExpression?: FilterExpression;
 }
 
 declare class Autocomplete {
@@ -47,6 +48,8 @@ export interface AutocompleteRequestType extends Record<string, any> {
   features: Partial<RequestFeature>;
   feature_variants: Partial<RequestFeatureVariant>;
   searchandized_items: Record<string, any>;
+  variations_map?: VariationsMap;
+  pre_filter_expression?: FilterExpression;
 }
 
 export type Section = Partial<SectionItem>[];

package/src/types/browse.d.ts

@@ -142,4 +142,6 @@ export interface BrowseRequestType extends Record<string, any> {
   features: Partial<RequestFeature>;
   feature_variants: Partial<RequestFeatureVariant>;
   searchandized_items: Record<string, any>;
+  variations_map?: VariationsMap;
+  pre_filter_expression?: FilterExpression;
 }

package/src/types/search.d.ts

@@ -83,6 +83,8 @@ export interface SearchRequestType extends Record<string, any> {
   features: Partial<RequestFeature>;
   feature_variants: Partial<RequestFeatureVariant>;
   searchandized_items: Record<string, any>;
+  variations_map?: VariationsMap;
+  pre_filter_expression?: FilterExpression;
 }
 
 export interface SearchResultType extends Record<string, any> {

package/src/utils/helpers.js

@@ -7,7 +7,9 @@ const PII_REGEX = {
 };
 
 const utils = {
-  trimNonBreakingSpaces: (string) => string.replace(/\s/g, ' ').trim(),
+  // Replace non-breaking spaces (or any other type of spaces caught by the regex)
+  // - with a regular white space
+  normalizeSpaces: (string) => string.replace(/\s/g, ' '),
 
   // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
   encodeURIComponentRFC3986: (string) => encodeURIComponent(string).replace(/[!'()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`),
@@ -16,12 +18,15 @@ const utils = {
     const cleanedParams = {};
 
     Object.keys(paramsObj).forEach((paramKey) => {
+      const excludeTrimList = ['term', 'original_query', 'search_term'];
       const paramValue = paramsObj[paramKey];
 
       if (typeof paramValue === 'string') {
-        // Replace non-breaking spaces (or any other type of spaces caught by the regex)
-        // - with a regular white space
-        cleanedParams[paramKey] = utils.trimNonBreakingSpaces(paramValue);
+        cleanedParams[paramKey] = utils.normalizeSpaces(paramValue);
+
+        if (!excludeTrimList.includes(paramKey)) {
+          cleanedParams[paramKey] = cleanedParams[paramKey].trim();
+        }
       } else {
         cleanedParams[paramKey] = paramValue;
       }