@constructor-io/constructorio-node 4.1.0 → 4.2.1

package/package.json

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

package/src/modules/autocomplete.js

@@ -153,6 +153,8 @@ class Autocomplete {
       return Promise.reject(e);
     }
 
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
     // Append security token as 'x-cnstrc-token' if available
     if (this.options.securityToken && typeof this.options.securityToken === 'string') {
       headers['x-cnstrc-token'] = this.options.securityToken;

package/src/modules/browse.js

@@ -193,9 +193,11 @@ function createBrowseUrlForFacetOptions(facetName, parameters, userParameters, o
 }
 
 // Create request headers using supplied options and user parameters
-function createHeaders(options, userParameters) {
+function createHeaders(options, userParameters, networkParameters = {}) {
   const headers = {};
 
+  Object.assign(headers, helpers.combineCustomHeaders(options, networkParameters));
+
   // Append security token as 'x-cnstrc-token' if available
   if (options.securityToken && typeof options.securityToken === 'string') {
     headers['x-cnstrc-token'] = options.securityToken;
@@ -273,7 +275,7 @@ class Browse {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
-    const headers = createHeaders(this.options, userParameters);
+    const headers = createHeaders(this.options, userParameters, networkParameters);
 
     try {
       requestUrl = createBrowseUrlFromFilter(filterName, filterValue, parameters, userParameters, this.options);
@@ -357,7 +359,7 @@ class Browse {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
-    const headers = createHeaders(this.options, userParameters);
+    const headers = createHeaders(this.options, userParameters, networkParameters);
 
     try {
       requestUrl = createBrowseUrlFromIDs(itemIds, parameters, userParameters, this.options);
@@ -428,7 +430,7 @@ class Browse {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
-    const headers = createHeaders(this.options, userParameters);
+    const headers = createHeaders(this.options, userParameters, networkParameters);
     const { serviceUrl } = this.options;
     const queryParams = createQueryParams(parameters, userParameters, this.options);
 
@@ -488,6 +490,7 @@ class Browse {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
+    const headers = createHeaders(this.options, userParameters, networkParameters);
 
     try {
       requestUrl = createBrowseUrlForFacets(parameters, userParameters, this.options);
@@ -499,7 +502,7 @@ class Browse {
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
     return fetch(requestUrl, {
-      headers: helpers.createAuthHeader(this.options),
+      headers: { ...headers, ...helpers.createAuthHeader(this.options) },
       signal,
     }).then((response) => {
       if (response.ok) {
@@ -542,6 +545,7 @@ class Browse {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
+    const headers = createHeaders(this.options, userParameters, networkParameters);
 
     try {
       requestUrl = createBrowseUrlForFacetOptions(facetName, parameters, userParameters, this.options);
@@ -553,7 +557,7 @@ class Browse {
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
     return fetch(requestUrl, {
-      headers: helpers.createAuthHeader(this.options),
+      headers: { ...headers, ...helpers.createAuthHeader(this.options) },
       signal,
     }).then((response) => {
       if (response.ok) {

package/src/modules/catalog.js

@@ -34,14 +34,14 @@ function createCatalogUrl(path, options, additionalQueryParams = {}, apiVersion
 // Convert a read stream to buffer
 function convertToBuffer(stream) {
   return new Promise((resolve, reject) => {
-    let buffer = '';
+    const chunks = [];
 
     stream.on('data', (chunk) => {
-      buffer += chunk;
+      chunks.push(chunk);
     });
 
     stream.on('end', () => {
-      resolve(buffer);
+      resolve(Buffer.concat(chunks));
     });
 
     stream.on('error', (err) => {
@@ -118,6 +118,37 @@ async function createQueryParamsAndFormData(parameters) {
   return { queryParams, formData };
 }
 
+async function addTarArchiveToFormData(parameters, formData, operation, apiKey) {
+  try {
+    const { section } = parameters;
+    let { tarArchive } = parameters;
+
+    // Convert tarArchive to buffer if passed as stream
+    if (tarArchive instanceof fs.ReadStream || tarArchive instanceof Duplex) {
+      tarArchive = await convertToBuffer(tarArchive);
+    }
+
+    // Pull tarArchive from parameters
+    if (tarArchive && formData && operation && apiKey && section) {
+      // Convert timestamp to YYYY-MM-DD-HH-MM-SS format
+      const formattedDateTime = new Date()
+        .toISOString()
+        .replace('T', '-')
+        .replace(/:/g, '-')
+        .slice(0, 19);
+      const filename = `${apiKey}_${section}_${operation}_${formattedDateTime}.tar.gz`;
+
+      formData.append(filename, tarArchive, {
+        filename,
+      });
+    }
+  } catch (error) {
+    throw new Error(error);
+  }
+
+  return formData;
+}
+
 /**
  * Interface to catalog related API calls
  *
@@ -2207,6 +2238,155 @@ class Catalog {
     }
   }
 
+  /**
+   * Send full catalog tar archive to replace the current catalog
+   *
+   * @function replaceCatalogUsingTarArchive
+   * @param {object} parameters - Additional parameters for catalog details
+   * @param {string} parameters.section - The section to update
+   * @param {string} [parameters.notification_email] - An email address to receive an email notification if the task fails
+   * @param {boolean} [parameters.force=false] - Process the catalog even if it will invalidate a large number of existing items
+   * @param {file} [parameters.tarArchive] - The tar file that includes csv files
+   * @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/full_catalog
+   * @example
+   * constructorio.catalog.replaceCatalogUsingTarArchive({
+   *     section: 'Products',
+   *     notification_email: 'notifications@example.com',
+   *     tarArchive: tarArchiveBufferOrStream,
+   * });
+   */
+  async replaceCatalogUsingTarArchive(parameters = {}, networkParameters = {}) {
+    try {
+      const fetch = (this.options && this.options.fetch) || nodeFetch;
+      const apiKey = this.options && this.options.apiKey;
+      const controller = new AbortController();
+      const { signal } = controller;
+      const { queryParams, formData } = await createQueryParamsAndFormData(parameters);
+      const formDataWithTarArchive = await addTarArchiveToFormData(parameters, formData, 'sync', apiKey);
+      const requestUrl = createCatalogUrl('catalog', this.options, queryParams);
+      // Handle network timeout if specified
+      helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+      const response = await fetch(requestUrl, {
+        method: 'PUT',
+        body: formDataWithTarArchive,
+        headers: helpers.createAuthHeader(this.options),
+        signal,
+      });
+
+      if (response.ok) {
+        return Promise.resolve(response.json());
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  }
+
+  /**
+   * Send delta catalog tar archive to update the current catalog
+   *
+   * @function updateCatalogUsingTarArchive
+   * @param {object} parameters - Additional parameters for catalog details
+   * @param {string} parameters.section - The section to update
+   * @param {string} [parameters.notification_email] - An email address to receive an email notification if the task fails
+   * @param {boolean} [parameters.force=false] - Process the catalog even if it will invalidate a large number of existing items
+   * @param {file} [parameters.tarArchive] - The tar file that includes csv files
+   * @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/full_catalog
+   * @example
+   * constructorio.catalog.updateCatalogUsingTarArchive({
+   *     section: 'Products',
+   *     notification_email: 'notifications@example.com',
+   *     tarArchive: tarArchiveBufferOrStream,
+   * });
+   */
+  async updateCatalogUsingTarArchive(parameters = {}, networkParameters = {}) {
+    try {
+      const fetch = (this.options && this.options.fetch) || nodeFetch;
+      const apiKey = this.options && this.options.apiKey;
+      const controller = new AbortController();
+      const { signal } = controller;
+      const { queryParams, formData } = await createQueryParamsAndFormData(parameters);
+      const formDataWithTarArchive = await addTarArchiveToFormData(parameters, formData, 'delta', apiKey);
+      const requestUrl = createCatalogUrl('catalog', this.options, queryParams);
+
+      // Handle network timeout if specified
+      helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+      const response = await fetch(requestUrl, {
+        method: 'PATCH',
+        body: formDataWithTarArchive,
+        headers: helpers.createAuthHeader(this.options),
+        signal,
+      });
+
+      if (response.ok) {
+        return Promise.resolve(response.json());
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  }
+
+  /**
+   * Send patch delta tar archive to patch the current catalog
+   *
+   * @function patchCatalogUsingTarArchive
+   * @param {object} parameters - Additional parameters for catalog details
+   * @param {string} parameters.section - The section to update
+   * @param {string} [parameters.notification_email] - An email address to receive an email notification if the task fails
+   * @param {boolean} [parameters.force=false] - Process the catalog even if it will invalidate a large number of existing items
+   * @param {file} [parameters.tarArchive] - The tar file that includes csv files
+   * @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/full_catalog
+   * @example
+   * constructorio.catalog.patchCatalogUsingTarArchive({
+   *     section: 'Products',
+   *     notification_email: 'notifications@example.com',
+   *     tarArchive: tarArchiveBufferOrStream,
+   * });
+   */
+  async patchCatalogUsingTarArchive(parameters = {}, networkParameters = {}) {
+    try {
+      const fetch = (this.options && this.options.fetch) || nodeFetch;
+      const apiKey = this.options && this.options.apiKey;
+      const controller = new AbortController();
+      const { signal } = controller;
+      const { queryParams, formData } = await createQueryParamsAndFormData(parameters);
+      const formDataWithTarArchive = await addTarArchiveToFormData(parameters, formData, 'delta', apiKey);
+      const requestUrl = createCatalogUrl('catalog', this.options, { ...queryParams, patch_delta: true });
+
+      // Handle network timeout if specified
+      helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+      const response = await fetch(requestUrl, {
+        method: 'PATCH',
+        body: formDataWithTarArchive,
+        headers: helpers.createAuthHeader(this.options),
+        signal,
+      });
+
+      if (response.ok) {
+        return Promise.resolve(response.json());
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  }
+
   /**
    * Create a facet configuration
    *

package/src/modules/recommendations.js

@@ -142,6 +142,8 @@ class Recommendations {
       return Promise.reject(e);
     }
 
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
     // Append security token as 'x-cnstrc-token' if available
     if (this.options.securityToken && typeof this.options.securityToken === 'string') {
       headers['x-cnstrc-token'] = this.options.securityToken;
@@ -209,6 +211,8 @@ class Recommendations {
     const headers = {};
     const requestUrl = `${serviceUrl}/v1/recommendation_pods?key=${apiKey}`;
 
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
     // Append security token as 'x-cnstrc-token' if available
     if (this.options.securityToken && typeof this.options.securityToken === 'string') {
       headers['x-cnstrc-token'] = this.options.securityToken;

package/src/modules/search.js

@@ -202,6 +202,8 @@ class Search {
       return Promise.reject(e);
     }
 
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
     // Append security token as 'x-cnstrc-token' if available
     if (this.options.securityToken && typeof this.options.securityToken === 'string') {
       headers['x-cnstrc-token'] = this.options.securityToken;

package/src/modules/tasks.js

@@ -61,6 +61,9 @@ class Tasks {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
+    const headers = {
+      'Content-Type': 'application/json',
+    };
 
     if (parameters) {
       const { num_results_per_page: numResultsPerPageOld, numResultsPerPage, page, startDate, endDate, status, type } = parameters;
@@ -98,12 +101,14 @@ class Tasks {
       return Promise.reject(e);
     }
 
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
     return fetch(requestUrl, {
       method: 'GET',
       headers: {
-        'Content-Type': 'application/json',
+        ...headers,
         ...helpers.createAuthHeader(this.options),
       },
       signal,
@@ -132,6 +137,9 @@ class Tasks {
     const fetch = (this.options && this.options.fetch) || nodeFetch;
     const controller = new AbortController();
     const { signal } = controller;
+    const headers = {
+      'Content-Type': 'application/json',
+    };
 
     try {
       requestUrl = createTaskUrl(`tasks/${parameters.id}`, this.options);
@@ -139,12 +147,14 @@ class Tasks {
       return Promise.reject(e);
     }
 
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
     return fetch(requestUrl, {
       method: 'GET',
       headers: {
-        'Content-Type': 'application/json',
+        ...headers,
         ...helpers.createAuthHeader(this.options),
       },
       signal,

package/src/modules/tracker.js

@@ -84,6 +84,8 @@ function send(url, userParameters, networkParameters, method = 'GET', body = {})
   const { signal } = controller;
   const headers = {};
 
+  Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
   // Append security token as 'x-cnstrc-token' if available
   if (this.options.securityToken && typeof this.options.securityToken === 'string') {
     headers['x-cnstrc-token'] = this.options.securityToken;

package/src/utils/helpers.js

@@ -43,7 +43,7 @@ const utils = {
   },
 
   // Abort network request based on supplied timeout interval (in milliseconds)
-  // - method call parameter takes precedence over global options parameter
+  // - Method call parameter takes precedence over global options parameter
   applyNetworkTimeout: (options = {}, networkParameters = {}, controller = undefined) => {
     const optionsTimeout = options && options.networkParameters && options.networkParameters.timeout;
     const networkParametersTimeout = networkParameters && networkParameters.timeout;
@@ -53,6 +53,15 @@ const utils = {
       setTimeout(() => controller.abort(), timeout);
     }
   },
+
+  // Combine headers from options and networkParameters
+  // - Method call parameter takes precedence over global options parameter
+  combineCustomHeaders: (options = {}, networkParameters = {}) => {
+    const optionsHeaders = options && options.networkParameters && options.networkParameters.headers;
+    const networkParametersHeaders = networkParameters && networkParameters.headers;
+
+    return { ...optionsHeaders, ...networkParametersHeaders };
+  },
 };
 
 module.exports = utils;