@constructor-io/constructorio-node 3.7.0 → 3.8.1

package/package.json

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

package/src/constructorio.js

@@ -7,6 +7,7 @@ const Autocomplete = require('./modules/autocomplete');
 const Recommendations = require('./modules/recommendations');
 const Tracker = require('./modules/tracker');
 const Catalog = require('./modules/catalog');
+const Tasks = require('./modules/tasks');
 const { version: packageVersion } = require('../package.json');
 
 /**
@@ -28,6 +29,7 @@ class ConstructorIO {
    * @property {object} recommendations - Interface to {@link module:recommendations}
    * @property {object} tracker - Interface to {@link module:tracker}
    * @property {object} catalog - Interface to {@link module:catalog}
+   * @property {object} tasks - Interface to {@link module:tasks}
    * @returns {class}
    */
   constructor(options = {}) {
@@ -62,6 +64,7 @@ class ConstructorIO {
     this.recommendations = new Recommendations(this.options);
     this.tracker = new Tracker(this.options);
     this.catalog = new Catalog(this.options);
+    this.tasks = new Tasks(this.options);
   }
 }
 

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) {
@@ -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/tasks.js

@@ -0,0 +1,141 @@
+/* eslint-disable object-curly-newline, no-underscore-dangle, max-len */
+const qs = require('qs');
+const nodeFetch = require('node-fetch').default;
+const { AbortController } = require('node-abort-controller');
+const helpers = require('../utils/helpers');
+
+// Create URL from supplied path and options
+function createTaskUrl(path, options, additionalQueryParams = {}, apiVersion = 'v1') {
+  const {
+    apiKey,
+    serviceUrl,
+  } = options;
+  let queryParams = {
+    ...additionalQueryParams,
+  };
+
+  // Validate path is provided
+  if (!path || typeof path !== 'string') {
+    throw new Error('path is a required parameter of type string');
+  }
+
+  queryParams.key = apiKey;
+  queryParams = helpers.cleanParams(queryParams);
+
+  const queryString = qs.stringify(queryParams, { indices: false });
+
+  return `${serviceUrl}/${encodeURIComponent(apiVersion)}/${encodeURIComponent(path)}?${queryString}`;
+}
+
+/**
+ * Interface to task related API calls
+ *
+ * @module tasks
+ * @inner
+ * @returns {object}
+ */
+class Tasks {
+  constructor(options) {
+    this.options = options || {};
+  }
+
+  /**
+   * Retrieve all tasks from index
+   *
+   * @function getAllTasks
+   * @param {object} parameters - Additional parameters for task details
+   * @param {number} [parameters.num_results_per_page = 20] - The number of tasks to return - maximum value 100
+   * @param {number} [parameters.page = 1] - The page of results to return
+   * @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/tasks/#retrieve-all-tasks
+   */
+  getAllTasks(parameters = {}, networkParameters = {}) {
+    const queryParams = {};
+    let requestUrl;
+    const fetch = (this.options && this.options.fetch) || nodeFetch;
+    const controller = new AbortController();
+    const { signal } = controller;
+
+    if (parameters) {
+      const { num_results_per_page: numResultsPerPage, page } = parameters;
+
+      // Pull number of results per page from parameters
+      if (numResultsPerPage) {
+        queryParams.num_results_per_page = numResultsPerPage;
+      }
+
+      // Pull page from parameters
+      if (page) {
+        queryParams.page = page;
+      }
+    }
+
+    try {
+      requestUrl = createTaskUrl('tasks', this.options, queryParams);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      method: 'GET',
+      headers: {
+        'Content-Type': 'application/json',
+        ...helpers.createAuthHeader(this.options),
+      },
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    }).then((json) => json);
+  }
+
+  /**
+   * Retrieve task given a specific id
+   *
+   * @function getTask
+   * @param {object} parameters - Additional parameters for task details
+   * @param {string} parameters.id - The ID of the task to be retrieved
+   * @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/tasks/#retrieve-by-specific-task-id
+   */
+  getTask(parameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const fetch = (this.options && this.options.fetch) || nodeFetch;
+    const controller = new AbortController();
+    const { signal } = controller;
+
+    try {
+      requestUrl = createTaskUrl(`tasks/${parameters.id}`, this.options);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, {
+      method: 'GET',
+      headers: {
+        'Content-Type': 'application/json',
+        ...helpers.createAuthHeader(this.options),
+      },
+      signal,
+    }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    }).then((json) => json);
+  }
+}
+
+module.exports = Tasks;

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
@@ -782,7 +782,7 @@ class Tracker {
       }
 
       if (items && Array.isArray(items)) {
-        bodyParams.items = items;
+        bodyParams.items = items.slice(0, 100);
       }
 
       if (revenue) {
@@ -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