mcdev 7.7.1 → 7.8.0

package/lib/metadataTypes/MetadataType.js

@@ -194,7 +194,7 @@ class MetadataType {
     }
 
     /**
-     * helper for {@link MetadataType.updateREST}
+     * helper for {@link MetadataType.updateREST} and {@link MetadataType.updateSOAP}
      *
      * @param {MetadataTypeItem} metadataEntry a single metadata Entry
      * @param {object} apiResponse varies depending on the API call
@@ -1329,7 +1329,7 @@ class MetadataType {
         const soapType = this.definition.soapType || this.definition.type;
         this.removeNotUpdateableFields(metadataEntry);
         try {
-            const response = await this.client.soap.update(
+            let response = await this.client.soap.update(
                 Util.capitalizeFirstLetter(soapType),
                 metadataEntry,
                 null
@@ -1340,6 +1340,8 @@ class MetadataType {
                 );
             }
             await this._postChangeKeyTasks(metadataEntry);
+            response = await this.postUpdateTasks(metadataEntry, response);
+
             return response;
         } catch (ex) {
             this._handleSOAPErrors(ex, 'updating', metadataEntry, handleOutside);
@@ -1413,7 +1415,11 @@ class MetadataType {
                 `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})` +
                     Util.getKeysString(singleRetrieve)
             );
-            await this.runDocumentOnRetrieve(singleRetrieve, savedMetadata);
+            if (Object.keys(savedMetadata).length > 0) {
+                await this.runDocumentOnRetrieve(singleRetrieve, savedMetadata);
+            } else if (singleRetrieve) {
+                this.postDeleteTasks(singleRetrieve);
+            }
         }
         return { metadata: metadata, type: this.definition.type };
     }
@@ -1462,7 +1468,11 @@ class MetadataType {
                 `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})` +
                     Util.getKeysString(singleRetrieve)
             );
-            await this.runDocumentOnRetrieve(singleRetrieve, savedMetadata);
+            if (Object.keys(savedMetadata).length > 0) {
+                await this.runDocumentOnRetrieve(singleRetrieve, savedMetadata);
+            } else if (singleRetrieve) {
+                await this.postDeleteTasks(singleRetrieve);
+            }
         }
 
         return {
@@ -2901,6 +2911,7 @@ class MetadataType {
         );
 
         // run validation rules
+        const info = [];
         const warnings = [];
         let fixed = false;
         for (const rule of Object.keys(validationRules)) {
@@ -2909,8 +2920,25 @@ class MetadataType {
                 validationConfig[rule] !== 'off' &&
                 !this.definition.skipValidation?.[rule]
             ) {
-                const mode = Util.OPTIONS.fix ? 'fix' : validationConfig[rule];
-                const passed = await validationRules[rule].passed(mode);
+                const fixable = Object.prototype.hasOwnProperty.call(validationRules[rule], 'fix');
+                if (!fixable && validationConfig[rule] === 'fix') {
+                    // reduce from fix to error if not fixable
+                    validationConfig[rule] = 'error';
+                }
+                const mode = Util.OPTIONS.fix && fixable ? 'fix' : validationConfig[rule];
+                let passed;
+
+                try {
+                    passed = await (mode === 'fix'
+                        ? validationRules[rule].fix()
+                        : validationRules[rule].passed());
+                } catch (ex) {
+                    Util.logger.errorStack(
+                        ex,
+                        `Error while running validation rule ${rule} (check log file for details!)`
+                    );
+                    continue;
+                }
                 if (mode === 'fix') {
                     // potentially fixed really
                     fixed = true;
@@ -2918,12 +2946,14 @@ class MetadataType {
                 if (!passed) {
                     if (mode === 'fix') {
                         if (passed === false) {
-                            warnings.push(validationRules[rule].failedMsg);
+                            info.push('😎 auto-fixed: ' + validationRules[rule].failedMsg);
                         } else if (passed === null) {
                             // ensure this item no longer exists outside of the validation rule
                             item = null;
-                            warnings.push(
-                                ` ☇ filtered item via validation rule fix: ` +
+                            warnings.length = 0;
+                            info.length = 0;
+                            info.push(
+                                `🚫 ☇ filtered item via validation rule fix: ` +
                                     validationRules[rule].failedMsg
                             );
                             break;
@@ -2943,6 +2973,12 @@ class MetadataType {
                 }
             }
         }
+        if (info.length) {
+            Util.logger.info(
+                Util.getMsgPrefix(this.definition, metadataItem) +
+                    `:${info.length > 1 ? '\n        ·' : ''} ${info.join('\n        · ')}`
+            );
+        }
         if (warnings.length) {
             Util.logger.warn(
                 Util.getMsgPrefix(this.definition, metadataItem) +

package/lib/metadataTypes/MobileKeyword.js

@@ -51,6 +51,7 @@ class MobileKeyword extends MetadataType {
                 Util.logger.info(
                     `Downloaded: ${this.definition.type} (0)${Util.getKeysString(key)}`
                 );
+                this.postDeleteTasks(key);
             } else {
                 throw ex;
             }

package/lib/metadataTypes/MobileMessage.js

@@ -53,6 +53,7 @@ class MobileMessage extends MetadataType {
                 Util.logger.info(
                     `Downloaded: ${this.definition.type} (0)${Util.getKeysString(key)}`
                 );
+                this.postDeleteTasks(key);
             } else {
                 throw ex;
             }

package/lib/metadataTypes/TransactionalMessage.js

@@ -72,6 +72,9 @@ class TransactionalMessage extends MetadataType {
                 `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})` +
                     Util.getKeysString(key)
             );
+            if (!Object.keys(savedMetadata).length && key) {
+                this.postDeleteTasks(key);
+            }
         }
 
         return { metadata: savedMetadata || parsed, type: this.definition.type };

package/lib/metadataTypes/definitions/Asset.definition.js

@@ -19,6 +19,7 @@ export default {
     type: 'asset',
     typeDescription: 'Assets from Content Builder grouped into subtypes.',
     typeRetrieveByDefault: ['asset', 'code', 'textfile', 'block', 'message', 'template', 'other'],
+    typeCdpByDefault: true,
     typeName: 'Asset-[Subtype]',
     stringifyFieldsBeforeTemplate: ['memberId', 'enterpriseId'],
     allowMatchingByName: true,

package/lib/metadataTypes/definitions/AttributeGroup.definition.js

@@ -11,6 +11,7 @@ export default {
     type: 'attributeGroup',
     typeDescription: 'Groupings of Attribute Sets (Data Extensions) in Data Designer.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'Data Designer Attribute Groups',
     fields: {
         applicationID: {

package/lib/metadataTypes/definitions/AttributeSet.definition.js

@@ -35,6 +35,7 @@ export default {
     type: 'attributeSet',
     typeDescription: 'Data Extensions linked together in Attribute Groups in Data Designer.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'Data Designer Attribute Sets',
     fields: {
         applicationID: {

package/lib/metadataTypes/definitions/Automation.definition.js

@@ -276,6 +276,7 @@ export default {
     typeDescription:
         'Used via Automation Studio directly - or indirectly via Journey Builder & MC Connect.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation',
     customDeployTypes: ['wait'],
     manualDeployTypes: [],

package/lib/metadataTypes/definitions/Campaign.definition.js

@@ -17,6 +17,7 @@ export default {
     type: 'campaign',
     typeDescription: 'Way of tagging/categorizing emails, journeys and alike.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Campaign Tag',
     fields: {
         id: {

package/lib/metadataTypes/definitions/ContentArea.definition.js

@@ -14,6 +14,7 @@ export default {
     typeDescription:
         'DEPRECATED: Old way of saving Content Blocks; please migrate these to new Content Blocks (`Asset: ...`).',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Content Area (Classic)',
     fields: {
         // https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/contentarea.htm

package/lib/metadataTypes/definitions/DataExtension.definition.js

@@ -108,6 +108,7 @@ export default {
     type: 'dataExtension',
     typeDescription: 'Database table schemas.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Data Extension',
     fields: {
         CategoryID: {

package/lib/metadataTypes/definitions/DataExtensionField.definition.js

@@ -12,6 +12,7 @@ export default {
     type: 'dataExtensionField',
     typeDescription: 'Internal Type: Fields for type dataExtension.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Data Extension Field',
     fields: {
         'Client.ID': {

package/lib/metadataTypes/definitions/DataExtensionTemplate.definition.js

@@ -12,6 +12,7 @@ export default {
     type: 'dataExtensionTemplate',
     typeDescription: 'Templates used for special DE use cases like Triggered Send.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Data Extension Template',
     fields: {
         'Client.ID': {

package/lib/metadataTypes/definitions/DataExtract.definition.js

@@ -16,6 +16,7 @@ export default {
     type: 'dataExtract',
     typeDescription: 'Creates zipped files in your FTP directory or convert XML into CSV.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation: Data Extract Activity',
     fields: {
         createdBy: {

package/lib/metadataTypes/definitions/DataExtractType.definition.js

@@ -12,6 +12,7 @@ export default {
     typeDescription:
         'Types of Data Extracts enabled for a specific business unit. This normally should not be stored.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Data Extract Type',
     fields: {
         name: {

package/lib/metadataTypes/definitions/DeliveryProfile.definition.js

@@ -18,6 +18,7 @@ export default {
     typeDescription:
         'Delivery profiles specify details such as IP address, domain, header inclusion, and footer; Via API we can only check for their existence but not see any details.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Delivery Profile',
     fields: {
         id: {

package/lib/metadataTypes/definitions/Discovery.definition.js

@@ -35,6 +35,7 @@ export default {
     typeDescription:
         'Description of all API endpoints accessible via REST API; only relevant for developers of Accenture SFMC DevTools.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'API Discovery',
     fields: {
         basePath: {

package/lib/metadataTypes/definitions/DomainVerification.definition.js

@@ -16,6 +16,7 @@ export default {
     type: 'domainVerification',
     typeDescription: 'Domains emails that are verified for sending',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'Domain Verification',
     fields: {
         domain: {

package/lib/metadataTypes/definitions/Email.definition.js

@@ -14,6 +14,7 @@ export default {
     typeDescription:
         'DEPRECATED: Old way of saving E-Mails; please migrate these to new E-Mail (`Asset: message`).',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'E-Mail (Classic)',
     fields: {
         CategoryID: {

package/lib/metadataTypes/definitions/EmailSend.definition.js

@@ -36,6 +36,7 @@ export default {
     soapType: 'emailSendDefinition',
     typeDescription: 'Mainly used in Automations as "Send Email Activity".',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'E-Mail Send Definition',
     fields: {
         Additional: {

package/lib/metadataTypes/definitions/Event.definition.js

@@ -16,6 +16,7 @@ export default {
     type: 'event',
     typeDescription: 'Used in Journeys (Interactions) to define Entry Events.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Journey: Entry Event Definition',
     validTypes: [
         'EmailAudience', // category: Audience; DEAudience-...

package/lib/metadataTypes/definitions/FileLocation.definition.js

@@ -16,6 +16,7 @@ export default {
     typeDescription:
         'Used for export or import of files to/from Marketing Cloud. Previously this was labeled ftpLocation.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'File Location',
     locationTypeMapping: {
         'Enhanced FTP Site Import Directory': 0,

package/lib/metadataTypes/definitions/FileTransfer.definition.js

@@ -19,6 +19,7 @@ export default {
     typeDescription:
         'Unzip, decrypt a file or move a file from secure location into FTP directory.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation: File Transfer Activity',
     fields: {
         createdDate: {

package/lib/metadataTypes/definitions/Filter.definition.js

@@ -17,6 +17,7 @@ export default {
     typeDescription:
         'BETA: Part of how filtered Data Extensions are created. Depends on type "FilterDefinitions".',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: true,
     typeName: 'Automation: Filter Activity',
     fields: {
         categoryId: {

package/lib/metadataTypes/definitions/Folder.definition.js

@@ -86,6 +86,7 @@ export default {
     soapType: 'DataFolder',
     typeDescription: 'Used to structure all kinds of other metadata.',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     typeName: 'Folder',
     fields: {
         $: {

package/lib/metadataTypes/definitions/ImportFile.definition.js

@@ -33,6 +33,7 @@ export default {
     type: 'importFile',
     typeDescription: 'Reads files in FTP directory for further processing.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation: Import File Activity',
     updateTypeMapping: {
         Add: 1,

package/lib/metadataTypes/definitions/Journey.definition.js

@@ -64,6 +64,7 @@ export default {
     type: 'journey',
     typeDescription: 'Journey (internally called "Interaction").',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Journey',
     priorityMapping: {
         High: 3,

package/lib/metadataTypes/definitions/List.definition.js

@@ -12,6 +12,7 @@ export default {
     type: 'list',
     typeDescription: 'Old way of storing data. Still used for central Email Subscriber DB.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'List',
     fields: {
         'AutomatedEmail.ID': {

package/lib/metadataTypes/definitions/MobileCode.definition.js

@@ -16,6 +16,7 @@ export default {
     type: 'mobileCode',
     typeDescription: 'Used to send SMS Messages',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Mobile Code',
     fields: {
         id: {

package/lib/metadataTypes/definitions/MobileKeyword.definition.js

@@ -17,6 +17,7 @@ export default {
     type: 'mobileKeyword',
     typeDescription: 'Used for managing subscriptions for Mobile numbers in Mobile Connect',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Mobile Keyword',
     fields: {
         id: {

package/lib/metadataTypes/definitions/MobileMessage.definition.js

@@ -26,6 +26,7 @@ export default {
     typeDescription:
         'Used by Journey Builder and to send SMS from MobileConnect triggered by API or manually on-the-fly',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'MobileConnect SMS',
     fields: {
         allowSingleOptin: {

package/lib/metadataTypes/definitions/Query.definition.js

@@ -28,6 +28,7 @@ export default {
     type: 'query',
     typeDescription: 'Select & transform data using SQL.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation: SQL Query Activity',
     fields: {
         categoryId: {

package/lib/metadataTypes/definitions/Role.definition.js

@@ -29,6 +29,7 @@ export default {
     typeDescription:
         'User Roles define groups that are used to grant users access to SFMC systems.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'Role',
     fields: {
         CreatedDate: {

package/lib/metadataTypes/definitions/Script.definition.js

@@ -17,6 +17,7 @@ export default {
     type: 'script',
     typeDescription: 'Execute more complex tasks via SSJS or AMPScript.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation: Script Activity',
     fields: {
         categoryId: {

package/lib/metadataTypes/definitions/SendClassification.definition.js

@@ -22,6 +22,7 @@ export default {
     typeDescription:
         'Lets admins define Delivery Profile, Sender Profile and CAN-SPAM for an email job in a central location.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Send Classification',
     sendClassificationTypeMapping: {
         Commercial: 'Marketing',

package/lib/metadataTypes/definitions/SenderProfile.definition.js

@@ -17,6 +17,7 @@ export default {
     type: 'senderProfile',
     typeDescription: 'Specifies the From information for a send in a central location',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Sender Profile',
     fields: {
         'Client.ID': {

package/lib/metadataTypes/definitions/TransactionalEmail.definition.js

@@ -24,6 +24,7 @@ export default {
     type: 'transactionalEmail',
     typeDescription: 'Lets you send immediate Email messages via API events',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: false,
     typeName: 'Transactional Email',
     fields: {
         name: {

package/lib/metadataTypes/definitions/TransactionalMessage.definition.js

@@ -16,6 +16,7 @@ export default {
     type: '',
     typeDescription: 'here as a placeholder to have auto completion',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: true,
     typeName: '',
     fields: {
         name: {

package/lib/metadataTypes/definitions/TransactionalPush.definition.js

@@ -18,6 +18,7 @@ export default {
     type: 'transactionalPush',
     typeDescription: 'Lets you send immediate Push messages via API events',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Transactional Push',
     fields: {
         name: {

package/lib/metadataTypes/definitions/TransactionalSMS.definition.js

@@ -19,6 +19,7 @@ export default {
     type: 'transactionalSMS',
     typeDescription: 'Lets you send immediate SMS messages via API events',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Transactional SMS',
     fields: {
         name: {

package/lib/metadataTypes/definitions/TriggeredSend.definition.js

@@ -41,6 +41,7 @@ export default {
     soapType: 'triggeredSendDefinition',
     typeDescription: 'DEPRECATED: Sends emails via API or DataExtension Event.',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Triggered Send',
     priorityMapping: {
         High: 3,

package/lib/metadataTypes/definitions/User.definition.js

@@ -21,6 +21,7 @@ export default {
     typeDescription: 'Marketing Cloud users',
     typeName: 'User',
     typeRetrieveByDefault: false,
+    typeCdpByDefault: false,
     documentInOneFile: true,
     stringifyFieldsBeforeTemplate: ['DefaultBusinessUnit', 'c__AssociatedBusinessUnits'],
     fields: {

package/lib/metadataTypes/definitions/Verification.definition.js

@@ -16,6 +16,7 @@ export default {
     type: 'verification',
     typeDescription: 'Check DataExtension for a row count',
     typeRetrieveByDefault: true,
+    typeCdpByDefault: true,
     typeName: 'Automation: Verification Activity',
     fields: {
         createdBy: {

package/lib/util/config.js

@@ -322,7 +322,9 @@ const config = {
         // set default name for parent BU
         defaultProperties.credentials.default.businessUnits[Util.parentBuName] = 0;
         // set default retrieve values
-        defaultProperties.metaDataTypes.retrieve = Util.getRetrieveTypeChoices();
+        defaultProperties.metaDataTypes.retrieve = Util.getTypeChoices('typeRetrieveByDefault');
+        // set default retrieve values
+        defaultProperties.metaDataTypes.createDeltaPkg = Util.getTypeChoices('typeCdpByDefault');
 
         return defaultProperties;
     },