@constructor-io/constructorio-node 4.4.6 → 4.4.7

package/package.json

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

package/src/modules/catalog.js

@@ -55,7 +55,7 @@ async function createQueryParamsAndFormData(parameters) {
   const formData = new FormData();
 
   if (parameters) {
-    const { section, notificationEmail, force } = parameters;
+    const { section, notificationEmail, force, onMissing } = parameters;
     let { items, variations, item_groups: itemGroups } = parameters;
 
     try {
@@ -92,6 +92,16 @@ async function createQueryParamsAndFormData(parameters) {
       queryParams.force = force;
     }
 
+    // Pull onMissing from parameters
+    if (onMissing) {
+      // Validate onMissing parameter
+      if (onMissing && !['FAIL', 'IGNORE', 'CREATE'].includes(onMissing)) {
+        throw new Error('onMissing must be one of FAIL, IGNORE, or CREATE');
+      }
+
+      queryParams.on_missing = onMissing;
+    }
+
     // Pull items from parameters
     if (items) {
       formData.append('items', items, {
@@ -119,9 +129,15 @@ async function createQueryParamsAndFormData(parameters) {
 
 async function addTarArchiveToFormData(parameters, formData, operation, apiKey) {
   try {
-    const { section } = parameters;
+    const { section, onMissing } = parameters;
+    const onMissingParameter = onMissing && onMissing !== 'FAIL' ? onMissing.toLowerCase() : '';
     let { tarArchive } = parameters;
 
+    // Validate onMissing parameter
+    if (onMissing && !['FAIL', 'IGNORE', 'CREATE'].includes(onMissing)) {
+      throw new Error('onMissing must be one of FAIL, IGNORE, or CREATE');
+    }
+
     // Convert tarArchive to buffer if passed as stream
     if (tarArchive instanceof fs.ReadStream || tarArchive instanceof Duplex) {
       tarArchive = await convertToBuffer(tarArchive);
@@ -135,7 +151,7 @@ async function addTarArchiveToFormData(parameters, formData, operation, apiKey)
         .replace('T', '-')
         .replace(/:/g, '-')
         .slice(0, 19);
-      const filename = `${apiKey}_${section}_${operation}_${formattedDateTime}.tar.gz`;
+      const filename = `${apiKey}_${section}_${operation}${onMissingParameter}_${formattedDateTime}.tar.gz`;
 
       formData.append(filename, tarArchive, {
         filename,
@@ -2087,7 +2103,7 @@ class Catalog {
    * @function replaceCatalog
    * @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 {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 {file} [parameters.items] - The CSV file with all new items
    * @param {file} [parameters.variations] - The CSV file with all new variations
@@ -2139,7 +2155,7 @@ class Catalog {
    * @function updateCatalog
    * @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 {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 {file} [parameters.items] - The CSV file with all new items
    * @param {file} [parameters.variations] - The CSV file with all new variations
@@ -2191,8 +2207,9 @@ class Catalog {
    * @function patchCatalog
    * @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 {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 {file} [parameters.items] - The CSV file with all new items
    * @param {file} [parameters.variations] - The CSV file with all new variations
    * @param {file} [parameters.item_groups] - The CSV file with all new item_groups
@@ -2243,7 +2260,7 @@ class 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 {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 {file} [parameters.tarArchive] - The tar file that includes csv files
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -2292,7 +2309,7 @@ class 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 {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 {file} [parameters.tarArchive] - The tar file that includes csv files
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -2342,8 +2359,9 @@ class 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 {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 {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)
@@ -2363,7 +2381,7 @@ class Catalog {
       const controller = new AbortController();
       const { signal } = controller;
       const { queryParams, formData } = await createQueryParamsAndFormData(parameters);
-      const formDataWithTarArchive = await addTarArchiveToFormData(parameters, formData, 'delta', apiKey);
+      const formDataWithTarArchive = await addTarArchiveToFormData(parameters, formData, 'patchdelta', apiKey);
       const requestUrl = createCatalogUrl('catalog', this.options, { ...queryParams, patch_delta: true });
 
       // Handle network timeout if specified

package/src/types/catalog.d.ts

@@ -364,6 +364,7 @@ declare class Catalog {
       section: string;
       notification_email?: string;
       force?: boolean;
+      onMissing?: 'IGNORE' | 'CREATE' | 'FAIL';
       items?: File;
       variations?: File;
       item_groups?: File;