@constructor-io/constructorio-node 4.17.1 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.17.1",
+  "version": "5.0.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/tracker.js

@@ -570,9 +570,16 @@ class Tracker {
    * @function trackSearchResultsLoaded
    * @param {string} term - Search results query term
    * @param {object} parameters - Additional parameters to be sent with request
-   * @param {number} parameters.numResults - Total number of results
-   * @param {string[]} parameters.itemIds - List of product item unique identifiers in search results listing
-   * @param {string} [parameters.section] - Index section
+   * @param {object[]} parameters.items - List of product item unique identifiers in search results listing
+   * @param {string} [parameters.url] - URL of the search results page
+   * @param {number} [parameters.resultCount] - Total number of results
+   * @param {number} [parameters.resultPage] - Current page of search results
+   * @param {string} [parameters.resultId] - Browse result identifier (returned in response from Constructor)
+   * @param {object} [parameters.selectedFilters] - Selected filters
+   * @param {string} [parameters.sortOrder] - Sort order ('ascending' or 'descending')
+   * @param {string} [parameters.sortBy] - Sorting method
+   * @param {string} [parameters.section] - The section name for the item Ex. "Products"
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @param {object} userParameters - Parameters relevant to the user request
    * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
    * @param {string} userParameters.clientId - Client ID, utilized to personalize results
@@ -593,8 +600,8 @@ class Tracker {
    * constructorio.tracker.trackSearchResultsLoaded(
    *     'T-Shirt',
    *     {
-   *         numResults: 167,
-   *         itemIds: ['KMH876', 'KMH140', 'KMH437'],
+   *         resultCount: 167,
+   *         items: [{ itemId: 'KMH876' }, { itemId: 'KMH140' }],
    *     },
    *     {
    *         sessionId: 1,
@@ -610,45 +617,73 @@ class Tracker {
     if (term && typeof term === 'string') {
       // Ensure parameters are provided (required)
       if (parameters && typeof parameters === 'object' && !Array.isArray(parameters)) {
-        const url = `${this.options.serviceUrl}/behavior?`;
-        const queryParams = { action: 'search-results', term };
+        const baseUrl = `${this.options.serviceUrl}/v2/behavioral_action/search_result_load?`;
         const {
           num_results,
           numResults = num_results,
-          customer_ids,
-          customerIds = customer_ids,
-          item_ids,
-          itemIds = item_ids,
+          result_count,
+          customerIds,
+          customer_ids = customerIds,
+          itemIds,
+          item_ids = itemIds,
+          items = customer_ids || item_ids,
+          result_page,
+          resultPage = result_page,
+          result_id,
+          resultId = result_id,
+          sort_order,
+          sortOrder = sort_order,
+          sort_by,
+          sortBy = sort_by,
+          selected_filters,
+          selectedFilters = selected_filters,
+          url = 'N/A',
           section,
+          analyticsTags,
+          resultCount = numResults || result_count || items?.length || 0,
         } = parameters;
-        let customerIDs;
+        const queryParams = {};
+        let transformedItems;
 
-        if (!helpers.isNil(numResults)) {
-          queryParams.num_results = numResults;
-        }
+        if (items && Array.isArray(items) && items.length !== 0) {
+          const trimmedItems = items.slice(0, 100);
 
-        // Ensure support for both item_ids and customer_ids as parameters
-        if (itemIds && Array.isArray(itemIds)) {
-          customerIDs = itemIds;
-        } else if (customerIds && Array.isArray(customerIds)) {
-          customerIDs = customerIds;
-        }
-
-        if (customerIDs && Array.isArray(customerIDs) && customerIDs.length) {
-          queryParams.customer_ids = customerIDs.slice(0, 100).join(',');
+          if (typeof items[0] === 'string' || typeof items[0] === 'number') {
+            transformedItems = trimmedItems.map((itemId) => ({ item_id: String(itemId) }));
+          } else {
+            transformedItems = trimmedItems.map((item) => helpers.toSnakeCaseKeys(item, false));
+          }
         }
 
         if (section) {
           queryParams.section = section;
         }
 
-        const requestUrl = `${url}${applyParamsAsString(queryParams, userParameters, this.options)}`;
+        const bodyParams = {
+          search_term: term,
+          result_count: resultCount,
+          items: transformedItems,
+          result_page: resultPage,
+          result_id: resultId,
+          sort_order: sortOrder,
+          sort_by: sortBy,
+          selected_filters: selectedFilters,
+          analytics_tags: analyticsTags,
+          url,
+          section,
+        };
+
+        const requestUrl = `${baseUrl}${applyParamsAsString({}, userParameters, this.options)}`;
+        const requestMethod = 'POST';
+        const requestBody = applyParams(bodyParams, userParameters, { ...this.options, requestMethod });
 
         send.call(
           this,
           requestUrl,
           userParameters,
           networkParameters,
+          requestMethod,
+          requestBody,
         );
 
         return true;
@@ -1041,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(
    *     {
@@ -1628,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/tracker.d.ts

@@ -74,9 +74,16 @@ declare class Tracker {
   trackSearchResultsLoaded(
     term: string,
     parameters: {
-      numResults: number;
-      itemIds: string[];
+      url: string;
+      items: ItemTracked[];
+      resultCount?: number;
+      resultPage?: number;
+      resultId?: string;
+      selectedFilters?: Record<string, any>;
+      sortOrder?: string;
+      sortBy?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     userParameters?: TrackerUserParameters,
     networkParameters?: NetworkParameters
@@ -97,7 +104,7 @@ declare class Tracker {
   ): true | Error;
 
   trackConversion(
-    term : string | null | undefined,
+    term: string | null | undefined,
     parameters: {
       itemId: string;
       revenue?: number;