mcdev 5.0.1 → 5.1.0

package/lib/metadataTypes/User.js

@@ -215,12 +215,12 @@ class User extends MetadataType {
         );
 
         if (action === 'create') {
-            const createItem = metadataToCreate[metadataToCreate.length - 1];
+            const createItem = metadataToCreate.at(-1);
             User._setPasswordForNewUser(createItem);
             User._prepareRoleAssignments({ after: createItem });
             User._prepareBuAssignments(metadata[metadataKey], null, createItem);
         } else if (action === 'update') {
-            const updateItem = metadataToUpdate[metadataToUpdate.length - 1];
+            const updateItem = metadataToUpdate.at(-1);
             User._prepareRoleAssignments(updateItem);
             User._prepareBuAssignments(metadata[metadataKey], updateItem, null);
         }
@@ -731,13 +731,7 @@ class User extends MetadataType {
                     )
                 );
             }
-            if (
-                !singleRetrieve &&
-                this.buObject &&
-                this.properties.metaDataTypes.documentOnRetrieve.includes(this.definition.type)
-            ) {
-                await this.document(savedMetadata);
-            }
+            await this.runDocumentOnRetrieve(singleRetrieve, savedMetadata);
         }
         return { metadata: metadata, type: this.definition.type };
     }
@@ -944,14 +938,6 @@ class User extends MetadataType {
             return;
         }
 
-        // if ran as part of retrieve/deploy with key, exit here
-        if (metadata && Object.keys(metadata).length === 1) {
-            Util.logger.debug(
-                'Only 1 user found. Skipping documentation, assuming we ran retrieve-by-key.'
-            );
-            return;
-        }
-
         if (!metadata) {
             // load users from disk if document was called directly and not part of a retrieve
             try {

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

@@ -3,8 +3,8 @@ module.exports = {
     dependencies: ['mobileCode'],
     hasExtended: false,
     idField: 'id',
-    keyIsFixed: false,
-    keyField: 'keyword',
+    keyIsFixed: false, // custom field but mapped to normal fields
+    keyField: 'c__codeKeyword',
     nameField: 'keyword',
     createdDateField: 'createdDate',
     createdNameField: 'createdBy.name',
@@ -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,
@@ -21,14 +22,20 @@ module.exports = {
             // irregular format: NXV4ZFMwTEFwRVczd3RaLUF5X3p5dzo4Njow
             isCreateable: false,
             isUpdateable: true,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
+        c__codeKeyword: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
         keyword: {
             isCreateable: true,
             isUpdateable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         createdDate: {
             isCreateable: false,
@@ -133,11 +140,17 @@ module.exports = {
             retrieving: true,
             template: false,
         },
+        code: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
         'code.code': {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'code.id': {
             isCreateable: true,

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

@@ -316,6 +316,12 @@ module.exports = {
         'keyword.keyword': {
             isCreateable: true,
             isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'keyword.c__codeKeyword': {
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },
@@ -620,27 +626,63 @@ module.exports = {
         'subscriptionKeyword.id': {
             isCreatable: true,
             isUpdatable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'subscriptionKeyword.keyword': {
-            isCreatable: true,
-            isUpdatable: true,
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        'subscriptionKeyword.c__codeKeyword': {
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },
         'subscriptionKeyword.restriction': {
-            isCreatable: true,
-            isUpdatable: true,
-            retrieving: true,
-            template: true,
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
         },
         'subscriptionKeyword.isInherited': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        'nextKeyword.id': {
             isCreatable: true,
             isUpdatable: true,
+            retrieving: false,
+            template: false,
+        },
+        'nextKeyword.keyword': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        'nextKeyword.c__codeKeyword': {
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },
+        'nextKeyword.restriction': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
+        'nextKeyword.isInherited': {
+            isCreatable: false,
+            isUpdatable: false,
+            retrieving: false,
+            template: false,
+        },
         subscriberResponseMessage: {
             isCreatable: true,
             isUpdatable: 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,11 +12,13 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: 'Client.ModifiedBy',
+    maxKeyLength: 50, // confirmed max length
     type: 'user',
     soapType: 'AccountUser',
     typeDescription: 'Marketing Cloud users',
     typeName: 'User',
     typeRetrieveByDefault: false,
+    documentInOneFile: true,
     stringifyFieldsBeforeTemplate: ['DefaultBusinessUnit', 'c__AssociatedBusinessUnits'],
     fields: {
         AccountUserID: {

package/lib/util/auth.js

@@ -137,7 +137,10 @@ function setupSDK(sessionKey, authObject) {
                     Util.logger.debug('API REQUEST >> ' + JSON.stringify(msg, null, 2));
                     if (data) {
                         // printing it separately leads to better formatting
-                        Util.logger.debug('API REQUEST body >> \n  ' + data);
+                        Util.logger.debug(
+                            'API REQUEST body >> \n  ' +
+                                (typeof data === 'string' ? data : JSON.stringify(data, null, 2))
+                        );
                     }
                 }
             },

package/lib/util/cli.js

@@ -570,7 +570,7 @@ const Cli = {
         }
         if (Util.OPTIONS.json) {
             if (Util.OPTIONS.loggerLevel !== 'error') {
-                console.log(json); // eslint-disable-line no-console
+                console.log(JSON.stringify(json, null, 2)); // eslint-disable-line no-console
             }
             return json;
         }

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');

package/lib/util/file.js

@@ -517,9 +517,10 @@ const File = {
      * @param {string} [filetype='html'] filetype ie. JSON or SSJS
      * @returns {Promise.<boolean>} success of config load
      */
-    async initPrettier(filetype) {
-        if (FileFs.prettierConfig === null) {
-            filetype ||= 'html';
+    async initPrettier(filetype = 'html') {
+        if (FileFs.prettierConfig === null || FileFs.prettierConfigFileType !== filetype) {
+            // run this if no config was yet found or if the filetype previously used to initialize it differs (because it results in a potentially different config!)
+            FileFs.prettierConfigFileType = filetype;
             try {
                 // pass in project dir with fake index.html to avoid "no parser" error
                 // by using process.cwd we are limiting ourselves to a config in the project root
@@ -547,5 +548,6 @@ const File = {
 };
 const FileFs = { ...fs, ...File };
 FileFs.prettierConfig = null;
+FileFs.prettierConfigFileType = null;
 
 module.exports = FileFs;