@constructor-io/constructorio-node 3.8.9 → 3.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "3.8.9",
+  "version": "3.10.1",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "scripts": {

package/src/modules/autocomplete.js

@@ -47,7 +47,7 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
   }
 
   if (parameters) {
-    const { numResults, resultsPerSection, filters, hiddenFields } = parameters;
+    const { numResults, resultsPerSection, filters, hiddenFields, variationsMap } = parameters;
 
     // Pull results number from parameters
     if (numResults) {
@@ -74,14 +74,20 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
         queryParams.fmt_options = { hidden_fields: hiddenFields };
       }
     }
+
+    // Pull variations map from parameters
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
+    }
   }
 
   queryParams._dt = Date.now();
   queryParams = helpers.cleanParams(queryParams);
 
   const queryString = qs.stringify(queryParams, { indices: false });
+  const cleanedQuery = query.replace(/^\//, '|'); // For compatibility with backend API
 
-  return `${serviceUrl}/autocomplete/${encodeURIComponent(query)}?${queryString}`;
+  return `${serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(cleanedQuery))}?${queryString}`;
 }
 
 /**
@@ -106,6 +112,7 @@ class Autocomplete {
    * @param {object} [parameters.filters] - Filters used to refine search
    * @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} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results

package/src/modules/browse.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable object-curly-newline, no-underscore-dangle, max-params */
 const qs = require('qs');
 const nodeFetch = require('node-fetch').default;
@@ -26,6 +27,7 @@ function createQueryParams(parameters, userParameters, options) {
   if (parameters) {
     const {
       page,
+      offset,
       resultsPerPage,
       filters,
       sortBy,
@@ -34,6 +36,7 @@ function createQueryParams(parameters, userParameters, options) {
       fmtOptions,
       hiddenFields,
       hiddenFacets,
+      variationsMap,
     } = parameters;
 
     // Pull page from parameters
@@ -41,6 +44,11 @@ function createQueryParams(parameters, userParameters, options) {
       queryParams.page = page;
     }
 
+    // Pull offset from parameters
+    if (!helpers.isNil(offset)) {
+      queryParams.offset = offset;
+    }
+
     // Pull results per page from parameters
     if (!helpers.isNil(resultsPerPage)) {
       queryParams.num_results_per_page = resultsPerPage;
@@ -87,6 +95,11 @@ function createQueryParams(parameters, userParameters, options) {
         queryParams.fmt_options = { hidden_facets: hiddenFacets };
       }
     }
+
+    // Pull variations map from parameters
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
+    }
   }
 
   // Pull test cells from options
@@ -129,7 +142,7 @@ function createBrowseUrlFromFilter(filterName, filterValue, parameters, userPara
   const queryParams = createQueryParams(parameters, userParameters, options);
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/browse/${encodeURIComponent(filterName)}/${encodeURIComponent(filterValue)}?${queryString}`;
+  return `${serviceUrl}/browse/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterName))}/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(filterValue))}?${queryString}`;
 }
 
 // Create URL from supplied IDs and parameters
@@ -170,11 +183,13 @@ function createBrowseUrlForFacetOptions(facetName, parameters, userParameters, o
 
   const queryParams = { ...createQueryParams(parameters, userParameters, options) };
 
+  queryParams.facet_name = facetName;
+
   delete queryParams._dt;
 
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/browse/facet_options?facet_name=${facetName}&${queryString}`;
+  return `${serviceUrl}/browse/facet_options?${queryString}`;
 }
 
 // Create request headers using supplied options and user parameters
@@ -218,7 +233,8 @@ class Browse {
    * @param {string} filterName - Filter name to display results from
    * @param {string} filterValue - Filter value to display results from
    * @param {object} [parameters] - Additional parameters to refine result set
-   * @param {number} [parameters.page] - The page number of the results
+   * @param {number} [parameters.page] - The page number of the results. Can't be used together with 'offset'
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning. Can't be used together with 'page'
    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
    * @param {object} [parameters.filters] - Filters used to refine results
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
@@ -227,6 +243,7 @@ class Browse {
    * @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 facet 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} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -301,7 +318,8 @@ class Browse {
    * @function getBrowseResultsForItemIds
    * @param {string[]} itemIds - Item IDs of results to fetch
    * @param {object} [parameters] - Additional parameters to refine result set
-   * @param {number} [parameters.page] - The page number of the results
+   * @param {number} [parameters.page] - The page number of the results. Can't be used together with 'offset'
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning. Can't be used together with 'page'
    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
    * @param {object} [parameters.filters] - Filters used to refine results
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
@@ -310,6 +328,7 @@ class Browse {
    * @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 facet 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} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -435,7 +454,8 @@ class Browse {
    *
    * @function getBrowseFacets
    * @param {object} [parameters] - Additional parameters to refine result set
-   * @param {number} [parameters.page] - The page number of the results
+   * @param {number} [parameters.page] - The page number of the results. Can't be used together with 'offset'
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning. Can't be used together with 'page'
    * @param {string} [parameters.section='Products'] - The section name for results
    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups

package/src/modules/recommendations.js

@@ -39,7 +39,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
   }
 
   if (parameters) {
-    const { numResults, itemIds, section, term, filters } = parameters;
+    const { numResults, itemIds, section, term, filters, variationsMap } = parameters;
 
     // Pull num results number from parameters
     if (!helpers.isNil(numResults)) {
@@ -65,13 +65,18 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     if (filters) {
       queryParams.filters = filters;
     }
+
+    // Pull variations map from parameters
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
+    }
   }
 
   queryParams = helpers.cleanParams(queryParams);
 
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/recommendations/v1/pods/${podId}?${queryString}`;
+  return `${serviceUrl}/recommendations/v1/pods/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(podId))}?${queryString}`;
 }
 
 /**
@@ -97,6 +102,7 @@ class Recommendations {
    * @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] - 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} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results

package/src/modules/search.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 const qs = require('qs');
 const nodeFetch = require('node-fetch').default;
@@ -5,6 +6,7 @@ const { AbortController } = require('node-abort-controller');
 const helpers = require('../utils/helpers');
 
 // Create URL from supplied query (term) and parameters
+// eslint-disable-next-line complexity
 function createSearchUrl(query, parameters, userParameters, options) {
   const {
     apiKey,
@@ -49,6 +51,7 @@ function createSearchUrl(query, parameters, userParameters, options) {
   if (parameters) {
     const {
       page,
+      offset,
       resultsPerPage,
       filters,
       sortBy,
@@ -57,6 +60,7 @@ function createSearchUrl(query, parameters, userParameters, options) {
       fmtOptions,
       hiddenFields,
       hiddenFacets,
+      variationsMap,
     } = parameters;
 
     // Pull page from parameters
@@ -64,6 +68,11 @@ function createSearchUrl(query, parameters, userParameters, options) {
       queryParams.page = page;
     }
 
+    // Pull offset from parameters
+    if (!helpers.isNil(offset)) {
+      queryParams.offset = offset;
+    }
+
     // Pull results per page from parameters
     if (!helpers.isNil(resultsPerPage)) {
       queryParams.num_results_per_page = resultsPerPage;
@@ -111,6 +120,11 @@ function createSearchUrl(query, parameters, userParameters, options) {
         queryParams.fmt_options = { hidden_facets: hiddenFacets };
       }
     }
+
+    // Pull variations map from parameters
+    if (variationsMap) {
+      queryParams.variations_map = JSON.stringify(variationsMap);
+    }
   }
 
   queryParams._dt = Date.now();
@@ -118,7 +132,7 @@ function createSearchUrl(query, parameters, userParameters, options) {
 
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/search/${encodeURIComponent(query)}?${queryString}`;
+  return `${serviceUrl}/search/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query))}?${queryString}`;
 }
 
 /**
@@ -139,7 +153,8 @@ class Search {
    * @function getSearchResults
    * @param {string} query - Term to use to perform a search
    * @param {object} [parameters] - Additional parameters to refine result set
-   * @param {number} [parameters.page] - The page number of the results
+   * @param {number} [parameters.page] - The page number of the results. Can't be used together with 'offset'
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning. Can't be used together with 'page'
    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
    * @param {object} [parameters.filters] - Filters used to refine search
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
@@ -148,6 +163,7 @@ class Search {
    * @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 facet 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} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results

package/src/modules/tracker.js

@@ -385,7 +385,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.ourEncodeURIComponent(term)}/select?`;
+        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term))}/select?`;
         const queryParams = {};
         const {
           original_query,
@@ -479,7 +479,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.ourEncodeURIComponent(term)}/search?`;
+        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term))}/search?`;
         const queryParams = {};
         const { original_query, group_id, display_name } = parameters;
 
@@ -641,7 +641,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.ourEncodeURIComponent(term)}/click_through?`;
+        const url = `${this.options.serviceUrl}/autocomplete/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(term))}/click_through?`;
         const queryParams = {};
         const { item_name, name, item_id, customer_id, variation_id, result_id } = parameters;
 
@@ -740,7 +740,7 @@ class Tracker {
   trackConversion(term, parameters, userParameters, networkParameters = {}) {
     // Ensure parameters are provided (required)
     if (parameters && typeof parameters === 'object' && !Array.isArray(parameters)) {
-      const searchTerm = helpers.ourEncodeURIComponent(term) || 'TERM_UNKNOWN';
+      const searchTerm = term || 'TERM_UNKNOWN';
       const requestPath = `${this.options.serviceUrl}/v2/behavioral_action/conversion?`;
       const queryParams = {};
       const bodyParams = {};

package/src/utils/helpers.js

@@ -1,22 +1,9 @@
 /* eslint-disable no-param-reassign */
-const qs = require('qs');
-
 const utils = {
-  ourEncodeURIComponent: (str) => {
-    if (str && typeof str === 'string') {
-      const cleanedString = str
-        .replace(/\[/g, '%5B') // Replace [
-        .replace(/\]/g, '%5D') // Replace ]
-        .replace(/&/g, '%26'); // Replace &
-      const trimmedCleanedString = cleanedString.trim();
-      const parsedStrObj = qs.parse(`s=${trimmedCleanedString}`);
-
-      parsedStrObj.s = parsedStrObj.s.replace(/\s/g, ' ');
+  trimNonBreakingSpaces: (string) => string.replace(/\s/g, ' ').trim(),
 
-      return qs.stringify(parsedStrObj).split('=')[1];
-    }
-    return null;
-  },
+  // 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()}`),
 
   cleanParams: (paramsObj) => {
     const cleanedParams = {};
@@ -27,7 +14,7 @@ const utils = {
       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] = decodeURIComponent(utils.ourEncodeURIComponent(paramValue));
+        cleanedParams[paramKey] = utils.trimNonBreakingSpaces(paramValue);
       } else {
         cleanedParams[paramKey] = paramValue;
       }