mcdev 7.6.3 → 7.7.1

package/lib/metadataTypes/SenderProfile.js

@@ -1,6 +1,8 @@
 'use strict';
 
 import MetadataType from './MetadataType.js';
+import File from '../util/file.js';
+import DomainVerification from './DomainVerification.js';
 import cache from '../util/cache.js';
 import { Util } from '../util/util.js';
 import ReplaceCbReference from '../util/replaceContentBlockReference.js';
@@ -119,9 +121,56 @@ class SenderProfile extends MetadataType {
 
             delete metadata.Client;
         }
+
+        // check if email address is verified. Otherwise this SenderProfile (and Send Classifications using it) will not be usable in Journey Builder
+        this.verifySenderEmailAddresses(metadata);
+
         return metadata;
     }
 
+    /**
+     *
+     * @param {MetadataTypeItem} metadata a single item
+     * @param {MetadataTypeItem} [metadataCaller] if called from SendClassification this can be used to adjust logs
+     * @param {any} [definition] type defintiion from SendClassification
+     */
+    static verifySenderEmailAddresses(metadata, metadataCaller, definition) {
+        if (!metadataCaller) {
+            metadataCaller = metadata;
+        }
+        if (!definition) {
+            definition = this.definition;
+        }
+        const emailsToCheck = {
+            FromAddress: metadata.FromAddress.trim() + '',
+            FallbackFromAddress: metadata.FallbackFromAddress.trim() + '',
+        };
+        for (const [field, email] of Object.entries(emailsToCheck)) {
+            if (email && !email.startsWith('%%') && email.includes('@')) {
+                const domainVerification = cache.getByKey('domainVerification', email);
+                if (domainVerification) {
+                    if (domainVerification.status !== 'Verified') {
+                        Util.logger.warn(
+                            Util.getMsgPrefix(definition, metadataCaller) +
+                                `: ${field} ${email} is currently in status ${domainVerification.status}. This ${definition.typeName} will not be usable in Journey Builder. To fix, please go to Setup > Feature Settings > Email Studio > From Address Management to verify the email.`
+                        );
+                    }
+                    if (domainVerification.isSendable === false) {
+                        Util.logger.warn(
+                            Util.getMsgPrefix(definition, metadataCaller) +
+                                `: ${field} ${email} is currently not sendable. This ${definition.typeName} will not be usable in Journey Builder. To auto-fix run any update on senderProfile:"${metadata[this.definition.keyField]}" via mcdev.`
+                        );
+                    }
+                } else {
+                    Util.logger.warn(
+                        Util.getMsgPrefix(definition, metadataCaller) +
+                            `: ${field} ${email} is not verified. This ${definition.typeName} will not be usable in Journey Builder. To auto-fix run any update on senderProfile:"${metadata[this.definition.keyField]}" via mcdev. Alternatively, please go to Setup > Feature Settings > Email Studio > From Address Management.`
+                    );
+                }
+            }
+        }
+    }
+
     /**
      * prepares a single item for deployment
      *
@@ -138,9 +187,8 @@ class SenderProfile extends MetadataType {
             (metadata.AutoForwardToEmailAddress !== '' || metadata.AutoForwardToName !== '')
         ) {
             Util.logger.warn(
-                ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
-                    metadata[this.definition.keyField]
-                }): AutoForwardToEmailAddress and AutoForwardToName will be ignored because UseDefaultRMMRules is set to true; setting UseDefaultRMMRules to false`
+                Util.getMsgPrefix(this.definition, metadata) +
+                    `AutoForwardToEmailAddress and AutoForwardToName will be ignored because UseDefaultRMMRules is set to true; setting UseDefaultRMMRules to false`
             );
             metadata.UseDefaultRMMRules = false;
         }
@@ -173,12 +221,63 @@ class SenderProfile extends MetadataType {
         Util.logger.debug(
             `Caching all ${this.definition.type} post-deploy to ensure we have all fields`
         );
+        const domainVerificationEmails = new Set();
+
         const typeCache = await this.retrieveForCache();
         // update values in upsertResults with retrieved values before saving to disk
         for (const key of Object.keys(upsertResults)) {
             if (typeCache.metadata[key]) {
                 upsertResults[key] = typeCache.metadata[key];
             }
+
+            // ensure the FromAddress is verified or else attempt to create it
+            const emailsToCheck = [
+                upsertResults[key].FromAddress.trim() + '',
+                upsertResults[key].FallbackFromAddress.trim() + '',
+            ];
+
+            for (const email of emailsToCheck) {
+                if (email && !email.startsWith('%%') && email.includes('@')) {
+                    const domainVerification = cache.getByKey('domainVerification', email);
+                    if (!domainVerification) {
+                        domainVerificationEmails.add(email);
+                    }
+                }
+            }
+        }
+
+        if (domainVerificationEmails.size) {
+            Util.logger.info(
+                Util.getGrayMsg(`Setting up required E-Mail Addresses for Sender Profiles:`)
+            );
+
+            const domainVerificationCreateMap = {};
+            for (const email of domainVerificationEmails) {
+                domainVerificationCreateMap[email] = {
+                    domain: email,
+                    isSendable: true,
+                };
+            }
+
+            const deployDir = File.normalizePath([
+                this.properties.directories.deploy,
+                this.buObject.credential,
+                this.buObject.businessUnit,
+            ]);
+            const retrieveDir = File.normalizePath([
+                this.properties.directories.retrieve,
+                this.buObject.credential,
+                this.buObject.businessUnit,
+            ]);
+            DomainVerification.buObject = this.buObject;
+            DomainVerification.client = this.client;
+            DomainVerification.properties = this.properties;
+            const domainVerificationCreateResult = await DomainVerification.deploy(
+                domainVerificationCreateMap,
+                deployDir,
+                retrieveDir
+            );
+            cache.mergeMetadata('domainVerification', domainVerificationCreateResult);
         }
     }
 

package/lib/metadataTypes/TransactionalEmail.js

@@ -129,7 +129,7 @@ class TransactionalEmail extends TransactionalMessage {
      *
      * @param {MetadataTypeItem} _ not used
      * @param {object} apiResponse varies depending on the API call
-     * @returns {Promise.<void>} -
+     * @returns {Promise.<object>} apiResponse
      */
     static async postCreateTasks(_, apiResponse) {
         if (apiResponse.journey?.interactionKey) {
@@ -144,6 +144,8 @@ class TransactionalEmail extends TransactionalMessage {
             apiResponse.r__journey_key = apiResponse.journey.interactionKey;
             delete apiResponse.journey;
         }
+
+        return apiResponse;
     }
 
     /**

package/lib/metadataTypes/Verification.js

@@ -155,7 +155,7 @@ class Verification extends MetadataType {
      * @param {MetadataTypeItem} metadataEntry a single metadata Entry
      * @param {object} apiResponse varies depending on the API call
      * @param {MetadataTypeItem} metadataEntryWithAllFields like metadataEntry but before non-creatable fields were stripped
-     * @returns {Promise.<void>} -
+     * @returns {Promise.<object>} apiResponse
      */
     static async postCreateTasks(metadataEntry, apiResponse, metadataEntryWithAllFields) {
         if (!apiResponse?.[this.definition.idField]) {
@@ -178,6 +178,8 @@ class Verification extends MetadataType {
         Automation.createdKeyMap[buName][this.definition.type][
             metadataEntryWithAllFields[this.definition.idField]
         ] = metadataEntry[this.definition.idField];
+
+        return apiResponse;
     }
 
     /**

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

@@ -0,0 +1,71 @@
+export default {
+    bodyIteratorField: 'items',
+    dependencies: [],
+    dependencyGraph: null,
+    hasExtended: false,
+    idField: 'domain',
+    keyIsFixed: true, // you can only change the "isSendable" property
+    keyField: 'domain',
+    createdDateField: null,
+    createdNameField: null,
+    lastmodDateField: null,
+    lastmodNameField: null,
+    nameField: 'domain',
+    restPagination: true,
+    maxKeyLength: 254, // assumed max length
+    type: 'domainVerification',
+    typeDescription: 'Domains emails that are verified for sending',
+    typeRetrieveByDefault: true,
+    typeName: 'Domain Verification',
+    fields: {
+        domain: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        emailAddress: {
+            // this is the same as domain, but the update API uses this field name instead
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        enterpriseId: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        memberId: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        domainType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        isSendable: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        status: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        emailSendTime: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+    },
+};

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

@@ -358,7 +358,7 @@ export default {
             retrieving: true,
             template: true,
         },
-        ' activities[].configurationArguments.triggeredSend.sendClassificationId': {
+        'activities[].configurationArguments.triggeredSend.sendClassificationId': {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
@@ -990,6 +990,12 @@ export default {
             retrieving: true,
             template: true,
         },
+        'triggers[].metaData.scheduleState': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         version: {
             isCreateable: false,
             isUpdateable: true,

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

@@ -1,7 +1,7 @@
 // https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/sendclassification.html
 export default {
     bodyIteratorField: 'Results',
-    dependencies: ['senderProfile', 'deliveryProfile'],
+    dependencies: ['senderProfile', 'deliveryProfile', 'domainVerification'],
     dependencyGraph: {
         senderProfile: ['r__senderProfile_key'],
         // deliveryProfile: ['r__deliveryProfile_key'], // deliveryProfile cannot be deployed
@@ -21,7 +21,7 @@ export default {
     type: 'sendClassification',
     typeDescription:
         'Lets admins define Delivery Profile, Sender Profile and CAN-SPAM for an email job in a central location.',
-    typeRetrieveByDefault: false,
+    typeRetrieveByDefault: true,
     typeName: 'Send Classification',
     sendClassificationTypeMapping: {
         Commercial: 'Marketing',

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

@@ -1,6 +1,6 @@
 export default {
     bodyIteratorField: 'Results',
-    dependencies: ['user'],
+    dependencies: ['user', 'domainVerification'],
     dependencyGraph: null,
     filter: {},
     hasExtended: false,

package/lib/util/config.js

@@ -46,6 +46,9 @@ const config = {
         if (await File.pathExists(Util.configFileName)) {
             try {
                 config.properties = await File.readJSON(Util.configFileName);
+                if (!isInit && !(await this.checkProperties(config.properties, silent))) {
+                    return;
+                }
             } catch (ex) {
                 Util.logger.error(`${ex.code}: ${ex.message}`);
                 return;
@@ -94,6 +97,9 @@ const config = {
                 );
                 return;
             }
+        } else if (!silent && !isInit) {
+            Util.logger.error(`Could not find ${Util.configFileName} in ${process.cwd()}.`);
+            Util.logger.error(`Run 'mcdev init' to initialize your project.\n`);
         }
         return config.properties;
     },