@constructor-io/constructorio-node 3.5.4 → 3.7.0

package/README.md

@@ -3,19 +3,26 @@
 [![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-node)](https://www.npmjs.com/package/@constructor-io/constructorio-node)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-node/blob/master/LICENSE)
 [![Minzipped Size](https://img.shields.io/bundlephobia/minzip/@constructor-io/constructorio-node)](https://bundlephobia.com/result?p=@constructor-io/constructorio-node)
-[![Dependencies](https://img.shields.io/david/Constructor-io/constructorio-node)](https://david-dm.org/constructor-io/constructorio-node)
 
 A Node.js client for [Constructor.io](http://constructor.io/). [Constructor.io](http://constructor.io/) provides search as a service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for conversions, and user personalization).
 
-## 1. Install
+> This client is intended for use in server side integrations.  If you want a JavaScript client for client side (i.e. front end) integrations please use [@constructor-io/constructorio-client-javascript](https://github.com/Constructor-io/constructorio-client-javascript)
+
+## 1. Review the Requirements
+
+Requesting results from your Node.js back-end can be useful in order to control result rendering logic on your server, or augment/hydrate results with data from another system. However, a back-end integration has additional requirements compared to a front-end integration.  Please review [Back End API Integration](https://constructorio.zendesk.com/hc/en-us/articles/360047993194-Back-end-API-Integration) for more detail.
+
+## 2. Install
 
 This package can be installed via npm: `npm i @constructor-io/constructorio-node`. Once installed, simply import or require the package into your repository.
 
-## 2. Retrieve an API key and token
+**Important**: this library should only be used in a server-side context.
+
+## 3. Retrieve an API key and token
 
 You can find this in your [Constructor.io dashboard](https://constructor.io/dashboard). Contact sales if you'd like to sign up, or support if you believe your company already has an account.
 
-## 3. Implement the Client
+## 4. Implement the Client
 
 Once imported, an instance of the client can be created as follows:
 
@@ -27,7 +34,7 @@ var constructorio = new ConstructorIOClient({
 });
 ```
 
-## 4. Retrieve Results
+## 5. Retrieve Results
 
 After instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: `search`, `browse`, `autocomplete`, `recommendations`, `catalog` and `tracker`.
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "3.5.4",
+  "version": "3.7.0",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "scripts": {
     "version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh && npm run docs && git add ./docs/*",
     "check-lisc": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT'",
     "lint": "chmod 766 .git/hooks/pre-push && eslint 'src/**/*.js' 'spec/**/*.js'",
-    "test": "mkdir -p test && cp -rf src/* test && mocha ./spec/* --opts ./mocha.opts --recursive",
+    "test": "mkdir -p test && cp -rf src/* test && mocha ./spec/*",
     "precoverage": "rm -rf ./coverage && rm -rf ./.nyc_output",
     "coverage": "nyc --all --reporter=html npm run test",
     "postcoverage": "serve --listen 8080 --config ./serve.json && rm -rf test",
@@ -36,19 +36,19 @@
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "dotenv": "^8.6.0",
-    "eslint": "^5.12.1",
-    "eslint-config-airbnb-base": "^13.1.0",
+    "eslint": "^8.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.24.2",
     "jsdoc": "^3.6.7",
     "jsdom": "^15.1.1",
     "license-checker": "^25.0.1",
     "lodash.clonedeep": "^4.5.0",
     "minami": "^1.2.3",
-    "mocha": "^6.2.0",
+    "mocha": "^9.1.3",
     "mocha-jsdom": "^2.0.0",
-    "nyc": "^14.1.1",
+    "nyc": "^15.1.0",
     "pre-push": "^0.1.1",
-    "serve": "^11.3.2",
+    "serve": "^13.0.2",
     "sinon": "^7.5.0",
     "sinon-chai": "^3.7.0",
     "uuid": "^8.3.2"

package/src/constructorio.js

@@ -14,19 +14,20 @@ const { version: packageVersion } = require('../package.json');
  */
 class ConstructorIO {
   /**
-   * @param {string} apiKey - Constructor.io API key
-   * @param {string} [apiToken] - Constructor.io API token (required for catalog methods)
-   * @param {string} [securityToken] - Constructor security token
-   * @param {string} [serviceUrl='https://ac.cnstrc.com'] - API URL endpoint
-   * @param {function} [fetch] - If supplied, will be utilized for requests rather than default Fetch API
-   * @param {object} [networkParameters] - Parameters relevant to network requests
-   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds) - may be overridden within individual method calls
-   * @property {object} [search] - Interface to {@link module:search}
-   * @property {object} [browse] - Interface to {@link module:browse}
-   * @property {object} [autocomplete] - Interface to {@link module:autocomplete}
-   * @property {object} [recommendations] - Interface to {@link module:recommendations}
-   * @property {object} [tracker] - Interface to {@link module:tracker}
-   * @property {object} [catalog] - Interface to {@link module:catalog}
+   * @param {object} parameters - Parameters for client instantiation
+   * @param {string} parameters.apiKey - Constructor.io API key
+   * @param {string} [parameters.apiToken] - Constructor.io API token (required for catalog methods)
+   * @param {string} [parameters.securityToken] - Constructor security token
+   * @param {string} [parameters.serviceUrl='https://ac.cnstrc.com'] - API URL endpoint
+   * @param {function} [parameters.fetch] - If supplied, will be utilized for requests rather than default Fetch API
+   * @param {object} [parameters.networkParameters] - Parameters relevant to network requests
+   * @param {number} [parameters.networkParameters.timeout] - Request timeout (in milliseconds) - may be overridden within individual method calls
+   * @property {object} search - Interface to {@link module:search}
+   * @property {object} browse - Interface to {@link module:browse}
+   * @property {object} autocomplete - Interface to {@link module:autocomplete}
+   * @property {object} recommendations - Interface to {@link module:recommendations}
+   * @property {object} tracker - Interface to {@link module:tracker}
+   * @property {object} catalog - Interface to {@link module:catalog}
    * @returns {class}
    */
   constructor(options = {}) {
@@ -49,7 +50,7 @@ class ConstructorIO {
       apiToken: apiToken || '',
       securityToken: securityToken || '',
       version: version || global.CLIENT_VERSION || `cio-node-${packageVersion}`,
-      serviceUrl: serviceUrl || 'https://ac.cnstrc.com',
+      serviceUrl: (serviceUrl && serviceUrl.replace(/\/$/, '')) || 'https://ac.cnstrc.com',
       fetch,
       networkParameters: networkParameters || {},
     };

package/src/modules/autocomplete.js

@@ -96,6 +96,7 @@ class Autocomplete {
    * Retrieve autocomplete results from API
    *
    * @function getAutocompleteResults
+   * @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.filters] - Filters used to refine search
@@ -104,7 +105,7 @@ class Autocomplete {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client

package/src/modules/browse.js

@@ -195,7 +195,7 @@ class Browse {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
@@ -272,7 +272,7 @@ class Browse {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
@@ -336,7 +336,7 @@ class Browse {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
@@ -393,7 +393,7 @@ class Browse {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client

package/src/modules/catalog.js

@@ -517,7 +517,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -581,7 +581,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -712,7 +712,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -752,7 +752,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -795,7 +795,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -842,7 +842,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -879,7 +879,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1013,7 +1013,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1071,7 +1071,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1197,7 +1197,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1281,7 +1281,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1338,10 +1338,9 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
-
   /**
    * Remove synonym group for supplied ID
    *
@@ -1464,7 +1463,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1514,7 +1513,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1564,7 +1563,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1603,7 +1602,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1670,7 +1669,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**
@@ -1709,7 +1708,7 @@ class Catalog {
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    }).then(json => json);
+    }).then((json) => json);
   }
 
   /**

package/src/modules/recommendations.js

@@ -100,7 +100,7 @@ class Recommendations {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client

package/src/modules/search.js

@@ -54,7 +54,6 @@ function createSearchUrl(query, parameters, userParameters, options) {
       sortBy,
       sortOrder,
       section,
-      collectionId,
       fmtOptions,
       hiddenFields,
     } = parameters;
@@ -89,11 +88,6 @@ function createSearchUrl(query, parameters, userParameters, options) {
       queryParams.section = section;
     }
 
-    // Pull collection id from parameters
-    if (collectionId) {
-      queryParams.collection_id = collectionId;
-    }
-
     // Pull format options from parameters
     if (fmtOptions) {
       queryParams.fmt_options = fmtOptions;
@@ -136,12 +130,13 @@ class Search {
    * @param {object} [parameters.filters] - Filters used to refine search
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
+   * @param {string} [parameters.section='Products'] - The section name for results
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
    * @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 {number} [userParameters.clientId] - Client ID, utilized to personalize results
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client

package/src/modules/tracker.js

@@ -77,7 +77,7 @@ function applyParamsAsString(parameters, userParameters, options) {
 }
 
 // Send request to server
-function send(url, userParameters, networkParameters, method = 'GET', body) { // eslint-disable-line max-params
+function send(url, userParameters, networkParameters, method = 'GET', body = {}) { // eslint-disable-line max-params
   let request;
   const fetch = (this.options && this.options.fetch) || nodeFetch;
   const controller = new AbortController();
@@ -190,7 +190,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -229,7 +229,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -276,7 +276,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -369,7 +369,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -440,11 +440,11 @@ class Tracker {
    * @param {string} term - Search results query term
    * @param {object} parameters - Additional parameters to be sent with request
    * @param {number} parameters.num_results - Number of search results in total
-   * @param {array} [parameters.item_ids] - List of product item unique identifiers in search results listing
+   * @param {string[]} [parameters.item_ids] - List of product item unique identifiers in search results listing
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -477,6 +477,7 @@ class Tracker {
         const url = `${this.options.serviceUrl}/behavior?`;
         const queryParams = { action: 'search-results', term };
         const { num_results, customer_ids, item_ids } = parameters;
+        let customerIDs;
 
         if (!helpers.isNil(num_results)) {
           queryParams.num_results = num_results;
@@ -484,10 +485,15 @@ class Tracker {
 
         // Ensure support for both item_ids and customer_ids as parameters
         if (item_ids && Array.isArray(item_ids)) {
-          queryParams.customer_ids = item_ids.join(',');
+          customerIDs = item_ids;
         } else if (customer_ids && Array.isArray(customer_ids)) {
-          queryParams.customer_ids = customer_ids.join(',');
+          customerIDs = customer_ids;
         }
+
+        if (customerIDs && Array.isArray(customerIDs) && customerIDs.length) {
+          queryParams.customer_ids = customerIDs.slice(0, 100).join(',');
+        }
+
         const requestUrl = `${url}${applyParamsAsString(queryParams, userParameters, this.options)}`;
 
         send.call(
@@ -519,7 +525,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -598,10 +604,10 @@ class Tracker {
    * Send conversion event to API
    *
    * @function trackConversion
-   * @param {string} term - Search results query term
+   * @param {string} [term] - Search results query term that led to conversion event
    * @param {object} parameters - Additional parameters to be sent with request
    * @param {string} parameters.item_id - Product item unique identifier
-   * @param {string} parameters.revenue - Revenue (price) of product item
+   * @param {number} [parameters.revenue] - Sale price if available, otherwise the regular (retail) price of item
    * @param {string} [parameters.item_name] - Product item name
    * @param {string} [parameters.variation_id] - Product item variation unique identifier
    * @param {string} [parameters.type='add_to_cart'] - Conversion type
@@ -612,7 +618,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -624,6 +630,7 @@ class Tracker {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
    * @description User performed an action indicating interest in an item (add to cart, add to wishlist, etc.)
+   * @see https://docs.constructor.io/rest_api/behavioral_logging/conversions
    * @example
    * constructorio.tracker.trackConversion(
    *     'T-Shirt',
@@ -729,14 +736,14 @@ class Tracker {
    *
    * @function trackPurchase
    * @param {object} parameters - Additional parameters to be sent with request
-   * @param {array} parameters.items - List of product item objects
-   * @param {number} parameters.revenue - Revenue
+   * @param {object[]} parameters.items - List of product item objects
+   * @param {number} parameters.revenue - The subtotal (excluding taxes, shipping, etc.) of the entire order
    * @param {string} [parameters.order_id] - Unique order identifier
    * @param {string} [parameters.section] - Index section
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -822,7 +829,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -931,7 +938,7 @@ class Tracker {
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -1053,14 +1060,14 @@ class Tracker {
    * @param {number} [parameters.result_count] - Number of results displayed
    * @param {number} [parameters.result_page] - Page number of results
    * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
-   * @param {string} [parameters.selected_filters] -  Selected filters
+   * @param {object} [parameters.selected_filters] - Selected filters
    * @param {string} [parameters.sort_order] - Sort order ('ascending' or 'descending')
    * @param {string} [parameters.sort_by] - Sorting method
-   * @param {array} [parameters.items] - List of product item objects
+   * @param {object[]} [parameters.items] - List of product item objects
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -1078,7 +1085,7 @@ class Tracker {
    *         result_count: 22,
    *         result_page: 2,
    *         result_id: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
-   *         selected_filters: [ 'brand', 'color' ],
+   *         selected_filters: { brand: ['foo'], color: ['black'] },
    *         sort_order: 'ascending',
    *         sort_by: 'price',
    *         items: [{ item_id: 'KMH876' }, { item_id: 'KMH140' }],
@@ -1154,7 +1161,7 @@ class Tracker {
       }
 
       if (items && Array.isArray(items)) {
-        bodyParams.items = items;
+        bodyParams.items = items.slice(0, 100);
       }
 
       const requestUrl = `${requestPath}${applyParamsAsString({}, userParameters, this.options)}`;
@@ -1191,11 +1198,11 @@ class Tracker {
    * @param {number} [parameters.result_page] - Page number of results
    * @param {number} [parameters.result_position_on_page] - Position of clicked item
    * @param {number} [parameters.num_results_per_page] - Number of results shown
-   * @param {string} [parameters.selected_filters] -  Selected filters
+   * @param {object} [parameters.selected_filters] -  Selected filters
    * @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
-   * @param {object} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
@@ -1216,7 +1223,7 @@ class Tracker {
    *         result_page: 2,
    *         result_position_on_page: 2,
    *         num_results_per_page: 12,
-   *         selected_filters: [ 'brand', 'color' ],
+   *         selected_filters: { brand: ['foo'], color: ['black'] },
    *         filter_name: 'brand',
    *         filter_value: 'XYZ',
    *         item_id: 'KMH876',
@@ -1323,7 +1330,7 @@ class Tracker {
    * @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
-   * @param {object} userParameters.userId - User ID, utilized to personalize results
+   * @param {string} userParameters.userId - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
    * @param {string} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)

package/src/utils/helpers.js

@@ -3,14 +3,18 @@ const qs = require('qs');
 
 const utils = {
   ourEncodeURIComponent: (str) => {
-    if (str) {
-      const parsedStrObj = qs.parse(`s=${str.replace(/&/g, '%26')}`);
+    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, ' ');
 
       return qs.stringify(parsedStrObj).split('=')[1];
     }
-
     return null;
   },
 
@@ -42,7 +46,7 @@ const utils = {
     throw error;
   }),
 
-  isNil: value => value == null,
+  isNil: (value) => value == null,
 
   // Create authorization header to be transmitted with requests
   createAuthHeader: (options) => {
@@ -53,8 +57,10 @@ const utils = {
 
   // Abort network request based on supplied timeout interval (in milliseconds)
   // - method call parameter takes precedence over global options parameter
-  applyNetworkTimeout: (options = {}, networkParameters = {}, controller) => {
-    const timeout = options.networkParameters.timeout || networkParameters.timeout;
+  applyNetworkTimeout: (options = {}, networkParameters = {}, controller = undefined) => {
+    const optionsTimeout = options && options.networkParameters && options.networkParameters.timeout;
+    const networkParametersTimeout = networkParameters && networkParameters.timeout;
+    const timeout = optionsTimeout || networkParametersTimeout;
 
     if (typeof timeout === 'number') {
       setTimeout(() => controller.abort(), timeout);