mcdev 4.3.0 → 4.3.2

package/lib/metadataTypes/EmailSendDefinition.js

@@ -104,15 +104,33 @@ class EmailSendDefinition extends MetadataType {
             delete metadata.r__email_Name;
         } else if (metadata.r__assetMessage_Key) {
             // content builder
-            // * this ignores r__assetMessage_Name on purpose as that is only unique per parent folder but useful during PR reviews
-            metadata.Email.ID = cache.searchForField(
-                'asset',
-                metadata.r__assetMessage_Key,
-                'customerKey',
-                'legacyData.legacyId'
-            );
-            delete metadata.r__assetMessage_Key;
-            delete metadata.r__assetMessage_Name;
+            // * this ignores r__assetMessage_Name on purpose\ as that is only unique per parent folder but useful during PR reviews
+            // will try to find the key with the bu mid at the end, if unable, will try to find the key without it
+            try {
+                // check asset key as provided
+                metadata.Email.ID = cache.searchForField(
+                    'asset',
+                    metadata.r__assetMessage_Key,
+                    'customerKey',
+                    'legacyData.legacyId'
+                );
+                delete metadata.r__assetMessage_Key;
+                delete metadata.r__assetMessage_Name;
+            } catch {
+                // if we deploy to another BU, try applying the BU's MID to the end, which we do in preDeployTasks for assets
+
+                // get suffix to update customer key at the end
+                const suffix = '-' + this.buObject.mid;
+
+                metadata.Email.ID = cache.searchForField(
+                    'asset',
+                    metadata.r__assetMessage_Key.slice(0, Math.max(0, 36 - suffix.length)) + suffix,
+                    'customerKey',
+                    'legacyData.legacyId'
+                );
+                delete metadata.r__assetMessage_Key;
+                delete metadata.r__assetMessage_Name;
+            }
         }
         // Target Audience DataExtension
         // normalize first because this can be an array
@@ -129,7 +147,7 @@ class EmailSendDefinition extends MetadataType {
             if (sdl.r__dataExtension_Key) {
                 if (sdl.DataSourceTypeID !== 'CustomObject') {
                     throw new Error(
-                        `Skipping ${metadata.Name} (${metadata.CustomerKey}): Expecting DataSourceTypeID to equal 'CustomObject' when r__dataExtension_Key is defined; Found '${sdl.DataSourceTypeID}'`
+                        ` ☇ skipping ${this.definition.type} ${metadata.Name} (${metadata.CustomerKey}): Expecting DataSourceTypeID to equal 'CustomObject' when r__dataExtension_Key is defined; Found '${sdl.DataSourceTypeID}'`
                     );
                 }
                 sdl.CustomObjectID = cache.searchForField(
@@ -141,9 +159,13 @@ class EmailSendDefinition extends MetadataType {
                 delete sdl.r__dataExtension_Key;
             } else if (sdl.DataSourceTypeID === 'CustomObject') {
                 throw new Error(
-                    `Skipping ${metadata.Name} (${metadata.CustomerKey}): Expecting r__dataExtension_Key to be defined if DataSourceTypeID='CustomObject'`
+                    ` ☇ skipping ${this.definition.type} ${metadata.Name} (${metadata.CustomerKey}): Expecting r__dataExtension_Key to be defined if DataSourceTypeID='CustomObject'`
                 );
             }
+            if (!sdl.SalesForceObjectID || sdl.SalesForceObjectID === '') {
+                // otherwise this causes error 42117 / invalid ObjectID
+                delete sdl.SalesForceObjectID;
+            }
             // get List (required)
             if (sdl.r__list_PathName) {
                 sdl.List = {
@@ -152,7 +174,7 @@ class EmailSendDefinition extends MetadataType {
                 delete sdl.r__list_PathName;
             } else {
                 throw new Error(
-                    `Field SendDefinitionList.r__list_PathName was not defined. Please try re-retrieving this ESD from your source BU.`
+                    ` ☇ skipping ${this.definition.type} ${metadata.Name} (${metadata.CustomerKey}) Field SendDefinitionList.r__list_PathName was not defined. Please try re-retrieving this ESD from your source BU.`
                 );
             }
         }
@@ -182,33 +204,39 @@ class EmailSendDefinition extends MetadataType {
         super.setFolderPath(metadata);
 
         // email
-        try {
-            // classic
-            const classicEmail = cache.searchForField('email', metadata.Email.ID, 'ID', 'Name');
-            metadata.r__email_Name = classicEmail;
-            delete metadata.Email;
-        } catch {
+        if (metadata.Email?.ID) {
             try {
-                // content builder
-                const contentBuilderEmailName = cache.searchForField(
-                    'asset',
-                    metadata.Email.ID,
-                    'legacyData.legacyId',
-                    'name'
-                );
-                metadata.r__assetMessage_Name = contentBuilderEmailName;
-                const contentBuilderEmailKey = cache.searchForField(
-                    'asset',
-                    metadata.Email.ID,
-                    'legacyData.legacyId',
-                    'customerKey'
-                );
-                metadata.r__assetMessage_Key = contentBuilderEmailKey;
+                // classic
+                const classicEmail = cache.searchForField('email', metadata.Email.ID, 'ID', 'Name');
+                metadata.r__email_Name = classicEmail;
                 delete metadata.Email;
             } catch {
-                Util.logger.warn(
-                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder.`
-                );
+                try {
+                    // content builder
+                    const contentBuilderEmailName = cache.searchForField(
+                        'asset',
+                        metadata.Email.ID,
+                        'legacyData.legacyId',
+                        'name'
+                    );
+                    metadata.r__assetMessage_Name = contentBuilderEmailName;
+                    const contentBuilderEmailKey = cache.searchForField(
+                        'asset',
+                        metadata.Email.ID,
+                        'legacyData.legacyId',
+                        'customerKey'
+                    );
+                    metadata.r__assetMessage_Key = contentBuilderEmailKey;
+                    delete metadata.Email;
+                } catch {
+                    Util.logger.warn(
+                        ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
+                            metadata[this.definition.keyField]
+                        }): Could not find email with ID ${
+                            metadata.Email.ID
+                        } in Classic nor in Content Builder.`
+                    );
+                }
             }
         }
         // Target Audience DataExtension
@@ -232,18 +260,30 @@ class EmailSendDefinition extends MetadataType {
                     delete sdl.CustomObjectID;
                 } catch {
                     Util.logger.warn(
-                        ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find Target Audience (DataExtension) with ObjectID ${sdl.CustomObjectID}.`
+                        ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
+                            metadata[this.definition.keyField]
+                        }): Could not find Target Audience (DataExtension) with ObjectID ${
+                            sdl.CustomObjectID
+                        }.`
                     );
                 }
             }
             // List
-            try {
-                sdl.r__list_PathName = cache.getListPathName(sdl.List.ID, 'ID');
-                delete sdl.List;
-            } catch (ex) {
-                Util.logger.warn(
-                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
-                );
+            if (sdl.List?.ID) {
+                try {
+                    sdl.r__list_PathName = cache.getListPathName(sdl.List.ID, 'ID');
+                    delete sdl.List;
+                } catch (ex) {
+                    Util.logger.warn(
+                        ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
+                            metadata[this.definition.keyField]
+                        }): ${ex.message}`
+                    );
+                }
+            }
+            if (!sdl.SalesForceObjectID) {
+                // otherwise this causes error 42117 / invalid ObjectID
+                delete sdl.SalesForceObjectID;
             }
         }
 

package/lib/metadataTypes/Interaction.js

@@ -27,6 +27,7 @@ class Interaction extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
+        const extrasDefault = 'activities';
         if (retrieveDir) {
             // only print this during retrieve, not during retrieveForCache
             Util.logBeta(this.definition.type);
@@ -59,17 +60,81 @@ class Interaction extends MetadataType {
             }
             /* eslint-enable unicorn/prefer-ternary */
         }
-        // full details for retrieve, only base data for caching; reduces caching time from minutes to seconds
-        const extras = retrieveDir ? 'all' : '';
 
         try {
-            return await super.retrieveREST(
-                retrieveDir,
-                `/interaction/v1/interactions/${singleKey}?extras=${extras}`,
-                null,
-                null,
-                key
-            );
+            const uri = `/interaction/v1/interactions/`;
+            if (singleKey || !retrieveDir) {
+                // full details for retrieve, only base data for caching; reduces caching time from minutes to seconds
+                const extras = retrieveDir && singleKey ? extrasDefault : '';
+
+                // caching or single retrieve
+                return await super.retrieveREST(
+                    retrieveDir,
+                    `${uri}${singleKey}?extras=${extras}`,
+                    null,
+                    null,
+                    key
+                );
+            } else {
+                // retrieve all
+                const results = this.definition.restPagination
+                    ? await this.client.rest.getBulk(uri, this.definition.restPageSize || 500)
+                    : await this.client.rest.get(uri);
+                // const results = this.parseResponseBody(response);
+                if (results.items?.length) {
+                    // empty results will come back without "items" defined
+                    Util.logger.info(
+                        Util.getGrayMsg(
+                            ` - ${results.items?.length} ${this.definition.type}s found. Retrieving details...`
+                        )
+                    );
+                }
+                // full details for retrieve
+                const extras = extrasDefault;
+
+                const details = results.items
+                    ? await Promise.all(
+                          results.items.map(async (a) => {
+                              try {
+                                  return await this.client.rest.get(
+                                      `${uri}key:${a[this.definition.keyField]}?extras=${extras}`
+                                  );
+                              } catch (ex) {
+                                  // if we do get here, we should log the error and continue instead of failing to download all automations
+                                  Util.logger.error(
+                                      ` ☇ skipping ${this.definition.type} ${
+                                          a[this.definition.nameField]
+                                      } (${a[this.definition.keyField]}): ${ex.message} (${
+                                          ex.code
+                                      })${
+                                          ex.endpoint
+                                              ? Util.getGrayMsg(
+                                                    ' - ' +
+                                                        ex.endpoint.split(
+                                                            'rest.marketingcloudapis.com'
+                                                        )[1]
+                                                )
+                                              : ''
+                                      }`
+                                  );
+                                  return null;
+                              }
+                          })
+                      )
+                    : [];
+                const parsed = this.parseResponseBody({ items: details.filter(Boolean) });
+
+                // * retrieveDir is mandatory in this method as it is not used for caching (there is a seperate method for that)
+                const savedMetadata = await this.saveResults(parsed, retrieveDir, null, null);
+                Util.logger.info(
+                    `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})` +
+                        Util.getKeysString(key)
+                );
+                return {
+                    metadata: parsed,
+                    type: this.definition.type,
+                };
+            }
         } catch (ex) {
             // if the interaction does not exist, the API returns an error code which would otherwise bring execution to a hold
             if (

package/lib/metadataTypes/List.js

@@ -53,21 +53,23 @@ class List extends MetadataType {
      */
     static async retrieveForCache() {
         const results = await this.retrieve();
-        if (!cache.getCache()?.folder) {
-            const subTypeArr = [
-                'list',
-                'mysubs',
-                'suppression_list',
-                'publication',
-                'contextual_suppression_list',
-            ];
-            Util.logger.debug('folders not cached but required for list');
-            Util.logger.info(' - Caching dependent Metadata: folder');
-            Util.logSubtypes(subTypeArr);
-            Folder.client = this.client;
-            Folder.buObject = this.buObject;
-            Folder.properties = this.properties;
-            const result = await Folder.retrieveForCache(null, subTypeArr);
+        const subTypeArr = [
+            'list',
+            'mysubs',
+            'suppression_list',
+            'publication',
+            'contextual_suppression_list',
+        ];
+        Util.logger.debug('folders not cached but required for list');
+        Util.logger.info(' - Caching dependent Metadata: folder');
+        Util.logSubtypes(subTypeArr);
+        Folder.client = this.client;
+        Folder.buObject = this.buObject;
+        Folder.properties = this.properties;
+        const result = await Folder.retrieveForCache(null, subTypeArr);
+        if (cache.getCache()?.folder) {
+            cache.mergeMetadata('folder', result.metadata);
+        } else {
             cache.setMetadata('folder', result.metadata);
         }
         for (const metadataEntry in results.metadata) {

package/lib/metadataTypes/MetadataType.js

@@ -725,7 +725,7 @@ class MetadataType {
                 Util.logger.info(
                     ` - updated ${this.definition.type}: ${
                         metadataEntry[this.definition.keyField]
-                    } /  ${metadataEntry[this.definition.nameField]}`
+                    } / ${metadataEntry[this.definition.nameField]}`
                 );
             }
             return response;

package/lib/metadataTypes/TriggeredSendDefinition.js

@@ -132,8 +132,9 @@ class TriggeredSendDefinition extends MetadataType {
             this.setFolderPath(metadata);
         } catch {
             Util.logger.verbose(
-                ` - skipping ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find folder.`
+                ` ☇ skipping ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find folder.`
             );
+            // do not save this TSD because it would not be visible in the user interface
             return;
         }
 
@@ -163,9 +164,9 @@ class TriggeredSendDefinition extends MetadataType {
                 delete metadata.Email;
             } catch {
                 Util.logger.verbose(
-                    ` - skipping ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder.`
+                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder. This TSD cannot be replublished but potentially restarted with its cached version of the email.`
                 );
-                return;
+                // save this TSD because it could be fixed by the user or potentially restarted without a fix; also, it might be used by a journey
             }
         }
         // List (optional)
@@ -175,9 +176,9 @@ class TriggeredSendDefinition extends MetadataType {
                 delete metadata.List;
             } catch (ex) {
                 Util.logger.verbose(
-                    ` - skipping ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
+                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
                 );
-                return;
+                // save this TSD because it could be fixed by the user
             }
         }
 

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'Results',
-    dependencies: ['folder-userinitiatedsends', 'email', 'asset-message', 'dataExtension', 'list'], // filter, SendClassification, SenderProfile, DeliveryProfile
+    dependencies: ['folder-userinitiatedsends', 'email', 'asset-message', 'dataExtension', 'list'], // filter(+), sendClassification(+), SenderProfile(n/a), DeliveryProfile(n/a)
     folderType: 'userinitiatedsends',
     hasExtended: false,
     idField: 'ObjectID',
@@ -22,31 +22,31 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         AutoBccEmail: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         BccEmail: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         CategoryID: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         CCEmail: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'Client.ID': {
             isCreateable: false,
@@ -61,8 +61,8 @@ module.exports = {
             templating: false,
         },
         CreatedDate: {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             templating: false,
         },
@@ -70,19 +70,19 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         DeduplicateByEmail: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'DeliveryProfile.CustomerKey': {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'DeliveryProfile.DomainType': {
             isCreateable: false,
@@ -130,13 +130,13 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'DeliveryProfile.PrivateIP': {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'DeliveryProfile.SourceAddressType': {
             isCreateable: false,
@@ -154,7 +154,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         DomainType: {
             isCreateable: false,
@@ -166,13 +166,13 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'Email.ID': {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'Email.ObjectID': {
             isCreateable: false,
@@ -186,17 +186,35 @@ module.exports = {
             retrieving: false,
             templating: false,
         },
+        'Email.Name': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            templating: false,
+        },
+        'Email.Subject': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            templating: false,
+        },
+        'Email.Status': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            templating: false,
+        },
         EmailSubject: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         ExclusionFilter: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         FooterContentArea: {
             isCreateable: false,
@@ -256,7 +274,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         IsPlatformObject: {
             isCreateable: true,
@@ -280,7 +298,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         Keyword: {
             isCreateable: false,
@@ -295,8 +313,8 @@ module.exports = {
             templating: false,
         },
         ModifiedDate: {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             templating: false,
         },
@@ -304,7 +322,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         ObjectID: {
             isCreateable: false,
@@ -376,7 +394,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'SendClassification.ObjectID': {
             isCreateable: false,
@@ -400,7 +418,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'SendDefinitionList[].ObjectID': {
             isCreateable: false,
@@ -414,6 +432,9 @@ module.exports = {
             retrieving: false,
             templating: false,
         },
+        'SendDefinitionList[].CustomObjectID': {
+            skipValidation: true, // cannot be asked for but will be retrieved
+        },
         'SendDefinitionList[].SendDefinitionListType': {
             skipValidation: true, // cannot be asked for but will be retrieved
         },
@@ -448,7 +469,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         'SenderProfile.FromAddress': {
             isCreateable: false,
@@ -478,13 +499,13 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         SendWindowClose: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         SendWindowDelete: {
             isCreateable: false,
@@ -496,7 +517,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         SourceAddressType: {
             isCreateable: false,
@@ -508,13 +529,13 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         TestEmailAddr: {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
-            templating: false,
+            templating: true,
         },
         TimeZone: {
             isCreateable: false,

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

@@ -15,7 +15,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
     restPagination: true,
-    restPageSize: 250,
+    restPageSize: 500,
     type: 'interaction',
     typeDescription: 'Journey (internally called "Interaction").',
     typeRetrieveByDefault: true,

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

@@ -41,8 +41,8 @@ module.exports = {
             template: false,
         },
         definitionId: {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: false,
             template: false,
         },

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

@@ -41,8 +41,8 @@ module.exports = {
             template: false,
         },
         definitionId: {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: false,
             template: false,
         },