@constructor-io/constructorio-node 4.18.0 → 5.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.18.0",
+  "version": "5.1.0",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/modules/catalog.js

@@ -210,7 +210,7 @@ class Catalog {
    *     ],
    * });
    */
-  createOrReplaceItems(parameters = {}, networkParameters = {}) {
+  async createOrReplaceItems(parameters = {}, networkParameters = {}) {
     let requestUrl;
     const { fetch } = this.options;
     const controller = new AbortController();
@@ -244,21 +244,27 @@ class Catalog {
     // Handle network timeout if specified
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
-    return fetch(requestUrl, {
-      method: 'PUT',
-      body: JSON.stringify({ items }),
-      headers: {
-        'Content-Type': 'application/json',
-        ...helpers.createAuthHeader(this.options),
-      },
-      signal,
-    }).then((response) => {
+    try {
+      const response = await fetch(requestUrl, {
+        method: 'PUT',
+        body: JSON.stringify({ items }),
+        headers: {
+          'Content-Type': 'application/json',
+          ...helpers.createAuthHeader(this.options),
+        },
+        signal,
+      });
+
       if (response.ok) {
-        return Promise.resolve();
+        const body = await response.json();
+
+        return Promise.resolve(body);
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    });
+    } catch (error) {
+      return Promise.reject(error);
+    }
   }
 
   /**
@@ -293,7 +299,7 @@ class Catalog {
    *     section: 'Products',
    * });
    */
-  updateItems(parameters = {}, networkParameters = {}) {
+  async updateItems(parameters = {}, networkParameters = {}) {
     let requestUrl;
     const { fetch } = this.options;
     const controller = new AbortController();
@@ -336,21 +342,26 @@ class Catalog {
     // Handle network timeout if specified
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
-    return fetch(requestUrl, {
-      method: 'PATCH',
-      body: JSON.stringify({ items }),
-      headers: {
-        'Content-Type': 'application/json',
-        ...helpers.createAuthHeader(this.options),
-      },
-      signal,
-    }).then((response) => {
+    try {
+      const response = await fetch(requestUrl, {
+        method: 'PATCH',
+        body: JSON.stringify({ items }),
+        headers: {
+          'Content-Type': 'application/json',
+          ...helpers.createAuthHeader(this.options),
+        },
+        signal,
+      });
+
       if (response.ok) {
-        return Promise.resolve();
+        const body = await response.json();
+        return Promise.resolve(body);
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    });
+    } catch (error) {
+      return Promise.reject(error);
+    }
   }
 
   /**
@@ -375,7 +386,7 @@ class Catalog {
    *     section: 'Products',
    * });
    */
-  deleteItems(parameters = {}, networkParameters = {}) {
+  async deleteItems(parameters = {}, networkParameters = {}) {
     let requestUrl;
     const { fetch } = this.options;
     const controller = new AbortController();
@@ -409,21 +420,26 @@ class Catalog {
     // Handle network timeout if specified
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
-    return fetch(requestUrl, {
-      method: 'DELETE',
-      body: JSON.stringify({ items }),
-      headers: {
-        'Content-Type': 'application/json',
-        ...helpers.createAuthHeader(this.options),
-      },
-      signal,
-    }).then((response) => {
+    try {
+      const response = await fetch(requestUrl, {
+        method: 'DELETE',
+        body: JSON.stringify({ items }),
+        headers: {
+          'Content-Type': 'application/json',
+          ...helpers.createAuthHeader(this.options),
+        },
+        signal,
+      });
+
       if (response.ok) {
-        return Promise.resolve();
+        const body = await response.json();
+        return Promise.resolve(body);
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    });
+    } catch (error) {
+      return Promise.reject(error);
+    }
   }
 
   /**
@@ -534,7 +550,7 @@ class Catalog {
    *     section: 'Products',
    * });
    */
-  createOrReplaceVariations(parameters = {}, networkParameters = {}) {
+  async createOrReplaceVariations(parameters = {}, networkParameters = {}) {
     let requestUrl;
     const { fetch } = this.options;
     const controller = new AbortController();
@@ -568,21 +584,26 @@ class Catalog {
     // Handle network timeout if specified
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
-    return fetch(requestUrl, {
-      method: 'PUT',
-      body: JSON.stringify({ variations }),
-      headers: {
-        'Content-Type': 'application/json',
-        ...helpers.createAuthHeader(this.options),
-      },
-      signal,
-    }).then((response) => {
+    try {
+      const response = await fetch(requestUrl, {
+        method: 'PUT',
+        body: JSON.stringify({ variations }),
+        headers: {
+          'Content-Type': 'application/json',
+          ...helpers.createAuthHeader(this.options),
+        },
+        signal,
+      });
+
       if (response.ok) {
-        return Promise.resolve();
+        const body = await response.json();
+        return Promise.resolve(body);
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    });
+    } catch (error) {
+      return Promise.reject(error);
+    }
   }
 
   /**
@@ -618,7 +639,7 @@ class Catalog {
    *     section: 'Products',
    * });
    */
-  updateVariations(parameters = {}, networkParameters = {}) {
+  async updateVariations(parameters = {}, networkParameters = {}) {
     let requestUrl;
     const { fetch } = this.options;
     const controller = new AbortController();
@@ -661,21 +682,26 @@ class Catalog {
     // Handle network timeout if specified
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
-    return fetch(requestUrl, {
-      method: 'PATCH',
-      body: JSON.stringify({ variations }),
-      headers: {
-        'Content-Type': 'application/json',
-        ...helpers.createAuthHeader(this.options),
-      },
-      signal,
-    }).then((response) => {
+    try {
+      const response = await fetch(requestUrl, {
+        method: 'PATCH',
+        body: JSON.stringify({ variations }),
+        headers: {
+          'Content-Type': 'application/json',
+          ...helpers.createAuthHeader(this.options),
+        },
+        signal,
+      });
+
       if (response.ok) {
-        return Promise.resolve();
+        const body = await response.json();
+        return Promise.resolve(body);
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    });
+    } catch (error) {
+      return Promise.reject(error);
+    }
   }
 
   /**
@@ -700,7 +726,7 @@ class Catalog {
    *     section: 'Products',
    * });
    */
-  deleteVariations(parameters = {}, networkParameters = {}) {
+  async deleteVariations(parameters = {}, networkParameters = {}) {
     let requestUrl;
     const { fetch } = this.options;
     const controller = new AbortController();
@@ -734,21 +760,26 @@ class Catalog {
     // Handle network timeout if specified
     helpers.applyNetworkTimeout(this.options, networkParameters, controller);
 
-    return fetch(requestUrl, {
-      method: 'DELETE',
-      body: JSON.stringify({ variations }),
-      headers: {
-        'Content-Type': 'application/json',
-        ...helpers.createAuthHeader(this.options),
-      },
-      signal,
-    }).then((response) => {
+    try {
+      const response = await fetch(requestUrl, {
+        method: 'DELETE',
+        body: JSON.stringify({ variations }),
+        headers: {
+          'Content-Type': 'application/json',
+          ...helpers.createAuthHeader(this.options),
+        },
+        signal,
+      });
+
       if (response.ok) {
-        return Promise.resolve();
+        const body = await response.json();
+        return Promise.resolve(body);
       }
 
       return helpers.throwHttpErrorFromResponse(new Error(), response);
-    });
+    } catch (error) {
+      return Promise.reject(error);
+    }
   }
 
   /**

package/src/modules/recommendations.js

@@ -1,4 +1,4 @@
-/* eslint-disable object-curly-newline, no-param-reassign */
+/* eslint-disable object-curly-newline, no-param-reassign, max-len */
 const qs = require('qs');
 const { AbortController } = require('node-abort-controller');
 const helpers = require('../utils/helpers');
@@ -41,6 +41,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     const {
       numResults,
       itemIds,
+      variationId,
       section,
       term,
       filters,
@@ -59,6 +60,18 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
       queryParams.item_id = itemIds;
     }
 
+    if (variationId) {
+      if (!itemIds) {
+        throw new Error('itemIds is a required parameter for variationId');
+      }
+
+      if (Array.isArray(itemIds) && !itemIds.length) {
+        throw new Error('At least one itemId is a required parameter for variationId');
+      }
+
+      queryParams.variation_id = variationId;
+    }
+
     // Pull section from parameters
     if (section) {
       queryParams.section = section;
@@ -119,7 +132,8 @@ class Recommendations {
    * @function getRecommendations
    * @param {string} podId - Pod identifier
    * @param {object} [parameters] - Additional parameters to refine results
-   * @param {string|array} [parameters.itemIds] - Item ID(s) to retrieve recommendations for (strategy specific)
+   * @param {string|array} [parameters.itemIds] - Item ID(s) to retrieve recommendations for (strategy specific). Required for variationId
+   * @param {string} [parameters.variationId] - Variation ID to retrieve recommendations for (strategy specific)
    * @param {number} [parameters.numResults] - The number of results to return
    * @param {string} [parameters.section] - The section to return results from
    * @param {string} [parameters.term] - The term to use to refine results (strategy specific)

package/src/modules/tracker.js

@@ -1076,7 +1076,7 @@ class Tracker {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
-   * @description User clicked a result that appeared within a search product listing page
+   * @description User viewed a set of recommendations
    * @example
    * constructorio.tracker.trackRecommendationView(
    *     {
@@ -1663,7 +1663,7 @@ class Tracker {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
-   * @description User clicked a result that appeared within a browse product listing page
+   * @description User clicked a result that appeared outside of the scope of search / browse / recommendations
    * @example
    * constructorio.tracker.trackGenericResultClick(
    *     {

package/src/types/catalog.d.ts

@@ -272,6 +272,12 @@ export interface PatchSearchabilitiesParameters {
   section?: string;
 }
 
+interface CatalogMutationResponse {
+  task_id: string;
+  task_status_path: string;
+  [key: string]: any;
+}
+
 declare class Catalog {
   constructor(options: ConstructorClientOptions);
 
@@ -280,17 +286,17 @@ declare class Catalog {
   createOrReplaceItems(
     parameters: CreateOrReplaceItemsParameters,
     networkParameters?: NetworkParameters
-  ): Promise<void>;
+  ): Promise<CatalogMutationResponse>;
 
   updateItems(
     parameters: UpdateItemsParameters,
     networkParameters?: NetworkParameters
-  ): Promise<void>;
+  ): Promise<CatalogMutationResponse>;
 
   deleteItems(
     parameters: DeleteItemsParameters,
     networkParameters?: NetworkParameters
-  ): Promise<void>;
+  ): Promise<CatalogMutationResponse>;
 
   retrieveItems(
     parameters: RetrieveItemsParameters,
@@ -300,17 +306,17 @@ declare class Catalog {
   createOrReplaceVariations(
     parameters: CreateOrReplaceVariationsParameters,
     networkParameters?: NetworkParameters
-  ): Promise<void>;
+  ): Promise<CatalogMutationResponse>;
 
   updateVariations(
     parameters: UpdateVariationsParameters,
     networkParameters?: NetworkParameters
-  ): Promise<void>;
+  ): Promise<CatalogMutationResponse>;
 
   deleteVariations(
     parameters: DeleteVariationsParameters,
     networkParameters?: NetworkParameters
-  ): Promise<void>;
+  ): Promise<CatalogMutationResponse>;
 
   retrieveVariations(
     parameters: RetrieveVariationsParameters,
@@ -479,56 +485,32 @@ declare class Catalog {
   replaceCatalog(
     parameters: ReplaceCatalogParameters,
     networkParameters?: NetworkParameters
-  ): Promise<{
-    task_id: string;
-    task_status_path: string;
-    [key: string]: any;
-  }>;
+  ): Promise<CatalogMutationResponse>;
 
   updateCatalog(
     parameters: UpdateCatalogParameters,
     networkParameters?: NetworkParameters
-  ): Promise<{
-    task_id: string;
-    task_status_path: string;
-    [key: string]: any;
-  }>;
+  ): Promise<CatalogMutationResponse>;
 
   patchCatalog(
     parameters: PatchCatalogParameters,
     networkParameters?: NetworkParameters
-  ): Promise<{
-    task_id: string;
-    task_status_path: string;
-    [key: string]: any;
-  }>;
+  ): Promise<CatalogMutationResponse>;
 
   replaceCatalogUsingTarArchive(
     parameters: ReplaceCatalogUsingTarArchiveParameters,
     networkParameters?: NetworkParameters
-  ): Promise<{
-    task_id: string;
-    task_status_path: string;
-    [key: string]: any;
-  }>;
+  ): Promise<CatalogMutationResponse>;
 
   updateCatalogUsingTarArchive(
     parameters: UpdateCatalogUsingTarArchiveParameters,
     networkParameters?: NetworkParameters
-  ): Promise<{
-    task_id: string;
-    task_status_path: string;
-    [key: string]: any;
-  }>;
+  ): Promise<CatalogMutationResponse>;
 
   patchCatalogUsingTarArchive(
     parameters: PatchCatalogUsingTarArchiveParameters,
     networkParameters?: NetworkParameters
-  ): Promise<{
-    task_id: string;
-    task_status_path: string;
-    [key: string]: any;
-  }>;
+  ): Promise<CatalogMutationResponse>;
 
   addFacetConfiguration(
     parameters: FacetConfiguration,

package/src/types/recommendations.d.ts

@@ -1,9 +1,10 @@
-import { ConstructorClientOptions, NetworkParameters, UserParameters, VariationsMap } from '.';
+import { ConstructorClientOptions, NetworkParameters, UserParameters, VariationsMap, FilterExpression } from '.';
 
 export default Recommendations;
 
 export interface RecommendationsParameters {
   itemIds?: string | string[];
+  variationId?: string;
   numResults?: number;
   section?: string;
   term?: string;
@@ -39,7 +40,8 @@ export interface RecommendationsResponse extends Record<string, any> {
 
 export interface RecommendationsRequestType extends Record<string, any> {
   num_results: number;
-  item_id: string;
+  item_id: string | string[];
+  variation_id: string;
   filters: {
     group_id: string;
     [key: string]: any;