mcdev 4.3.4 → 5.0.0

package/lib/Builder.js

@@ -206,7 +206,12 @@ saved
         if (!(await config.checkProperties(properties))) {
             return null;
         }
-        Util.verifyMarketList(listName, properties);
+        try {
+            Util.verifyMarketList(listName, properties);
+        } catch (ex) {
+            Util.logger.error(ex.message);
+            return;
+        }
         if (type && !MetadataTypeInfo[type]) {
             Util.logger.error(`:: '${type}' is not a valid metadata type`);
             return;

package/lib/Deployer.js

@@ -80,6 +80,10 @@ class Deployer {
         }
         let counter_credBu = 0;
         if (businessUnit === '*') {
+            if (Util.OPTIONS.changeKeyValue) {
+                Util.logger.error('--changeKeyValue is not supported for deployments to all BUs');
+                return;
+            }
             // all credentials and all BUs shall be deployed to
             const deployFolders = await File.readDirectories(
                 properties.directories.deploy,
@@ -127,6 +131,12 @@ class Deployer {
             }
 
             if (bu === '*' && properties.credentials && properties.credentials[cred]) {
+                if (Util.OPTIONS.changeKeyValue) {
+                    Util.logger.error(
+                        '--changeKeyValue is not supported for deployments to all BUs'
+                    );
+                    return;
+                }
                 // valid credential given and -all- BUs targeted
                 Util.logger.info(`\n               :: Deploying all BUs for ${cred}`);
                 let counter_credBu = 0;
@@ -183,7 +193,7 @@ class Deployer {
      */
     static async _deployBU(cred, bu, properties, typeArr, keyArr, fromRetrieve) {
         const buPath = `${cred}/${bu}`;
-        Util.logger.info(`::Deploying ${buPath}`);
+        Util.logger.info(`:: Deploying to ${buPath}`);
         const buObject = await Cli.getCredentialObject(properties, buPath, null, true);
         let multiMetadataTypeMap;
 
@@ -206,13 +216,16 @@ class Deployer {
      * @param {TYPE.SupportedMetadataTypes[]} [typeArr] limit deployment to given metadata type (can include subtype)
      * @param {string[]} [keyArr] limit deployment to given metadata keys
      * @param {boolean} [fromRetrieve] if true, no folders will be updated/created
+     * @param {boolean} [isRefresh] optional flag to indicate that triggeredSend should be refreshed after deployment of assets
      * @returns {Promise.<TYPE.MultiMetadataTypeMap>} Promise of all deployed metadata
      */
-    async _deploy(typeArr, keyArr, fromRetrieve) {
+    async _deploy(typeArr, keyArr, fromRetrieve, isRefresh) {
         if (await File.pathExists(this.deployDir)) {
             /** @type {TYPE.MultiMetadataTypeMap} */
             this.metadata = Deployer.readBUMetadata(this.deployDir, typeArr);
-            if (typeArr) {
+
+            // filter found metadata by key if given
+            if (typeArr && Array.isArray(keyArr)) {
                 for (const selectedType of typeArr) {
                     const type = selectedType.split('-')[0];
                     this.metadata[type] = Util.filterObjByKeys(this.metadata[type], keyArr);
@@ -221,14 +234,25 @@ class Deployer {
         } else {
             this.metadata = null;
             Util.logger.error(
-                'Deployer.constructor:: Please create a directory called deploy and include your metadata in it: ./' +
+                'Please create a directory called deploy and include your metadata in it: ' +
                     this.deployDir
             );
+            return null;
         }
         if (this.metadata === null || !Object.keys(this.metadata).length) {
             Util.logger.error('No metadata found in deploy folder for selected BU');
             return null;
         }
+        if (Util.OPTIONS.changeKeyValue && Object.keys(this.metadata).length) {
+            if (Object.keys(this.metadata).length > 1) {
+                Util.logger.error('--changeKeyValue expects a single type to be deployed');
+                return null;
+            } else if (Object.keys(Object.values(this.metadata)[0]).length > 1) {
+                Util.logger.error('--changeKeyValue expects a single key to be deployed');
+                return null;
+            }
+        }
+
         if (!fromRetrieve) {
             await Deployer.createFolderDefinitions(
                 this.deployDir,
@@ -274,7 +298,8 @@ class Deployer {
                 const result = await MetadataTypeInfo[type].deploy(
                     this.metadata[type],
                     this.deployDir,
-                    this.retrieveDir
+                    this.retrieveDir,
+                    isRefresh
                 );
                 multiMetadataTypeMap[type] = result;
                 cache.mergeMetadata(type, result);

package/lib/MetadataTypeDefinitions.js

@@ -4,7 +4,6 @@
  * Provides access to all metadataType classes
  */
 const MetadataTypeDefinitions = {
-    accountUser: require('./metadataTypes/definitions/AccountUser.definition'),
     asset: require('./metadataTypes/definitions/Asset.definition'),
     attributeGroup: require('./metadataTypes/definitions/AttributeGroup.definition'),
     automation: require('./metadataTypes/definitions/Automation.definition'),
@@ -17,25 +16,28 @@ const MetadataTypeDefinitions = {
     dataExtractType: require('./metadataTypes/definitions/DataExtractType.definition'),
     discovery: require('./metadataTypes/definitions/Discovery.definition'),
     email: require('./metadataTypes/definitions/Email.definition'),
-    emailSendDefinition: require('./metadataTypes/definitions/EmailSendDefinition.definition'),
-    eventDefinition: require('./metadataTypes/definitions/EventDefinition.definition'),
+    emailSend: require('./metadataTypes/definitions/EmailSend.definition'),
+    event: require('./metadataTypes/definitions/Event.definition'),
+    fileLocation: require('./metadataTypes/definitions/FileLocation.definition'),
     fileTransfer: require('./metadataTypes/definitions/FileTransfer.definition'),
     filter: require('./metadataTypes/definitions/Filter.definition'),
     folder: require('./metadataTypes/definitions/Folder.definition'),
-    ftpLocation: require('./metadataTypes/definitions/FtpLocation.definition'),
     importFile: require('./metadataTypes/definitions/ImportFile.definition'),
-    interaction: require('./metadataTypes/definitions/Interaction.definition'),
+    journey: require('./metadataTypes/definitions/Journey.definition'),
     list: require('./metadataTypes/definitions/List.definition'),
     mobileCode: require('./metadataTypes/definitions/MobileCode.definition'),
     mobileKeyword: require('./metadataTypes/definitions/MobileKeyword.definition'),
+    mobileMessage: require('./metadataTypes/definitions/MobileMessage.definition'),
     query: require('./metadataTypes/definitions/Query.definition'),
     role: require('./metadataTypes/definitions/Role.definition'),
     script: require('./metadataTypes/definitions/Script.definition'),
+    sendClassification: require('./metadataTypes/definitions/SendClassification.definition'),
     setDefinition: require('./metadataTypes/definitions/SetDefinition.definition'),
     transactionalEmail: require('./metadataTypes/definitions/TransactionalEmail.definition'),
     transactionalPush: require('./metadataTypes/definitions/TransactionalPush.definition'),
     transactionalSMS: require('./metadataTypes/definitions/TransactionalSMS.definition'),
-    triggeredSendDefinition: require('./metadataTypes/definitions/TriggeredSendDefinition.definition'),
+    triggeredSend: require('./metadataTypes/definitions/TriggeredSend.definition'),
+    user: require('./metadataTypes/definitions/User.definition'),
 };
 
 module.exports = MetadataTypeDefinitions;

package/lib/MetadataTypeInfo.js

@@ -4,7 +4,6 @@
  * Provides access to all metadataType classes
  */
 const MetadataTypeInfo = {
-    accountUser: require('./metadataTypes/AccountUser'),
     asset: require('./metadataTypes/Asset'),
     attributeGroup: require('./metadataTypes/AttributeGroup'),
     automation: require('./metadataTypes/Automation'),
@@ -17,25 +16,28 @@ const MetadataTypeInfo = {
     dataExtractType: require('./metadataTypes/DataExtractType'),
     discovery: require('./metadataTypes/Discovery'),
     email: require('./metadataTypes/Email'),
-    emailSendDefinition: require('./metadataTypes/EmailSendDefinition'),
-    eventDefinition: require('./metadataTypes/EventDefinition'),
+    emailSend: require('./metadataTypes/EmailSend'),
+    event: require('./metadataTypes/Event'),
+    fileLocation: require('./metadataTypes/FileLocation'),
     fileTransfer: require('./metadataTypes/FileTransfer'),
     filter: require('./metadataTypes/Filter'),
     folder: require('./metadataTypes/Folder'),
-    ftpLocation: require('./metadataTypes/FtpLocation'),
     importFile: require('./metadataTypes/ImportFile'),
-    interaction: require('./metadataTypes/Interaction'),
+    journey: require('./metadataTypes/Journey'),
     list: require('./metadataTypes/List'),
     mobileCode: require('./metadataTypes/MobileCode'),
     mobileKeyword: require('./metadataTypes/MobileKeyword'),
+    mobileMessage: require('./metadataTypes/MobileMessage'),
     query: require('./metadataTypes/Query'),
     role: require('./metadataTypes/Role'),
     script: require('./metadataTypes/Script'),
+    sendClassification: require('./metadataTypes/SendClassification'),
     setDefinition: require('./metadataTypes/SetDefinition'),
     transactionalEmail: require('./metadataTypes/TransactionalEmail'),
     transactionalPush: require('./metadataTypes/TransactionalPush'),
     transactionalSMS: require('./metadataTypes/TransactionalSMS'),
-    triggeredSendDefinition: require('./metadataTypes/TriggeredSendDefinition'),
+    triggeredSend: require('./metadataTypes/TriggeredSend'),
+    user: require('./metadataTypes/User'),
 };
 
 module.exports = MetadataTypeInfo;

package/lib/cli.js

@@ -34,13 +34,12 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.retrieve(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
         },
     })
     .command({
-        command: 'deploy [BU] [TYPE] [KEY] [fromRetrieve]',
+        command: 'deploy [BU] [TYPE] [KEY] [--fromRetrieve] [--refresh]',
         aliases: ['d'],
         desc: 'deploys local metadata to a business unit',
         builder: (yargs) => {
@@ -58,14 +57,29 @@ yargs
                     type: 'string',
                     describe: 'metadata key that shall be exclusively uploaded',
                 })
-                .positional('fromRetrieve', {
+                .option('changeKeyField', {
                     type: 'string',
+                    describe:
+                        'enables updating the key of the deployed metadata with the value in provided field (e.g. c__newKey). Can be used to sync name and key fields.',
+                })
+                .option('changeKeyValue', {
+                    type: 'string',
+                    describe:
+                        'allows updating the key of the metadata to the provided value. Only available if a single type and key is deployed',
+                })
+                .option('fromRetrieve', {
+                    type: 'boolean',
                     describe: 'optionally deploy from retrieve folder',
+                })
+                .option('refresh', {
+                    type: 'boolean',
+                    describe:
+                        'optional for asset-message: runs refresh command for related triggeredSends after deploy',
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
+
             Mcdev.deploy(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY), argv.fromRetrieve);
         },
     })
@@ -79,8 +93,7 @@ yargs
             });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.initProject(argv.credentialsName);
         },
     })
@@ -88,8 +101,7 @@ yargs
         command: 'join',
         desc: `clones an existing project from git`,
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.joinProject();
         },
     })
@@ -104,8 +116,7 @@ yargs
             });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.findBUs(argv.credentialsName);
         },
     })
@@ -119,8 +130,7 @@ yargs
             });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.badKeys(argv.BU);
         },
     })
@@ -142,8 +152,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.document(argv.BU, argv.TYPE);
         },
     })
@@ -168,8 +177,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.deleteByKey(argv.BU, argv.TYPE, argv.EXTERNALKEY);
         },
     })
@@ -198,8 +206,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.retrieveAsTemplate(argv.BU, argv.TYPE, csvToArray(argv.NAME), argv.MARKET);
         },
     })
@@ -228,8 +235,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.buildTemplate(argv.BU, argv.TYPE, csvToArray(argv.KEY), argv.MARKET);
         },
     })
@@ -257,8 +263,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.buildDefinition(argv.BU, argv.TYPE, argv.NAME, argv.MARKET);
         },
     })
@@ -282,8 +287,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.buildDefinitionBulk(argv.LISTNAME, argv.TYPE, argv.NAME);
         },
     })
@@ -292,8 +296,7 @@ yargs
         aliases: ['st'],
         desc: 'lets you choose what metadata types to retrieve',
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.selectTypes();
         },
     })
@@ -301,14 +304,19 @@ yargs
         command: 'explainTypes',
         aliases: ['et'],
         desc: 'explains metadata types that can be retrieved',
+        builder: (yargs) => {
+            yargs.option('json', {
+                type: 'boolean',
+                describe: 'optionaly return info in json format',
+            });
+        },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.explainTypes();
         },
     })
     .command({
-        command: 'createDeltaPkg [range] [filter]',
+        command: 'createDeltaPkg [range] [--filter <BU>] [--commitHistory <number>]',
         aliases: ['cdp'],
         desc: 'Copies commit-based file delta into deploy folder',
         builder: (yargs) => {
@@ -317,15 +325,18 @@ yargs
                     type: 'string',
                     describe: 'Pull Request target branch or git commit range',
                 })
-                .positional('filter', {
+                .option('filter', {
                     type: 'string',
                     describe:
-                        'Disable templating & instead filter by the specified file path (comma separated)',
+                        'Disable templating & instead filter by the specified BU path (comma separated), can include subtype, will be prefixed with "retrieve/"',
+                })
+                .option('commitHistory', {
+                    type: 'number',
+                    describe: 'Number of commits to look back for changes (supersedes config)',
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.createDeltaPkg(argv);
         },
     })
@@ -350,8 +361,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.getFilesToCommit(argv.BU, argv.TYPE, csvToArray(argv.KEY));
         },
     })
@@ -375,8 +385,7 @@ yargs
                 });
         },
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.refresh(argv.BU, argv.TYPE, csvToArray(argv.KEY));
         },
     })
@@ -385,8 +394,7 @@ yargs
         aliases: ['up'],
         desc: 'Add NPM dependencies and IDE configuration files to your project',
         handler: (argv) => {
-            Mcdev.setSkipInteraction(argv.skipInteraction);
-            Mcdev.setLoggingLevel(argv);
+            Mcdev.setOptions(argv);
             Mcdev.upgrade(argv.skipInteraction);
         },
     })
@@ -406,12 +414,16 @@ yargs
         alias: ['yes', 'y'],
         description: 'Interactive questions where possible and go with defaults instead',
     })
+    .option('api', {
+        description: 'Print API calls to log ',
+        choices: ['log', 'cli'],
+    })
     .demandCommand(1, 'Please enter a valid command')
     .strict()
     .recommendCommands()
     .wrap(yargs.terminalWidth())
     .epilog(
-        'Copyright 2022. Accenture. Get support at https://github.com/Accenture/sfmc-devtools/issues'
+        'Copyright 2023. Accenture. Get support at https://github.com/Accenture/sfmc-devtools/issues'
     )
     .help().argv;
 

package/lib/index.js

@@ -42,6 +42,42 @@ class Mcdev {
     static setLoggingLevel(argv) {
         Util.setLoggingLevel(argv);
     }
+    /**
+     * allows setting system wide / command related options
+     *
+     * @param {object} argv list of command line parameters given by user
+     * @returns {void}
+     */
+    static setOptions(argv) {
+        const knownOptions = [
+            'api',
+            'commitHistory',
+            'changeKeyField',
+            'changeKeyValue',
+            'filter',
+            'fromRetrieve',
+            'json',
+            'refresh',
+            'skipInteraction',
+        ];
+        for (const option of knownOptions) {
+            if (argv[option] !== undefined) {
+                Util.OPTIONS[option] = argv[option];
+            }
+        }
+        // set logging level
+        const loggingOptions = ['silent', 'verbose', 'debug'];
+        for (const option of loggingOptions) {
+            if (argv[option] !== undefined) {
+                this.setLoggingLevel(argv);
+                break;
+            }
+        }
+        // set skip interaction
+        if (argv.skipInteraction !== undefined) {
+            this.setSkipInteraction(argv.skipInteraction);
+        }
+    }
     /**
      * handler for 'mcdev createDeltaPkg
      *
@@ -61,9 +97,14 @@ class Mcdev {
 
         return argv.filter
             ? // get source market and source BU from config
-              DevOps.getDeltaList(properties, argv.range, true, argv.filter)
+              DevOps.getDeltaList(properties, argv.range, true, argv.filter, argv.commitHistory)
             : // If no custom filter was provided, use deployment marketLists & templating
-              DevOps.buildDeltaDefinitions(properties, argv.range, argv.diffArr);
+              DevOps.buildDeltaDefinitions(
+                  properties,
+                  argv.range,
+                  argv.diffArr,
+                  argv.commitHistory
+              );
     }
 
     /**
@@ -77,10 +118,10 @@ class Mcdev {
         await Cli.selectTypes(properties);
     }
     /**
-     * @returns {void}
+     * @returns {object[]} list of supported types with their apiNames
      */
     static explainTypes() {
-        Cli.explainTypes();
+        return Cli.explainTypes();
     }
     /**
      * @returns {Promise.<boolean>} success flag
@@ -214,6 +255,15 @@ class Mcdev {
             cache.initCache(buObject);
             cred = buObject.credential;
             bu = buObject.businessUnit;
+            // clean up old folders after types were renamed
+            // TODO: Remove this with version 5.0.0
+            const renamedTypes = {
+                emailSend: 'emailSendDefinition',
+                event: 'eventDefinition',
+                fileLocation: 'ftpLocation',
+                triggeredSend: 'triggeredSendDefinition',
+                user: 'accountUser',
+            };
             Util.logger.info(`\n               :: Retrieving ${cred}/${bu}\n`);
             const retrieveTypesArr = [];
             if (selectedTypesArr) {
@@ -238,6 +288,18 @@ class Mcdev {
                     if (!keys) {
                         // dont delete directories if we are just re-retrieving a single file
                         await File.remove(File.normalizePath(removePathArr));
+                        // clean up old folders after types were renamed
+                        // TODO: Remove this with version 5.0.0
+                        if (renamedTypes[type]) {
+                            await File.remove(
+                                File.normalizePath([
+                                    properties.directories.retrieve,
+                                    cred,
+                                    bu,
+                                    renamedTypes[type],
+                                ])
+                            );
+                        }
                     }
                 }
             }
@@ -249,6 +311,15 @@ class Mcdev {
                 retrieveTypesArr.push(
                     ...new Set(properties.metaDataTypes.retrieve.map((type) => type.split('-')[0]))
                 );
+                for (const selectedType of retrieveTypesArr) {
+                    const test = Util._isValidType(selectedType);
+                    if (!test) {
+                        Util.logger.error(
+                            `Please remove the type ${selectedType} from your ${Util.configFileName}`
+                        );
+                        return;
+                    }
+                }
             }
             const retriever = new Retriever(properties, buObject);
 
@@ -339,7 +410,7 @@ class Mcdev {
             return;
         }
         try {
-            const parentBUOnlyTypes = ['accountUser', 'role'];
+            const parentBUOnlyTypes = ['user', 'role'];
             const buObject = await Cli.getCredentialObject(
                 properties,
                 parentBUOnlyTypes.includes(type) ? businessUnit.split('/')[0] : businessUnit,
@@ -365,7 +436,7 @@ class Mcdev {
      * @param {string} businessUnit references credentials from properties.json
      * @param {string} type supported metadata type
      * @param {string} customerKey Identifier of metadata
-     * @returns {Promise.<void>} -
+     * @returns {Promise.<boolean>} true if successful, false otherwise
      */
     static async deleteByKey(businessUnit, type, customerKey) {
         Util.logger.info('mcdev:: delete');
@@ -384,10 +455,13 @@ class Mcdev {
                 Util.logger.error(ex.message);
                 return;
             }
+            Util.logger.info(
+                Util.getGrayMsg(` - Deleting ${type} with key ${customerKey} on BU ${businessUnit}`)
+            );
             try {
                 MetadataTypeInfo[type].properties = properties;
                 MetadataTypeInfo[type].buObject = buObject;
-                await MetadataTypeInfo[type].deleteByKey(customerKey);
+                return await MetadataTypeInfo[type].deleteByKey(customerKey);
             } catch (ex) {
                 Util.logger.errorStack(ex, ` - Deleting ${type} failed`);
             }
@@ -404,7 +478,7 @@ class Mcdev {
     static async refresh(businessUnit, type, keyArr) {
         Util.logger.info('mcdev:: refresh');
         if (!type || !Util._isValidType(type, true)) {
-            type = 'triggeredSendDefinition';
+            type = 'triggeredSend';
             Util.logger.info(' - setting type to ' + type);
         }
         const properties = await config.getProperties();