mcdev 5.0.2 → 5.1.0

package/lib/metadataTypes/DataExtension.js

@@ -59,8 +59,8 @@ class DataExtension extends MetadataType {
                 // output error & remove from deploy list
                 Util.logger.error(
                     ` ☇ skipping ${this.definition.type} ${
-                        metadataMap[this.definition.keyField]
-                    } / ${metadataMap[this.definition.nameField]}: ${ex.message}`
+                        metadataMap[metadataKey][this.definition.keyField]
+                    } / ${metadataMap[metadataKey][this.definition.nameField]}: ${ex.message}`
                 );
                 delete metadataMap[metadataKey];
                 // skip rest of handling for this DE
@@ -624,16 +624,16 @@ class DataExtension extends MetadataType {
      * @returns {Promise.<TYPE.DataExtensionItem>} Promise of updated single DE
      */
     static async preDeployTasks(metadata) {
-        if (metadata.Name.startsWith('_')) {
+        if (metadata.Name?.startsWith('_')) {
             throw new Error(`Cannot Upsert Strongly Typed Data Extensions`);
         }
         if (
             this.buObject.eid !== this.buObject.mid &&
-            metadata.r__folder_Path.startsWith('Shared Items')
+            metadata.r__folder_Path?.startsWith('Shared Items')
         ) {
             throw new Error(`Cannot Create/Update a Shared Data Extension from the Child BU`);
         }
-        if (metadata.r__folder_Path.startsWith('Synchronized Data Extensions')) {
+        if (metadata.r__folder_Path?.startsWith('Synchronized Data Extensions')) {
             throw new Error(
                 `Cannot Create/Update a Synchronized Data Extension. Please use Contact Builder to maintain these`
             );

package/lib/metadataTypes/MetadataType.js

@@ -58,15 +58,9 @@ class MetadataType {
                         if (key === fileNameWithoutEnding || listBadKeys) {
                             fileName2FileContent[fileNameWithoutEnding] = fileContent;
                         } else {
-                            Util.metadataLogger(
-                                'error',
-                                this.definition.type,
-                                'getJsonFromFS',
-                                'Name of the Metadata and the External Identifier must match',
-                                JSON.stringify({
-                                    Filename: fileNameWithoutEnding,
-                                    ExternalIdentifier: key,
-                                })
+                            Util.logger.error(
+                                ` ${this.definition.type} ${key}: Name of the metadata file and the JSON-key (${this.definition.keyField}) must match` +
+                                    Util.getGrayMsg(` - ${dir}/${fileName}`)
                             );
                         }
                     }
@@ -460,6 +454,18 @@ class MetadataType {
         return;
     }
 
+    /**
+     * Abstract execute method that needs to be implemented in child metadata type
+     *
+     * @returns {void}
+     */
+    static execute() {
+        Util.logger.error(
+            ` ☇ skipping ${this.definition.type}: execute is not supported yet for ${this.definition.type}`
+        );
+        return;
+    }
+
     /**
      * test if metadata was actually changed or not to potentially skip it during deployment
      *
@@ -650,6 +656,7 @@ class MetadataType {
             metadataMap[metadataKey][this.definition.keyField]
         );
         // Update if it already exists; Create it if not
+        const maxKeyLength = this.definition.maxKeyLength || 36;
         if (
             Util.logger.level === 'debug' &&
             metadataMap[metadataKey][this.definition.idField] &&
@@ -703,11 +710,11 @@ class MetadataType {
                     // NOTE: trim twice while getting the newKey value to remove leading spaces before limiting the length
                     const newKey = (metadataMap[metadataKey][Util.OPTIONS.changeKeyField] + '')
                         .trim()
-                        .slice(0, 36)
+                        .slice(0, maxKeyLength)
                         .trim();
-                    if (metadataMap[metadataKey][Util.OPTIONS.changeKeyField] + '' > 36) {
+                    if (metadataMap[metadataKey][Util.OPTIONS.changeKeyField] + '' > maxKeyLength) {
                         Util.logger.warn(
-                            `Customer Keys may not exceed 36 characters. Truncated the value in field ${Util.OPTIONS.changeKeyField} to ${newKey}`
+                            `${this.definition.type} ${this.definition.keyField} may not exceed ${maxKeyLength} characters. Truncated the value in field ${Util.OPTIONS.changeKeyField} to ${newKey}`
                         );
                     }
                     if (metadataKey == newKey) {
@@ -727,10 +734,10 @@ class MetadataType {
                 }
             } else if (Util.OPTIONS.changeKeyValue) {
                 // NOTE: trim twice while getting the newKey value to remove leading spaces before limiting the length
-                const newKey = Util.OPTIONS.changeKeyValue.trim().slice(0, 36).trim();
-                if (Util.OPTIONS.changeKeyValue.trim().length > 36) {
+                const newKey = Util.OPTIONS.changeKeyValue.trim().slice(0, maxKeyLength).trim();
+                if (Util.OPTIONS.changeKeyValue.trim().length > maxKeyLength) {
                     Util.logger.warn(
-                        `Customer Keys may not exceed 36 characters. Truncated your value to ${newKey}`
+                        `${this.definition.type} ${this.definition.keyField} may not exceed ${maxKeyLength} characters. Truncated your value to ${newKey}`
                     );
                 }
                 if (this.definition.keyField == this.definition.idField) {
@@ -1066,6 +1073,26 @@ class MetadataType {
             type: this.definition.type,
         };
     }
+    /**
+     * Used to execute a query/automation etc.
+     *
+     * @param {string} uri REST endpoint where the POST request should be sent
+     * @param {string} key item key
+     * @returns {Promise.<string>} 'OK' if started execution successfully, otherwise - 'Error'
+     */
+    static async executeREST(uri, key) {
+        try {
+            const response = await this.client.rest.post(uri, {}); // payload is empty for this request
+            if (response === 'OK') {
+                Util.logger.info(`Executed ${this.definition.type}: ${key}`);
+            } else {
+                throw new Error(response);
+            }
+            return response;
+        } catch (ex) {
+            Util.logger.error(`Failed to execute ${this.definition.type} ${key}: ${ex.message}`);
+        }
+    }
 
     /**
      * helper for {@link retrieveREST} and {@link retrieveSOAP}

package/lib/metadataTypes/Query.js

@@ -50,6 +50,32 @@ class Query extends MetadataType {
             key
         );
     }
+    /**
+     * a function to start query execution via API
+     *
+     * @param {string[]} keyArr customerkey of the metadata
+     * @returns {Promise.<boolean>} Returns true if all items were executed successfully, otherwise false
+     */
+    static async execute(keyArr) {
+        const results = [];
+        // works only with objectId
+        let objectId;
+        for (const key of keyArr) {
+            if (key) {
+                objectId = await this._getObjectIdForSingleRetrieve(key);
+                if (!objectId) {
+                    Util.logger.info(`Skipping ${key} - did not find an item with such key`);
+                    break;
+                }
+            }
+            results.push(
+                super.executeREST(`/automation/v1/queries/${objectId}/actions/start/`, key)
+            );
+        }
+        const successCounter = (await Promise.all(results)).filter((r) => r === 'OK').length;
+        Util.logger.info(`Executed ${successCounter} of ${keyArr.length} items`);
+        return successCounter === keyArr.length;
+    }
     /**
      * helper to allow us to select single metadata entries via REST
      *

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

@@ -13,6 +13,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: 'modifiedBy.name',
     restPagination: true,
+    maxKeyLength: 36, // confirmed max length
     type: 'asset',
     typeDescription: 'Assets from Content Builder grouped into subtypes.',
     typeRetrieveByDefault: ['asset', 'code', 'textfile', 'block', 'message', 'template', 'other'],

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

@@ -46,7 +46,8 @@ module.exports = {
     createdNameField: 'createdByName',
     lastmodDateField: 'lastSavedDate',
     lastmodNameField: 'lastSavedByName',
-    restPagination: false,
+    restPagination: true,
+    maxKeyLength: 200, // confirmed max length
     statusMapping: {
         AwaitingTrigger: 7,
         Building: 1,
@@ -329,7 +330,7 @@ module.exports = {
         legacyId: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         lastSavedDate: {
@@ -368,6 +369,45 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        notifications: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].email': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].message': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].channelType': {
+            // always 'Account'
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'notifications[].type': {
+            // custom shorthand for channelType
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].notificationType': {
+            // Error, Complete
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         startSource: {
             skipValidation: true,
         },
@@ -411,7 +451,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: false,
-            template: true,
+            template: false,
         },
         'schedule.scheduleStatus': {
             isCreateable: false,
@@ -425,6 +465,12 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        'schedule.statusId': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
         'schedule.timezoneId': {
             isCreateable: true,
             isUpdateable: true,
@@ -527,8 +573,8 @@ module.exports = {
         'steps[].annotation': {
             isCreateable: true,
             isUpdateable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'steps[].id': {
             isCreateable: true,
@@ -564,7 +610,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: false,
-            template: true,
+            template: false,
         },
         r__folder_Path: { skipValidation: true },
     },

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

@@ -96,6 +96,7 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: false,
+    maxKeyLength: 200, // confirmed max length
     type: 'dataExtension',
     typeDescription: 'Database table schemas.',
     typeRetrieveByDefault: true,

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

@@ -11,6 +11,7 @@ module.exports = {
     lastmodNameField: 'modifiedBy',
     nameField: 'name',
     restPagination: true,
+    maxKeyLength: 36, // confirmed max length
     type: 'dataExtract',
     typeDescription: 'Creates zipped files in your FTP directory or convert XML into CSV.',
     typeRetrieveByDefault: true,

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

@@ -14,6 +14,7 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
+    maxKeyLength: 36, // confirmed max length
     type: 'emailSend',
     soapType: 'emailSendDefinition',
     typeDescription: 'Mainly used in Automations as "Send Email Activity".',

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

@@ -11,6 +11,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: 'modifiedBy',
     restPagination: true,
+    maxKeyLength: 200, // confirmed max length
     type: 'event',
     typeDescription: 'Used in Journeys (Interactions) to define Entry Events.',
     typeRetrieveByDefault: true,

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

@@ -11,6 +11,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
     restPagination: true,
+    maxKeyLength: 36, // confirmed max length
     type: 'filter',
     typeDescription:
         'BETA: Part of how filtered Data Extensions are created. Depends on type "FilterDefinitions".',

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

@@ -22,6 +22,7 @@ module.exports = {
         DataExtension: 255,
         Email: 0,
     },
+    maxKeyLength: 36, // confirmed max length
     type: 'importFile',
     typeDescription: 'Reads files in FTP directory for further processing.',
     typeRetrieveByDefault: true,

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

@@ -12,6 +12,7 @@ module.exports = {
     lastmodNameField: null,
     restPagination: true,
     restPageSize: 50,
+    maxKeyLength: 50, // assumed max length
     type: 'mobileKeyword',
     typeDescription: 'Used for managing subscriptions for Mobile numbers in Mobile Connect',
     typeRetrieveByDefault: true,

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

@@ -21,6 +21,7 @@ module.exports = {
         Overwrite: 0,
         Update: 1,
     },
+    maxKeyLength: 36, // confirmed max length
     type: 'query',
     typeDescription: 'Select & transform data using SQL.',
     typeRetrieveByDefault: true,

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

@@ -23,6 +23,7 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
+    maxKeyLength: 36, // confirmed max length
     type: 'role',
     typeDescription:
         'User Roles define groups that are used to grant users access to SFMC systems.',

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

@@ -21,6 +21,7 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
+    maxKeyLength: 36, // confirmed max length
     type: 'triggeredSend',
     soapType: 'triggeredSendDefinition',
     typeDescription: 'DEPRECATED: Sends emails via API or DataExtension Event.',

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

@@ -12,6 +12,7 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: 'Client.ModifiedBy',
+    maxKeyLength: 50, // confirmed max length
     type: 'user',
     soapType: 'AccountUser',
     typeDescription: 'Marketing Cloud users',

package/lib/util/devops.js

@@ -293,17 +293,19 @@ const DevOps = {
             }
 
             /** @type {TYPE.DeltaPkgItem[]} */
-            const copied = delta.map((file) =>
-                File.copyFile(
-                    file.file,
-                    path
-                        .normalize(file.file)
-                        .replace(
-                            path.normalize(properties.directories.retrieve),
-                            path.normalize(properties.directories.deploy)
-                        )
-                )
-            );
+            const copied = delta
+                .filter((file) => !file.file.endsWith('.md')) // filter documentation files
+                .map((file) =>
+                    File.copyFile(
+                        file.file,
+                        path
+                            .normalize(file.file)
+                            .replace(
+                                path.normalize(properties.directories.retrieve),
+                                path.normalize(properties.directories.deploy)
+                            )
+                    )
+                );
             const results = await Promise.all(copied);
             const failed = results.filter((result) => result.status === 'failed');
             const skipped = results.filter((result) => result.status === 'skipped');