mcdev 4.3.3 → 5.0.0

package/lib/metadataTypes/DataExtensionField.js

@@ -18,7 +18,7 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<{metadata: TYPE.DataExtensionFieldMap, type: string}>} Promise of items
      */
     static async retrieve(retrieveDir, additionalFields) {
-        return super.retrieveSOAP(retrieveDir, null, additionalFields);
+        return super.retrieveSOAP(retrieveDir, null, null, additionalFields);
     }
     /**
      * Retrieves all records for caching
@@ -28,7 +28,7 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<{metadata: TYPE.DataExtensionFieldMap, type: string}>} Promise of items
      */
     static async retrieveForCache(requestParams, additionalFields) {
-        return super.retrieveSOAP(null, requestParams, additionalFields);
+        return super.retrieveSOAP(null, requestParams, null, additionalFields);
     }
     /**
      * helper for {@link DataExtension._retrieveFieldsForSingleDe} that sorts the fields into an array
@@ -96,7 +96,7 @@ class DataExtensionField extends MetadataType {
      *
      * @param {TYPE.DataExtensionFieldItem[]} deployColumns Columns of data extension that will be deployed
      * @param {string} deKey external/customer key of Data Extension
-     * @returns {Object.<string, TYPE.DataExtensionFieldItem>} existing fields by their original name to allow re-adding FieldType after update
+     * @returns {Promise.<Object.<string, TYPE.DataExtensionFieldItem>>} existing fields by their original name to allow re-adding FieldType after update
      */
     static async prepareDeployColumnsOnUpdate(deployColumns, deKey) {
         // get row count to know which field restrictions apply
@@ -258,17 +258,16 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return this.deleteByKeySOAP(customerKey, false);
+        return this.deleteByKeySOAP(customerKey);
     }
 
     /**
      * Delete a data extension from the specified business unit
      *
      * @param {string} customerKey Identifier of metadata
-     * @param {boolean} [handleOutside] if the API reponse is irregular this allows you to handle it outside of this generic method
      * @returns {boolean} deletion success flag
      */
-    static async deleteByKeySOAP(customerKey, handleOutside) {
+    static async deleteByKeySOAP(customerKey) {
         const [deKey, fieldKey] = customerKey.split('.');
         customerKey = `[${deKey}].[${fieldKey}]`;
 
@@ -305,22 +304,16 @@ class DataExtensionField extends MetadataType {
                 null
             );
 
-            if (!handleOutside) {
-                Util.logger.info(`- deleted ${this.definition.type}: ${customerKey}`);
-            }
+            Util.logger.info(`- deleted ${this.definition.type}: ${customerKey}`);
             this.postDeleteTasks(customerKey);
             return true;
         } catch (ex) {
-            if (handleOutside) {
-                throw ex;
-            } else {
-                const errorMsg = ex.results?.length
-                    ? `${ex.results[0].StatusMessage} (Code ${ex.results[0].ErrorCode})`
-                    : ex.message;
-                Util.logger.error(
-                    `- error deleting ${this.definition.type} '${customerKey}': ${errorMsg}`
-                );
-            }
+            const errorMsg = ex.results?.length
+                ? `${ex.results[0].StatusMessage} (Code ${ex.results[0].ErrorCode})`
+                : ex.message;
+            Util.logger.error(
+                `- error deleting ${this.definition.type} '${customerKey}': ${errorMsg}`
+            );
 
             return false;
         }

package/lib/metadataTypes/DataExtensionTemplate.js

@@ -30,7 +30,7 @@ class DataExtensionTemplate extends MetadataType {
                 },
             };
         }
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 }
 

package/lib/metadataTypes/DataExtract.js

@@ -23,7 +23,7 @@ class DataExtract extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracts/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracts/', null, key);
     }
     /**
      * Retrieves Metadata of  Data Extract Activity for caching

package/lib/metadataTypes/DataExtractType.js

@@ -21,7 +21,7 @@ class DataExtractType extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracttypes/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracttypes/', null, key);
     }
     /**
      * Retrieves Metadata of  Data Extract Type for caching.

package/lib/metadataTypes/Email.js

@@ -32,7 +32,7 @@ class Email extends MetadataType {
             };
         }
         // !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
     /**
      * Helper for writing Metadata to disk, used for Retrieve and deploy

package/lib/metadataTypes/{EmailSendDefinition.js → EmailSend.js}

@@ -10,7 +10,7 @@ const cache = require('../util/cache');
  *
  * @augments MetadataType
  */
-class EmailSendDefinition extends MetadataType {
+class EmailSend extends MetadataType {
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
@@ -52,7 +52,7 @@ class EmailSendDefinition extends MetadataType {
                 },
             };
         }
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 
     /**
@@ -82,7 +82,7 @@ class EmailSendDefinition extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return super.deleteByKeySOAP(customerKey, false);
+        return super.deleteByKeySOAP(customerKey);
     }
 
     /**
@@ -292,6 +292,6 @@ class EmailSendDefinition extends MetadataType {
 }
 
 // Assign definition to static attributes
-EmailSendDefinition.definition = require('../MetadataTypeDefinitions').emailSendDefinition;
+EmailSend.definition = require('../MetadataTypeDefinitions').emailSend;
 
-module.exports = EmailSendDefinition;
+module.exports = EmailSend;

package/lib/metadataTypes/{EventDefinition.js → Event.js}

@@ -7,11 +7,11 @@ const File = require('../util/file');
 const cache = require('../util/cache');
 
 /**
- * EventDefinition MetadataType
+ * Event MetadataType
  *
  * @augments MetadataType
  */
-class EventDefinition extends MetadataType {
+class Event extends MetadataType {
     /**
      * Retrieves Metadata of Event Definition.
      * Endpoint /interaction/v1/EventDefinitions return all Event Definitions with all details.
@@ -31,7 +31,6 @@ class EventDefinition extends MetadataType {
                 key ? '/key:' + encodeURIComponent(key) : ''
             }?extras=all`,
             null,
-            null,
             key
         );
     }
@@ -77,7 +76,7 @@ class EventDefinition extends MetadataType {
                 );
                 if (!eventDef.dataExtensionId) {
                     throw new Error(
-                        `EventDefinition.parseMetadata:: ` +
+                        `Event.parseMetadata:: ` +
                             `No Data Extension found for ` +
                             `event: ${eventDef.name}. ` +
                             `This cannot be templated`
@@ -101,7 +100,7 @@ class EventDefinition extends MetadataType {
                 );
             }
         } catch (ex) {
-            Util.logger.error('EventDefinition.retrieveAsTemplate:: ' + ex);
+            Util.logger.error('Event.retrieveAsTemplate:: ' + ex);
             return null;
         }
     }
@@ -137,21 +136,22 @@ class EventDefinition extends MetadataType {
      * @param {TYPE.MetadataTypeMap} metadata metadata mapped by their keyField
      * @param {string} deployDir directory where deploy metadata are saved
      * @param {string} retrieveDir directory where metadata after deploy should be saved
+     * @param {boolean} [isRefresh] optional flag - so far not used by eventDefinition
      * @returns {Promise.<TYPE.MetadataTypeMap>} Promise of keyField => metadata map
      */
-    static async deploy(metadata, deployDir, retrieveDir) {
+    static async deploy(metadata, deployDir, retrieveDir, isRefresh) {
         Util.logBeta(this.definition.type);
-        return super.deploy(metadata, deployDir, retrieveDir);
+        return super.deploy(metadata, deployDir, retrieveDir, isRefresh);
     }
 
     /**
      * Creates a single Event Definition
      *
-     * @param {TYPE.MetadataTypeItem} EventDefinition a single Event Definition
+     * @param {TYPE.MetadataTypeItem} metadata a single Event Definition
      * @returns {Promise} Promise
      */
-    static create(EventDefinition) {
-        return super.createREST(EventDefinition, '/interaction/v1/EventDefinitions/');
+    static create(metadata) {
+        return super.createREST(metadata, '/interaction/v1/EventDefinitions/');
     }
 
     /**
@@ -161,29 +161,11 @@ class EventDefinition extends MetadataType {
      * @returns {Promise} Promise
      */
     static async update(metadataEntry) {
-        if (metadataEntry === null || metadataEntry === undefined) {
-            return null;
-        }
-        this.removeNotUpdateableFields(metadataEntry);
-        const options = {
-            uri: '/interaction/v1/EventDefinitions/' + metadataEntry.id,
-            json: metadataEntry,
-            headers: {},
-        };
-        try {
-            const response = await this.client.rest.put(options);
-            super.checkForErrors(response);
-            return response;
-        } catch (ex) {
-            Util.metadataLogger(
-                'error',
-                this.definition.type,
-                'updateREST',
-                ex,
-                metadataEntry.name
-            );
-            return null;
-        }
+        return super.updateREST(
+            metadataEntry,
+            '/interaction/v1/EventDefinitions/' + metadataEntry.id,
+            'put'
+        );
     }
 
     /**
@@ -232,6 +214,6 @@ class EventDefinition extends MetadataType {
 }
 
 // Assign definition to static attributes
-EventDefinition.definition = require('../MetadataTypeDefinitions').eventDefinition;
+Event.definition = require('../MetadataTypeDefinitions').event;
 
-module.exports = EventDefinition;
+module.exports = Event;

package/lib/metadataTypes/{FtpLocation.js → FileLocation.js}

@@ -20,7 +20,7 @@ class FtpLocation extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/ftplocations/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/ftplocations/', null, key);
     }
 
     /**
@@ -34,6 +34,6 @@ class FtpLocation extends MetadataType {
 }
 
 // Assign definition to static attributes
-FtpLocation.definition = require('../MetadataTypeDefinitions').ftpLocation;
+FtpLocation.definition = require('../MetadataTypeDefinitions').fileLocation;
 
 module.exports = FtpLocation;

package/lib/metadataTypes/FileTransfer.js

@@ -23,7 +23,7 @@ class FileTransfer extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, key);
     }
     /**
      * Retrieves Metadata of  FileTransfer Activity for caching
@@ -124,16 +124,17 @@ class FileTransfer extends MetadataType {
      * @returns {Promise} Promise
      */
     static async preDeployTasks(metadata) {
-        if (metadata.r__ftpLocation_name) {
+        if (metadata.r__fileLocation_name) {
             metadata.fileTransferLocationId = cache.searchForField(
-                'ftpLocation',
-                metadata.r__ftpLocation_name,
+                'fileLocation',
+                metadata.r__fileLocation_name,
                 'name',
                 'id'
             );
+            delete metadata.r__fileLocation_name;
         } else {
             throw new Error(
-                'r__ftpLocation_name not set. Please ensure the source is properly set up and re-retrieve it first.'
+                'r__fileLocation_name not set. Please ensure the source is properly set up and re-retrieve it first.'
             );
         }
         return metadata;
@@ -146,8 +147,8 @@ class FileTransfer extends MetadataType {
      */
     static parseMetadata(metadata) {
         try {
-            metadata.r__ftpLocation_name = cache.searchForField(
-                'ftpLocation',
+            metadata.r__fileLocation_name = cache.searchForField(
+                'fileLocation',
                 metadata.fileTransferLocationId,
                 'id',
                 'name'

package/lib/metadataTypes/Filter.js

@@ -22,7 +22,7 @@ class Filter extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/filters/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/filters/', null, key);
     }
 }
 

package/lib/metadataTypes/Folder.js

@@ -167,6 +167,7 @@ class Folder extends MetadataType {
      * @returns {Promise.<object>} Promise of saved metadata
      */
     static async upsert(metadata) {
+        const orignalMetadata = JSON.parse(JSON.stringify(metadata));
         let updateCount = 0;
         let updateFailedCount = 0;
         let createCount = 0;
@@ -318,6 +319,10 @@ class Folder extends MetadataType {
                 ` - Folders are recognized for updates based on their CustomerKey or, if that is not given, their folder-path.`
             );
         }
+        await this.postDeployTasks(upsertResults, orignalMetadata, {
+            created: createCount,
+            updated: updateCount,
+        });
         return upsertResults;
     }
 
@@ -336,7 +341,7 @@ class Folder extends MetadataType {
         }
         const path = metadataEntry.Path;
         try {
-            const response = await super.createSOAP(metadataEntry, 'DataFolder', true);
+            const response = await super.createSOAP(metadataEntry, true);
             if (response) {
                 response.Results[0].Object = metadataEntry;
                 response.Results[0].Object.ID = response.Results[0].NewID;
@@ -368,7 +373,7 @@ class Folder extends MetadataType {
     static async update(metadataEntry) {
         const path = metadataEntry.Path;
         try {
-            const response = await super.updateSOAP(metadataEntry, 'DataFolder', true);
+            const response = await super.updateSOAP(metadataEntry, true);
             if (response) {
                 response.Results[0].Object = metadataEntry;
                 response.Results[0].Object.CustomerKey = metadataEntry.CustomerKey;
@@ -460,7 +465,7 @@ class Folder extends MetadataType {
                 // should not be in the path for the metadata. In case no split then return empty as this is root
 
                 const standardSubDir = File.reverseFilterIllegalFilenames(
-                    subdir.replace(/\\/g, '/').split(/folder\//)[1] || ''
+                    subdir.replaceAll('\\', '/').split(/folder\//)[1] || ''
                 );
                 for (const fileName of File.readdirSync(subdir)) {
                     try {

package/lib/metadataTypes/ImportFile.js

@@ -24,7 +24,7 @@ class ImportFile extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/imports/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/imports/', null, key);
     }
 
     /**
@@ -125,12 +125,12 @@ class ImportFile extends MetadataType {
      */
     static async preDeployTasks(metadata) {
         metadata.fileTransferLocationId = cache.searchForField(
-            'ftpLocation',
-            metadata.r__ftpLocation_name,
+            'fileLocation',
+            metadata.r__fileLocation_name,
             'name',
             'id'
         );
-        delete metadata.r__ftpLocation_name;
+        delete metadata.r__fileLocation_name;
 
         if (metadata.c__destinationType === 'DataExtension') {
             if (metadata.r__dataExtension_CustomerKey) {
@@ -179,8 +179,8 @@ class ImportFile extends MetadataType {
      * @returns {TYPE.MetadataTypeItem} parsed metadata definition
      */
     static parseMetadata(metadata) {
-        metadata.r__ftpLocation_name = cache.searchForField(
-            'ftpLocation',
+        metadata.r__fileLocation_name = cache.searchForField(
+            'fileLocation',
             metadata.fileTransferLocationId,
             'id',
             'name'