@constructor-io/constructorio-node 3.8.0 → 3.8.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "3.8.0",
+  "version": "3.8.3",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "scripts": {
@@ -11,7 +11,8 @@
     "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",
-    "docs": "jsdoc --configure ./.jsdoc.json ./README.md --recurse ./src --destination ./docs"
+    "docs": "jsdoc --configure ./.jsdoc.json ./README.md --recurse ./src --destination ./docs",
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -26,9 +27,6 @@
   "engines": {
     "node": ">=8.3.0"
   },
-  "pre-push": [
-    "lint"
-  ],
   "files": [
     "src/**/*"
   ],
@@ -39,6 +37,7 @@
     "eslint": "^8.2.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.24.2",
+    "husky": "^7.0.4",
     "jsdoc": "^3.6.7",
     "jsdom": "^15.1.1",
     "license-checker": "^25.0.1",
@@ -47,7 +46,6 @@
     "mocha": "^9.1.3",
     "mocha-jsdom": "^2.0.0",
     "nyc": "^15.1.0",
-    "pre-push": "^0.1.1",
     "serve": "^13.0.2",
     "sinon": "^7.5.0",
     "sinon-chai": "^3.7.0",

package/src/modules/browse.js

@@ -118,11 +118,11 @@ function createBrowseUrlFromFilter(filterName, filterValue, parameters, userPara
   return `${serviceUrl}/browse/${encodeURIComponent(filterName)}/${encodeURIComponent(filterValue)}?${queryString}`;
 }
 
-// Create URL from supplied ID's
+// Create URL from supplied IDs and parameters
 function createBrowseUrlFromIDs(itemIds, parameters, userParameters, options) {
   const { serviceUrl } = options;
 
-  // Validate item ID's are provided
+  // Validate item IDs are provided
   if (!itemIds || !(itemIds instanceof Array) || !itemIds.length) {
     throw new Error('itemIds is a required parameter of type array');
   }
@@ -133,7 +133,7 @@ function createBrowseUrlFromIDs(itemIds, parameters, userParameters, options) {
   return `${serviceUrl}/browse/items?${queryString}`;
 }
 
-// Create URL from supplied ID's
+// Create URL from supplied parameters
 function createBrowseUrlForFacets(parameters, userParameters, options) {
   const { serviceUrl } = options;
   const queryParams = { ...createQueryParams(parameters, userParameters, options) };
@@ -141,9 +141,28 @@ function createBrowseUrlForFacets(parameters, userParameters, options) {
   delete queryParams._dt;
 
   const queryString = qs.stringify(queryParams, { indices: false });
+
   return `${serviceUrl}/browse/facets?${queryString}`;
 }
 
+// Create URL from supplied facet name and parameters
+function createBrowseUrlForFacetOptions(facetName, parameters, userParameters, options) {
+  const { serviceUrl } = options;
+
+  // Validate facet name is provided
+  if (!facetName || typeof facetName !== 'string') {
+    throw new Error('facetName is a required parameter of type string');
+  }
+
+  const queryParams = { ...createQueryParams(parameters, userParameters, options) };
+
+  delete queryParams._dt;
+
+  const queryString = qs.stringify(queryParams, { indices: false });
+
+  return `${serviceUrl}/browse/facet_options?facet_name=${facetName}&${queryString}`;
+}
+
 // Create request headers using supplied options and user parameters
 function createHeaders(options, userParameters) {
   const headers = {};
@@ -257,10 +276,10 @@ class Browse {
   }
 
   /**
-   * Retrieve browse results from API using item ID's
+   * Retrieve browse results from API using item IDs
    *
    * @function getBrowseResultsForItemIds
-   * @param {string[]} itemIds - Item ID's of results to fetch
+   * @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.resultsPerPage] - The number of results per page to return
@@ -434,6 +453,59 @@ class Browse {
       return helpers.throwHttpErrorFromResponse(new Error(), response);
     });
   }
+
+  /**
+   * Retrieve facet options from API
+   *
+   * @function getBrowseFacetOptions
+   * @param {string} facetName - Name of the facet whose options to return
+   * @param {object} [parameters] - Additional parameters to refine result set
+   * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
+   * @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
+   * @param {boolean} [parameters.fmtOptions.show_protected_facets] - Include facets configured as protected
+   * @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 {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
+   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+   * @returns {Promise}
+   * @see https://docs.constructor.io/rest_api/browse/facet_options
+   * @example
+   * constructorio.browse.getBrowseFacetOptions('price', {
+   *     fmtOptions: { ... },
+   * });
+   */
+  getBrowseFacetOptions(facetName, parameters = {}, userParameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const fetch = (this.options && this.options.fetch) || nodeFetch;
+    const controller = new AbortController();
+    const { signal } = controller;
+
+    try {
+      requestUrl = createBrowseUrlForFacetOptions(facetName, parameters, userParameters, this.options);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    // Handle network timeout if specified
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      headers: helpers.createAuthHeader(this.options),
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    });
+  }
 }
 
 module.exports = Browse;

package/src/modules/catalog.js

@@ -4,6 +4,7 @@ const nodeFetch = require('node-fetch').default;
 const { AbortController } = require('node-abort-controller');
 const FormData = require('form-data');
 const fs = require('fs');
+const { Duplex } = require('stream');
 const helpers = require('../utils/helpers');
 
 // Create URL from supplied path and options
@@ -59,17 +60,17 @@ async function createQueryParamsAndFormData(parameters) {
 
     try {
       // Convert items to buffer if passed as stream
-      if (items instanceof fs.ReadStream) {
+      if (items instanceof fs.ReadStream || items instanceof Duplex) {
         items = await convertToBuffer(items);
       }
 
       // Convert variations to buffer if passed as stream
-      if (variations instanceof fs.ReadStream) {
+      if (variations instanceof fs.ReadStream || variations instanceof Duplex) {
         variations = await convertToBuffer(variations);
       }
 
       // Convert item groups to buffer if passed as stream
-      if (itemGroups instanceof fs.ReadStream) {
+      if (itemGroups instanceof fs.ReadStream || itemGroups instanceof Duplex) {
         itemGroups = await convertToBuffer(itemGroups);
       }
     } catch (e) {
@@ -140,7 +141,7 @@ class Catalog {
    * @param {string} [parameters.url] - A URL to directly send the user after selecting the item
    * @param {string} [parameters.image_url] - A URL that points to an image you'd like displayed next to some item (only applicable when URL is supplied)
    * @param {string} [parameters.description] - A description for some item (only applicable when URL is supplied)
-   * @param {string} [parameters.id] - An arbitrary ID you would like associated with this item. You can use this field to store your own ID's of the items to more easily access them in other API calls
+   * @param {string} [parameters.id] - An arbitrary ID you would like associated with this item. You can use this field to store your own IDs of the items to more easily access them in other API calls
    * @param {object} [parameters.facets] - Key/value pairs that can be associated with an item and used to filter them during a search. You can associate multiple values with the same key, by making values a list. Facets can be used as filters in search, autosuggest, and browse requests
    * @param {object} [parameters.metadata] - You can associate schema-less data with items by passing in an object of keys and values. To configure search and display of this data reach out to support@constructor.io
    * @param {string[]} [parameters.group_ids] - You can associate each item with one or more groups (i.e. categories). To set up a group hierarchy please contact support@constructor.io. group_ids can be used as filters in search, autosuggest, and browse requests
@@ -194,7 +195,7 @@ class Catalog {
    * @param {string} [parameters.url] - A URL to directly send the user after selecting the item
    * @param {string} [parameters.image_url] - A URL that points to an image you'd like displayed next to some item (only applicable when URL is supplied)
    * @param {string} [parameters.description] - A description for some item (only applicable when URL is supplied)
-   * @param {string} [parameters.id] - An arbitrary ID you would like associated with this item. You can use this field to store your own ID's of the items to more easily access them in other API calls
+   * @param {string} [parameters.id] - An arbitrary ID you would like associated with this item. You can use this field to store your own IDs of the items to more easily access them in other API calls
    * @param {object} [parameters.facets] - Key/value pairs that can be associated with an item and used to filter them during a search. You can associate multiple values with the same key, by making values a list. Facets can be used as filters in search, autosuggest, and browse requests
    * @param {object} [parameters.metadata] - You can associate schema-less data with items by passing in an object of keys and values. To configure search and display of this data reach out to support@constructor.io
    * @param {string[]} [parameters.group_ids] - You can associate each item with one or more groups (i.e. categories). To set up a group hierarchy please contact support@constructor.io. group_ids can be used as filters in search, autosuggest, and browse requests
@@ -294,7 +295,7 @@ class Catalog {
    * @param {string} [parameters.url] - A URL to directly send the user after selecting the item
    * @param {string} [parameters.image_url] - A URL that points to an image you'd like displayed next to some item (only applicable when URL is supplied)
    * @param {string} [parameters.description] - A description for some item (only applicable when URL is supplied)
-   * @param {string} [parameters.id] - An arbitrary ID you would like associated with this item. You can use this field to store your own ID's of the items to more easily access them in other API calls
+   * @param {string} [parameters.id] - An arbitrary ID you would like associated with this item. You can use this field to store your own IDs of the items to more easily access them in other API calls
    * @param {object} [parameters.facets] - Key/value pairs that can be associated with an item and used to filter them during a search. You can associate multiple values with the same key, by making values a list. Facets can be used as filters in search, autosuggest, and browse requests
    * @param {object} [parameters.metadata] - You can associate schema-less data with items by passing in an object of keys and values. To configure search and display of this data reach out to support@constructor.io
    * @param {string[]} [parameters.group_ids] - You can associate each item with one or more groups (i.e. categories). To set up a group hierarchy please contact support@constructor.io. group_ids can be used as filters in search, autosuggest, and browse requests
@@ -2211,7 +2212,6 @@ class Catalog {
     return fetch(requestUrl, {
       method: 'DELETE',
       headers: {
-        'Content-Type': 'application/json',
         ...helpers.createAuthHeader(this.options),
       },
       signal,
@@ -2564,7 +2564,6 @@ class Catalog {
     return fetch(requestUrl, {
       method: 'DELETE',
       headers: {
-        'Content-Type': 'application/json',
         ...helpers.createAuthHeader(this.options),
       },
       signal,

package/src/modules/tracker.js

@@ -439,7 +439,7 @@ class Tracker {
    * @function trackSearchResultsLoaded
    * @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 {number} parameters.num_results - Total number of results
    * @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
@@ -822,7 +822,7 @@ class Tracker {
    * @param {string} parameters.url - Current page URL
    * @param {string} parameters.pod_id - Pod identifier
    * @param {number} parameters.num_results_viewed - Number of results viewed
-   * @param {number} [parameters.result_count] - Number of results displayed
+   * @param {number} [parameters.result_count] - Total number of results
    * @param {number} [parameters.result_page] - Page number of results
    * @param {string} [parameters.result_id] - Recommendation result identifier (returned in response from Constructor)
    * @param {string} [parameters.section="Products"] - Results section
@@ -932,6 +932,7 @@ class Tracker {
    * @param {string} [parameters.variation_id] - Product item variation unique identifier
    * @param {string} [parameters.section="Products"] - Index section
    * @param {string} [parameters.result_id] - Recommendation result identifier (returned in response from Constructor)
+   * @param {number} [parameters.result_count] - Total number of results
    * @param {number} [parameters.result_page] - Page number of results
    * @param {number} [parameters.result_position_on_page] - Position of result on page
    * @param {number} [parameters.num_results_per_page] - Number of results on page
@@ -1057,7 +1058,7 @@ class Tracker {
    * @param {string} parameters.filter_name - Filter name
    * @param {string} parameters.filter_value - Filter value
    * @param {string} [parameters.section="Products"] - Index section
-   * @param {number} [parameters.result_count] - Number of results displayed
+   * @param {number} [parameters.result_count] - Total number of results
    * @param {number} [parameters.result_page] - Page number of results
    * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
    * @param {object} [parameters.selected_filters] - Selected filters
@@ -1194,7 +1195,7 @@ class Tracker {
    * @param {string} [parameters.section="Products"] - Index section
    * @param {string} [parameters.variation_id] - Product item variation unique identifier
    * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
-   * @param {number} [parameters.result_count] - Number of results displayed
+   * @param {number} [parameters.result_count] - Total number of results
    * @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