@constructor-io/constructorio-node 4.5.2 → 4.5.3

package/package.json

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

package/src/modules/catalog.js

@@ -266,6 +266,7 @@ class Catalog {
    * @param {object} parameters - Additional parameters for item details
    * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.io/rest_api/items/items/#item-schema)
    * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing items
+   * @param {string} [parameters.onMissing="FAIL"] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence
    * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
    * @param {string} [parameters.section="Products"] - This indicates which section to operate on within the index
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -295,7 +296,7 @@ class Catalog {
     const { fetch } = this.options;
     const controller = new AbortController();
     const { signal } = controller;
-    const { items, section, force, notification_email, notificationEmail = notification_email } = parameters;
+    const { items, section, force, notification_email, notificationEmail = notification_email, onMissing } = parameters;
     const queryParams = {};
 
     // Validate items is provided
@@ -315,6 +316,15 @@ class Catalog {
       queryParams.force = force;
     }
 
+    if (onMissing) {
+      // Validate onMissing parameter
+      if (onMissing && !['FAIL', 'IGNORE', 'CREATE'].includes(onMissing)) {
+        return Promise.reject(new Error('onMissing must be one of FAIL, IGNORE, or CREATE'));
+      }
+
+      queryParams.on_missing = onMissing;
+    }
+
     try {
       requestUrl = createCatalogUrl('items', this.options, queryParams, 'v2');
     } catch (e) {
@@ -579,6 +589,7 @@ class Catalog {
    * @param {object} parameters - Additional parameters for variation details
    * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.io/rest_api/items/variations/#variation-schema)
    * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing variations
+   * @param {string} [parameters.onMissing="FAIL"] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence
    * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
    * @param {string} [parameters.section="Products"] - This indicates which section to operate on within the index
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -609,7 +620,7 @@ class Catalog {
     const { fetch } = this.options;
     const controller = new AbortController();
     const { signal } = controller;
-    const { section, force, notification_email, notificationEmail = notification_email, variations } = parameters;
+    const { section, force, notification_email, notificationEmail = notification_email, variations, onMissing } = parameters;
     const queryParams = {};
 
     // Validate variations are provided
@@ -629,6 +640,15 @@ class Catalog {
       queryParams.notification_email = notificationEmail;
     }
 
+    if (onMissing) {
+      // Validate onMissing parameter
+      if (onMissing && !['FAIL', 'IGNORE', 'CREATE'].includes(onMissing)) {
+        return Promise.reject(new Error('onMissing must be one of FAIL, IGNORE, or CREATE'));
+      }
+
+      queryParams.on_missing = onMissing;
+    }
+
     try {
       requestUrl = createCatalogUrl('variations', this.options, queryParams, 'v2');
     } catch (e) {
@@ -2232,7 +2252,7 @@ class Catalog {
    * @param {string} parameters.section - The section to update
    * @param {string} [parameters.notificationEmail] - 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 {string} [parameters.onMissing] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence. Defaults to FAIL
+   * @param {string} [parameters.onMissing="FAIL"] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence
    * @param {file} [parameters.items] - The CSV file with all new items
    * @param {file} [parameters.variations] - The CSV file with all new variations
    * @param {file} [parameters.itemGroups] - The CSV file with all new itemGroups
@@ -2384,7 +2404,7 @@ class Catalog {
    * @param {string} parameters.section - The section to update
    * @param {string} [parameters.notificationEmail] - 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 {string} [parameters.onMissing] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence. Defaults to FAIL
+   * @param {string} [parameters.onMissing="FAIL"] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence
    * @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)

package/src/types/catalog.d.ts

@@ -35,6 +35,7 @@ declare class Catalog {
       force?: boolean;
       notificationEmail?: string;
       section?: string;
+      onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
     },
     networkParameters?: NetworkParameters
   ): Promise<void>;
@@ -74,6 +75,7 @@ declare class Catalog {
       force?: boolean;
       notificationEmail?: string;
       section?: string;
+      onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
     },
     networkParameters?: NetworkParameters
   ): Promise<void>;