mcdev 5.1.0 → 5.3.0

package/lib/metadataTypes/DataExtensionField.js

@@ -31,7 +31,7 @@ class DataExtensionField extends MetadataType {
         return super.retrieveSOAP(null, requestParams, null, additionalFields);
     }
     /**
-     * helper for {@link DataExtension._retrieveFieldsForSingleDe} that sorts the fields into an array
+     * helper for DataExtension.retrieveFieldsForSingleDe that sorts the fields into an array
      *
      * @param {TYPE.DataExtensionFieldMap} fieldsObj customerKey-based list of fields for one dataExtension
      * @returns {TYPE.DataExtensionFieldItem[]} sorted array of field objects
@@ -99,6 +99,10 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<Object.<string, TYPE.DataExtensionFieldItem>>} existing fields by their original name to allow re-adding FieldType after update
      */
     static async prepareDeployColumnsOnUpdate(deployColumns, deKey) {
+        // create list of DE keys that had changes to their fields to be able to use it as a filter in the --fixShared logic
+        this.fixShared_fields ||= {};
+        this.fixShared_fields[deKey] ||= {};
+
         // get row count to know which field restrictions apply
         let hasData = false;
         try {
@@ -184,6 +188,10 @@ class DataExtensionField extends MetadataType {
                         changeFound = true;
                     }
                 }
+                // share fields with fixShared logic
+                this.fixShared_fields[deKey][item.Name] = JSON.parse(JSON.stringify(item));
+                this.fixShared_fields[deKey][item.Name].FieldType = itemOld.FieldType;
+
                 if (!changeFound) {
                     deployColumns.splice(i, 1);
                     Util.logger.verbose(`no change - removed field [${deKey}].[${item.Name}]`);
@@ -217,6 +225,8 @@ class DataExtensionField extends MetadataType {
                 }
                 // Field doesn't exist in target, therefore Remove ObjectID if present
                 delete item.ObjectID;
+
+                this.fixShared_fields[deKey][item.Name] = JSON.parse(JSON.stringify(item));
             }
             if (Util.isTrue(item.IsPrimaryKey) && Util.isFalse(item.IsRequired)) {
                 // applicable: with or without data
@@ -248,6 +258,7 @@ class DataExtensionField extends MetadataType {
                 }` + deployColumns.map((item) => item.Name).join(', ')
             )
         );
+
         return existingFieldByName;
     }
 
@@ -265,24 +276,28 @@ class DataExtensionField extends MetadataType {
      * Delete a data extension from the specified business unit
      *
      * @param {string} customerKey Identifier of metadata
+     * @param {string} [fieldId] for programmatic deletes only one can pass in the ID directly
      * @returns {boolean} deletion success flag
      */
-    static async deleteByKeySOAP(customerKey) {
+    static async deleteByKeySOAP(customerKey, fieldId) {
         const [deKey, fieldKey] = customerKey.split('.');
         customerKey = `[${deKey}].[${fieldKey}]`;
 
+        let fieldObjectID = fieldId;
         // get the object id
-        const response = await this.retrieveForCache(
-            {
-                filter: {
-                    leftOperand: 'CustomerKey',
-                    operator: 'equals',
-                    rightOperand: customerKey,
+        if (!fieldObjectID) {
+            const response = await this.retrieveForCache(
+                {
+                    filter: {
+                        leftOperand: 'CustomerKey',
+                        operator: 'equals',
+                        rightOperand: customerKey,
+                    },
                 },
-            },
-            ['Name', 'ObjectID']
-        );
-        const fieldObjectID = response.metadata[customerKey].ObjectID;
+                ['Name', 'ObjectID']
+            );
+            fieldObjectID = response.metadata[customerKey]?.ObjectID;
+        }
         if (!fieldObjectID) {
             Util.logger.error(`Could not find ${customerKey} on your BU`);
             return false;
@@ -304,8 +319,10 @@ class DataExtensionField extends MetadataType {
                 null
             );
 
-            Util.logger.info(`- deleted ${this.definition.type}: ${customerKey}`);
-            this.postDeleteTasks(customerKey);
+            if (!fieldId) {
+                Util.logger.info(` - deleted ${this.definition.type}: ${customerKey}`);
+                this.postDeleteTasks(customerKey);
+            }
             return true;
         } catch (ex) {
             const errorMsg = ex.results?.length

package/lib/metadataTypes/Event.js

@@ -136,12 +136,11 @@ class Event 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, isRefresh) {
+    static async deploy(metadata, deployDir, retrieveDir) {
         Util.logBeta(this.definition.type);
-        return super.deploy(metadata, deployDir, retrieveDir, isRefresh);
+        return super.deploy(metadata, deployDir, retrieveDir);
     }
 
     /**

package/lib/metadataTypes/Folder.js

@@ -452,7 +452,7 @@ class Folder extends MetadataType {
      * Returns file contents mapped to their filename without '.json' ending
      *
      * @param {string} dir directory that contains '.json' files to be read
-     * @param {boolean} [listBadKeys=false] do not print errors, used for badKeys()
+     * @param {boolean} [listBadKeys] do not print errors, used for badKeys()
      * @returns {TYPE.MetadataTypeMap} fileName => fileContent map
      */
     static getJsonFromFS(dir, listBadKeys) {

package/lib/metadataTypes/Journey.js

@@ -191,14 +191,21 @@ class Journey extends MetadataType {
             );
             const results = this.parseResponseBody(response, key);
             singleKey = results[key].id;
+            if (version && version > results[key].version) {
+                Util.logger.error(
+                    `The chosen version (${version}) is higher than the latest known version (${results[key].version}). Please choose a lower version.`
+                );
+                return false;
+            }
             Util.logger.debug(`Deleting interaction ${key} via its ID ${singleKey}`);
         }
         if (!/^\d+$/.test(version)) {
-            throw new TypeError(
+            Util.logger.error(
                 'Version is required for deleting interactions to avoid accidental deletion of the wrong item. Please append it at the end of the key or id, separated by forward-slash. Example for deleting version 4: ' +
                     key +
                     '/4'
             );
+            return false;
         }
         Util.logger.warn(
             `Deleting Journeys via this command breaks following retrieve-by-key/id requests until you've deployed/created a new draft version! You can get still get the latest available version of your journey by retrieving all interactions on this BU.`
@@ -216,12 +223,11 @@ class Journey 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 interaction
      * @returns {Promise.<TYPE.MetadataTypeMap>} Promise of keyField => metadata map
      */
-    static async deploy(metadata, deployDir, retrieveDir, isRefresh) {
+    static async deploy(metadata, deployDir, retrieveDir) {
         Util.logBeta(this.definition.type);
-        return super.deploy(metadata, deployDir, retrieveDir, isRefresh);
+        return super.deploy(metadata, deployDir, retrieveDir);
     }
 
     /**
@@ -265,7 +271,7 @@ class Journey extends MetadataType {
     }
 
     /**
-     * helper for Journey's {@link saveResults}. Gets executed after retreive of metadata type and
+     * helper for Journey's {@link Journey.saveResults}. Gets executed after retreive of metadata type and
      *
      * @param {TYPE.MetadataTypeMap} metadataMap key=customer key, value=metadata
      */
@@ -478,7 +484,7 @@ class Journey extends MetadataType {
         return metadata;
     }
     /**
-     * helper for {@link postRetrieveTasks}
+     * helper for {@link Journey.postRetrieveTasks}
      *
      * @private
      * @param {TYPE.MetadataTypeItem} metadata a single item
@@ -800,7 +806,7 @@ class Journey extends MetadataType {
     }
 
     /**
-     * helper for {@link preDeployTasks}
+     * helper for {@link Journey.preDeployTasks}
      *
      * @private
      * @param {TYPE.MetadataTypeItem} metadata a single item