mcdev 5.2.0 → 6.0.0

package/lib/metadataTypes/DataExtensionField.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
 
 /**
  * DataExtensionField MetadataType
@@ -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
@@ -333,6 +350,7 @@ class DataExtensionField extends MetadataType {
 }
 
 // Assign definition to static attributes
-DataExtensionField.definition = require('../MetadataTypeDefinitions').dataExtensionField;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+DataExtensionField.definition = MetadataTypeDefinitions.dataExtensionField;
 
-module.exports = DataExtensionField;
+export default DataExtensionField;

package/lib/metadataTypes/DataExtensionTemplate.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
 
 /**
  * DataExtensionTemplate MetadataType
@@ -35,6 +35,7 @@ class DataExtensionTemplate extends MetadataType {
 }
 
 // Assign definition to static attributes
-DataExtensionTemplate.definition = require('../MetadataTypeDefinitions').dataExtensionTemplate;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+DataExtensionTemplate.definition = MetadataTypeDefinitions.dataExtensionTemplate;
 
-module.exports = DataExtensionTemplate;
+export default DataExtensionTemplate;

package/lib/metadataTypes/DataExtract.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const File = require('../util/file');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import cache from '../util/cache.js';
 
 /**
  * DataExtract MetadataType
@@ -160,6 +160,7 @@ class DataExtract extends MetadataType {
 }
 
 // Assign definition to static attributes
-DataExtract.definition = require('../MetadataTypeDefinitions').dataExtract;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+DataExtract.definition = MetadataTypeDefinitions.dataExtract;
 
-module.exports = DataExtract;
+export default DataExtract;

package/lib/metadataTypes/DataExtractType.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
 
 /**
  * DataExtractType MetadataType
@@ -34,6 +34,7 @@ class DataExtractType extends MetadataType {
 }
 
 // Assign definition to static attributes
-DataExtractType.definition = require('../MetadataTypeDefinitions').dataExtractType;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+DataExtractType.definition = MetadataTypeDefinitions.dataExtractType;
 
-module.exports = DataExtractType;
+export default DataExtractType;

package/lib/metadataTypes/Discovery.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
 
 /**
  * ImportFile MetadataType
@@ -48,6 +48,7 @@ class Discovery extends MetadataType {
 }
 
 // Assign definition to static attributes
-Discovery.definition = require('../MetadataTypeDefinitions').discovery;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Discovery.definition = MetadataTypeDefinitions.discovery;
 
-module.exports = Discovery;
+export default Discovery;

package/lib/metadataTypes/Email.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
 
 /**
  * Email MetadataType
@@ -87,6 +87,7 @@ class Email extends MetadataType {
 }
 
 // Assign definition to static attributes
-Email.definition = require('../MetadataTypeDefinitions').email;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Email.definition = MetadataTypeDefinitions.email;
 
-module.exports = Email;
+export default Email;

package/lib/metadataTypes/EmailSend.js

@@ -1,9 +1,9 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import cache from '../util/cache.js';
 
 /**
  * MessageSendActivity MetadataType
@@ -292,6 +292,7 @@ class EmailSend extends MetadataType {
 }
 
 // Assign definition to static attributes
-EmailSend.definition = require('../MetadataTypeDefinitions').emailSend;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+EmailSend.definition = MetadataTypeDefinitions.emailSend;
 
-module.exports = EmailSend;
+export default EmailSend;

package/lib/metadataTypes/Event.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const File = require('../util/file');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import cache from '../util/cache.js';
 
 /**
  * Event MetadataType
@@ -213,6 +213,7 @@ class Event extends MetadataType {
 }
 
 // Assign definition to static attributes
-Event.definition = require('../MetadataTypeDefinitions').event;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Event.definition = MetadataTypeDefinitions.event;
 
-module.exports = Event;
+export default Event;

package/lib/metadataTypes/FileLocation.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
 
 /**
  * ImportFile MetadataType
@@ -34,6 +34,7 @@ class FtpLocation extends MetadataType {
 }
 
 // Assign definition to static attributes
-FtpLocation.definition = require('../MetadataTypeDefinitions').fileLocation;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+FtpLocation.definition = MetadataTypeDefinitions.fileLocation;
 
-module.exports = FtpLocation;
+export default FtpLocation;

package/lib/metadataTypes/FileTransfer.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const File = require('../util/file');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import cache from '../util/cache.js';
 
 /**
  * FileTransfer MetadataType
@@ -165,6 +165,7 @@ class FileTransfer extends MetadataType {
 }
 
 // Assign definition to static attributes
-FileTransfer.definition = require('../MetadataTypeDefinitions').fileTransfer;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+FileTransfer.definition = MetadataTypeDefinitions.fileTransfer;
 
-module.exports = FileTransfer;
+export default FileTransfer;

package/lib/metadataTypes/Filter.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
 
 /**
  * Filter MetadataType
@@ -27,6 +27,7 @@ class Filter extends MetadataType {
 }
 
 // Assign definition to static attributes
-Filter.definition = require('../MetadataTypeDefinitions').filter;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Filter.definition = MetadataTypeDefinitions.filter;
 
-module.exports = Filter;
+export default Filter;

package/lib/metadataTypes/Folder.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const toposort = require('toposort');
-const Util = require('../util/util');
-const File = require('../util/file');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import toposort from 'toposort';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import cache from '../util/cache.js';
 
 /**
  * Folder MetadataType
@@ -629,6 +629,7 @@ class Folder extends MetadataType {
 }
 
 // Assign definition to static attributes
-Folder.definition = require('../MetadataTypeDefinitions').folder;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Folder.definition = MetadataTypeDefinitions.folder;
 
-module.exports = Folder;
+export default Folder;

package/lib/metadataTypes/ImportFile.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const File = require('../util/file');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import cache from '../util/cache.js';
 
 /**
  * ImportFile MetadataType
@@ -232,6 +232,7 @@ class ImportFile extends MetadataType {
 }
 
 // Assign definition to static attributes
-ImportFile.definition = require('../MetadataTypeDefinitions').importFile;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+ImportFile.definition = MetadataTypeDefinitions.importFile;
 
-module.exports = ImportFile;
+export default ImportFile;

package/lib/metadataTypes/Journey.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const TransactionalEmail = require('./TransactionalEmail');
-const Util = require('../util/util');
-const cache = require('../util/cache');
-const File = require('../util/file');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import TransactionalEmail from './TransactionalEmail.js';
+import { Util } from '../util/util.js';
+import cache from '../util/cache.js';
+import File from '../util/file.js';
 
 /**
  * Journey MetadataType
@@ -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.`
@@ -929,6 +936,7 @@ class Journey extends MetadataType {
 }
 
 // Assign definition to static attributes
-Journey.definition = require('../MetadataTypeDefinitions').journey;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Journey.definition = MetadataTypeDefinitions.journey;
 
-module.exports = Journey;
+export default Journey;

package/lib/metadataTypes/List.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Folder = require('./Folder');
-const Util = require('../util/util');
-const cache = require('../util/cache');
-const auth = require('../util/auth');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import Folder from './Folder.js';
+import { Util } from '../util/util.js';
+import cache from '../util/cache.js';
+import auth from '../util/auth.js';
 
 /**
  * List MetadataType
@@ -205,6 +205,7 @@ class List extends MetadataType {
     }
 }
 // Assign definition to static attributes
-List.definition = require('../MetadataTypeDefinitions').list;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+List.definition = MetadataTypeDefinitions.list;
 
-module.exports = List;
+export default List;