@constructor-io/constructorio-node 3.8.3 → 3.8.7

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "3.8.3",
+  "version": "3.8.7",
   "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'",
+    "lint": "eslint 'src/**/*.js' 'spec/**/*.js'",
     "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",

package/src/modules/autocomplete.js

@@ -68,7 +68,11 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
 
     // Pull hidden fields from parameters
     if (hiddenFields) {
-      queryParams.hidden_fields = hiddenFields;
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = { hidden_fields: hiddenFields };
+      }
     }
   }
 
@@ -107,7 +111,7 @@ class Autocomplete {
    * @param {number} [userParameters.clientId] - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -123,6 +127,10 @@ class Autocomplete {
    *     filters: {
    *         size: 'medium'
    *     },
+   * }, {
+   *     testCells: {
+   *         testName: 'cellName',
+   *    },
    * });
    */
   getAutocompleteResults(query, parameters = {}, userParameters = {}, networkParameters = {}) {

package/src/modules/browse.js

@@ -33,6 +33,7 @@ function createQueryParams(parameters, userParameters, options) {
       section,
       fmtOptions,
       hiddenFields,
+      hiddenFacets,
     } = parameters;
 
     // Pull page from parameters
@@ -71,7 +72,20 @@ function createQueryParams(parameters, userParameters, options) {
 
     // Pull hidden fields from parameters
     if (hiddenFields) {
-      queryParams.hidden_fields = hiddenFields;
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = { hidden_fields: hiddenFields };
+      }
+    }
+
+    // Pull hidden facets from parameters
+    if (hiddenFacets) {
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_facets = hiddenFacets;
+      } else {
+        queryParams.fmt_options = { hidden_facets: hiddenFacets };
+      }
     }
   }
 
@@ -211,12 +225,13 @@ class Browse {
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
    * @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} [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 {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
-   * @param {string} [userParameters.testCells] - User test cells
+   * @param {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -229,6 +244,10 @@ class Browse {
    *     filters: {
    *         size: 'medium'
    *     },
+   * }, {
+   *     testCells: {
+   *         testName: 'cellName',
+   *    },
    * });
    */
   getBrowseResults(filterName, filterValue, parameters = {}, userParameters = {}, networkParameters = {}) {
@@ -288,12 +307,13 @@ class Browse {
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
    * @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} [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 {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
-   * @param {string} [userParameters.testCells] - User test cells
+   * @param {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -305,8 +325,12 @@ class Browse {
    *     filters: {
    *         size: 'medium'
    *     },
+   * }, {
+   *     testCells: {
+   *         'testName': 'cellName',
+   *    },
    * });
-  */
+   */
   getBrowseResultsForItemIds(itemIds, parameters = {}, userParameters = {}, networkParameters = {}) {
     let requestUrl;
     const fetch = (this.options && this.options.fetch) || nodeFetch;
@@ -357,7 +381,7 @@ class Browse {
    * @param {number} [userParameters.clientId] - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -372,6 +396,10 @@ class Browse {
    *     fmtOptions: {
    *         groups_max_depth: 2
    *     }
+   * }, {
+   *     testCells: {
+   *         'testName': 'cellName',
+   *    },
    * });
    */
   getBrowseGroups(parameters = {}, userParameters = {}, networkParameters = {}) {
@@ -414,7 +442,7 @@ class Browse {
    * @param {number} [userParameters.clientId] - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -425,6 +453,10 @@ class Browse {
    * constructorio.browse.getBrowseFacets({
    *     page: 1,
    *     resultsPerPage: 10,
+   * }, {
+   *     testCells: {
+   *         'testName': 'cellName',
+   *    },
    * });
    */
   getBrowseFacets(parameters = {}, userParameters = {}, networkParameters = {}) {

package/src/modules/catalog.js

@@ -497,7 +497,11 @@ class Catalog {
     }
 
     try {
-      requestUrl = createCatalogUrl(`item/${parameters.id}`, this.options, queryParams);
+      if (parameters.id) {
+        requestUrl = createCatalogUrl(`item/${parameters.id}`, this.options, queryParams);
+      } else {
+        requestUrl = createCatalogUrl('item', this.options, queryParams);
+      }
     } catch (e) {
       return Promise.reject(e);
     }

package/src/modules/recommendations.js

@@ -102,7 +102,7 @@ class Recommendations {
    * @param {number} [userParameters.clientId] - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -115,6 +115,10 @@ class Recommendations {
    *     filters: {
    *         size: 'medium'
    *     },
+   * }, {
+   *     testCells: {
+   *         testName: 'cellName',
+   *    },
    * });
    */
   getRecommendations(podId, parameters = {}, userParameters = {}, networkParameters = {}) {

package/src/modules/search.js

@@ -56,6 +56,7 @@ function createSearchUrl(query, parameters, userParameters, options) {
       section,
       fmtOptions,
       hiddenFields,
+      hiddenFacets,
     } = parameters;
 
     // Pull page from parameters
@@ -95,7 +96,20 @@ function createSearchUrl(query, parameters, userParameters, options) {
 
     // Pull hidden fields from parameters
     if (hiddenFields) {
-      queryParams.hidden_fields = hiddenFields;
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_fields = hiddenFields;
+      } else {
+        queryParams.fmt_options = { hidden_fields: hiddenFields };
+      }
+    }
+
+    // Pull hidden facets from parameters
+    if (hiddenFacets) {
+      if (queryParams.fmt_options) {
+        queryParams.fmt_options.hidden_facets = hiddenFacets;
+      } else {
+        queryParams.fmt_options = { hidden_facets: hiddenFacets };
+      }
     }
   }
 
@@ -133,12 +147,13 @@ class Search {
    * @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 {string[]} [parameters.hiddenFacets] - Hidden facet 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 {string} [userParameters.userId] - User ID, utilized to personalize results
    * @param {string} [userParameters.segments] - User segments
-   * @param {string} [userParameters.testCells] - User test cells
+   * @param {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.userIp] - Origin user IP, from client
    * @param {string} [userParameters.userAgent] - Origin user agent, from client
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -151,6 +166,10 @@ class Search {
    *     filters: {
    *         size: 'medium'
    *     },
+   * }, {
+   *     testCells: {
+   *         testName: 'cellName',
+   *    },
    * });
    */
 

package/src/modules/tracker.js

@@ -192,7 +192,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -205,6 +205,7 @@ class Tracker {
    * constructorio.tracker.trackSessionStart({
    *  sessionId: 1,
    *  clientId: '6c73138f-c27b-49f0-872d-63b00ed0e395',
+   *  testCells: { testName: 'cellName' },
    * });
    */
   trackSessionStart(userParameters, networkParameters = {}) {
@@ -231,7 +232,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -245,6 +246,7 @@ class Tracker {
    * constructorio.tracker.trackInputFocus({
    *     sessionId: 1,
    *     clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *     testCells: { testName: 'cellName' },
    * });
    */
   trackInputFocus(userParameters, networkParameters = {}) {
@@ -278,7 +280,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -291,17 +293,20 @@ class Tracker {
    * @example
    * constructorio.tracker.trackAutocompleteSelect(
    *     'T-Shirt',
-   *      {
-   *          original_query: 'Shirt',
-   *          section: 'Products',
-   *          tr: 'click',
-   *          group_id: '88JU230',
-   *          display_name: 'apparel',
-   *      },
-   *      {
-   *          sessionId: 1,
-   *          clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
-   *      },
+   *     {
+   *         original_query: 'Shirt',
+   *         section: 'Products',
+   *         tr: 'click',
+   *         group_id: '88JU230',
+   *         display_name: 'apparel',
+   *     },
+   *     {
+   *         sessionId: 1,
+   *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
+   *     },
    * );
    */
   trackAutocompleteSelect(term, parameters, userParameters, networkParameters = {}) {
@@ -371,7 +376,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -392,6 +397,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -446,7 +454,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -466,6 +474,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -527,7 +538,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -548,6 +559,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -620,7 +634,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -646,6 +660,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -745,7 +762,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -766,6 +783,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -831,7 +851,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -854,6 +874,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -941,7 +964,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -967,6 +990,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -1070,7 +1096,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -1097,6 +1123,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -1205,7 +1234,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -1232,6 +1261,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */
@@ -1333,7 +1365,7 @@ class Tracker {
    * @param {number} userParameters.clientId - Client 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 {object} [userParameters.testCells] - User test cells
    * @param {string} [userParameters.originReferrer] - Client page URL (including path)
    * @param {string} [userParameters.referer] - Client page URL (including path)
    * @param {string} [userParameters.userIp] - Client user IP
@@ -1353,6 +1385,9 @@ class Tracker {
    *     {
    *         sessionId: 1,
    *         clientId: '7a43138f-c87b-29c0-872d-65b00ed0e392',
+   *         testCells: {
+   *             testName: 'cellName',
+   *         },
    *     },
    * );
    */