@constructor-io/constructorio-node 4.11.0 → 4.12.0

package/package.json

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

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

@@ -16,6 +16,7 @@ function applyParams(parameters, userParameters, options) {
     segments,
     testCells,
     originReferrer,
+    dateTime,
   } = userParameters || {};
   let aggregateParams = Object.assign(parameters);
 
@@ -63,7 +64,7 @@ function applyParams(parameters, userParameters, options) {
     aggregateParams.origin_referrer = originReferrer;
   }
 
-  aggregateParams._dt = Date.now();
+  aggregateParams._dt = dateTime || Date.now();
   aggregateParams.beacon = true;
   aggregateParams = helpers.cleanParams(aggregateParams);
 
@@ -202,6 +203,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -242,6 +244,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -290,6 +293,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -390,6 +394,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -418,7 +423,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,
@@ -490,6 +495,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -516,7 +522,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,
@@ -576,6 +582,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -674,6 +681,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -700,7 +708,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,
@@ -789,6 +797,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -923,6 +932,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -1025,6 +1035,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -1156,6 +1167,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -1309,6 +1321,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -1461,6 +1474,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -1608,6 +1622,7 @@ class Tracker {
    * @param {string} [userParameters.userIp] - Client user IP
    * @param {string} [userParameters.userAgent] - Client user agent
    * @param {string} [userParameters.acceptLanguage] - Client accept language
+   * @param {string} [userParameters.dateTime] - Time since epoch in milliseconds
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}

package/src/types/tracker.d.ts

@@ -14,6 +14,7 @@ export interface TrackerUserParameters {
   userIp?: string;
   userAgent?: string;
   acceptLanguage?: string;
+  dateTime?: number;
 }
 
 declare class Tracker {

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;
       }