mcdev 5.0.1 → 5.1.0

package/lib/cli.js

@@ -240,7 +240,7 @@ yargs
         },
     })
     .command({
-        command: 'buildDefinition <BU> <TYPE> <NAME> <MARKET>',
+        command: 'buildDefinition <BU> <TYPE> <FILENAME> <MARKET>',
         aliases: ['bd'],
         desc: 'builds metadata definition based on template',
         builder: (yargs) => {
@@ -253,9 +253,9 @@ yargs
                     type: 'string',
                     describe: 'metadata type',
                 })
-                .positional('NAME', {
+                .positional('FILENAME', {
                     type: 'string',
-                    describe: 'name of the metadata component',
+                    describe: 'File name of the metadata template without the extension',
                 })
                 .positional('MARKET', {
                     type: 'string',
@@ -264,11 +264,11 @@ yargs
         },
         handler: (argv) => {
             Mcdev.setOptions(argv);
-            Mcdev.buildDefinition(argv.BU, argv.TYPE, argv.NAME, argv.MARKET);
+            Mcdev.buildDefinition(argv.BU, argv.TYPE, argv.FILENAME, argv.MARKET);
         },
     })
     .command({
-        command: 'buildDefinitionBulk <LISTNAME> <TYPE> <NAME>',
+        command: 'buildDefinitionBulk <LISTNAME> <TYPE> <FILENAME>',
         aliases: ['bdb'],
         desc: 'builds metadata definition based on template en bulk',
         builder: (yargs) => {
@@ -281,14 +281,14 @@ yargs
                     type: 'string',
                     describe: 'metadata type',
                 })
-                .positional('NAME', {
+                .positional('FILENAME', {
                     type: 'string',
-                    describe: 'name of the metadata component',
+                    describe: 'File name of the metadata template without the extension',
                 });
         },
         handler: (argv) => {
             Mcdev.setOptions(argv);
-            Mcdev.buildDefinitionBulk(argv.LISTNAME, argv.TYPE, argv.NAME);
+            Mcdev.buildDefinitionBulk(argv.LISTNAME, argv.TYPE, argv.FILENAME);
         },
     })
     .command({
@@ -389,6 +389,30 @@ yargs
             Mcdev.refresh(argv.BU, argv.TYPE, csvToArray(argv.KEY));
         },
     })
+    .command({
+        command: 'execute <BU> <TYPE> <KEY>',
+        aliases: ['exec'],
+        desc: 'executes the entity (query/journey/automation etc.)',
+        builder: (yargs) => {
+            yargs
+                .positional('BU', {
+                    type: 'string',
+                    describe: 'the business unit where to start an item',
+                })
+                .positional('TYPE', {
+                    type: 'string',
+                    describe: 'metadata type',
+                })
+                .positional('KEY', {
+                    type: 'string',
+                    describe: 'key(s) of the metadata component(s)',
+                });
+        },
+        handler: (argv) => {
+            Mcdev.setOptions(argv);
+            Mcdev.execute(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
+        },
+    })
     .command({
         command: 'upgrade',
         aliases: ['up'],
@@ -410,6 +434,10 @@ yargs
         type: 'boolean',
         description: 'Only output errors to CLI',
     })
+    .option('noLogFile', {
+        type: 'boolean',
+        description: 'Only output log to CLI but not to files',
+    })
     .option('skipInteraction', {
         alias: ['yes', 'y'],
         description: 'Interactive questions where possible and go with defaults instead',

package/lib/index.js

@@ -59,6 +59,7 @@ class Mcdev {
             'json',
             'refresh',
             'skipInteraction',
+            'noLogFile',
         ];
         for (const option of knownOptions) {
             if (argv[option] !== undefined) {
@@ -89,6 +90,7 @@ class Mcdev {
      * @returns {Promise.<TYPE.DeltaPkgItem[]>} list of changed items
      */
     static async createDeltaPkg(argv) {
+        Util.startLogger();
         Util.logger.info('Create Delta Package ::');
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -111,6 +113,7 @@ class Mcdev {
      * @returns {Promise} .
      */
     static async selectTypes() {
+        Util.startLogger();
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -127,6 +130,7 @@ class Mcdev {
      * @returns {Promise.<boolean>} success flag
      */
     static async upgrade() {
+        Util.startLogger();
         const properties = await config.getProperties();
         if (!properties) {
             Util.logger.error('No config found. Please run mcdev init');
@@ -149,6 +153,7 @@ class Mcdev {
      * @returns {Promise.<object>} -
      */
     static async retrieve(businessUnit, selectedTypesArr, keys, changelogOnly) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Retrieve');
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -176,7 +181,7 @@ class Mcdev {
                 for (const bu in properties.credentials[cred].businessUnits) {
                     await this._retrieveBU(cred, bu, selectedTypesArr, keys);
                     counter_credBu++;
-                    Util.restartLogger();
+                    Util.startLogger(true);
                 }
                 counter_credTotal += counter_credBu;
                 Util.logger.info(`\n               :: ${counter_credBu} BUs for ${cred}\n`);
@@ -210,7 +215,7 @@ class Mcdev {
                 for (const bu in properties.credentials[cred].businessUnits) {
                     await this._retrieveBU(cred, bu, selectedTypesArr, keys);
                     counter_credBu++;
-                    Util.restartLogger();
+                    Util.startLogger(true);
                 }
                 Util.logger.info(`\n               :: ${counter_credBu} BUs for ${cred}\n`);
             } else {
@@ -256,11 +261,12 @@ class Mcdev {
             cred = buObject.credential;
             bu = buObject.businessUnit;
             // clean up old folders after types were renamed
-            // TODO: Remove this with version 5.0.0
+            // TODO: Remove renamedTypes-logic 6 months after version 5 release
             const renamedTypes = {
                 emailSend: 'emailSendDefinition',
                 event: 'eventDefinition',
                 fileLocation: 'ftpLocation',
+                journey: 'interaction',
                 triggeredSend: 'triggeredSendDefinition',
                 user: 'accountUser',
             };
@@ -350,6 +356,7 @@ class Mcdev {
      * @returns {Promise.<Object.<string,TYPE.MultiMetadataTypeMap>>} deployed metadata per BU (first key: bu name, second key: metadata type)
      */
     static async deploy(businessUnit, selectedTypesArr, keyArr, fromRetrieve = false) {
+        Util.startLogger();
         return Deployer.deploy(businessUnit, selectedTypesArr, keyArr, fromRetrieve);
     }
 
@@ -360,6 +367,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async initProject(credentialsName) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Setting up project');
         const properties = await config.getProperties(!!credentialsName, true);
         await Init.initProject(properties, credentialsName);
@@ -370,6 +378,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async joinProject() {
+        Util.startLogger();
         Util.logger.info('mcdev:: Joining an existing project');
         await Init.joinProject();
     }
@@ -381,6 +390,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async findBUs(credentialsName) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Load BUs');
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -400,6 +410,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async document(businessUnit, type) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Document');
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -439,6 +450,7 @@ class Mcdev {
      * @returns {Promise.<boolean>} true if successful, false otherwise
      */
     static async deleteByKey(businessUnit, type, customerKey) {
+        Util.startLogger();
         Util.logger.info('mcdev:: delete');
         if (!Util._isValidType(type)) {
             return;
@@ -476,6 +488,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async refresh(businessUnit, type, keyArr) {
+        Util.startLogger();
         Util.logger.info('mcdev:: refresh');
         if (!type || !Util._isValidType(type, true)) {
             type = 'triggeredSend';
@@ -511,6 +524,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async badKeys(businessUnit) {
+        Util.startLogger();
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -584,6 +598,7 @@ class Mcdev {
      * @returns {Promise.<TYPE.MultiMetadataTypeList>} -
      */
     static async retrieveAsTemplate(businessUnit, selectedType, name, market) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Retrieve as Template');
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -625,6 +640,7 @@ class Mcdev {
      * @returns {Promise.<TYPE.MultiMetadataTypeList>} -
      */
     static async buildTemplate(businessUnit, selectedType, keyArr, market) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Build Template from retrieved files');
         return Builder.buildTemplate(businessUnit, selectedType, keyArr, market);
     }
@@ -638,6 +654,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async buildDefinition(businessUnit, selectedType, name, market) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Build Definition from Template');
         return Builder.buildDefinition(businessUnit, selectedType, name, market);
     }
@@ -651,6 +668,7 @@ class Mcdev {
      * @returns {Promise.<void>} -
      */
     static async buildDefinitionBulk(listName, type, name) {
+        Util.startLogger();
         Util.logger.info('mcdev:: Build Definition from Template Bulk');
         return Builder.buildDefinitionBulk(listName, type, name);
     }
@@ -662,6 +680,7 @@ class Mcdev {
      * @returns {Promise.<string[]>} list of all files that need to be committed in a flat array ['path/file1.ext', 'path/file2.ext']
      */
     static async getFilesToCommit(businessUnit, selectedType, keyArr) {
+        Util.startLogger();
         Util.logger.info('mcdev:: getFilesToCommit');
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
@@ -681,6 +700,159 @@ class Mcdev {
             return DevOps.getFilesToCommit(properties, buObject, selectedType, keyArr);
         }
     }
+    /**
+     * Start an item (query)
+     *
+     * @param {string} businessUnit name of BU
+     * @param {TYPE.SupportedMetadataTypes[]} [selectedTypesArr] limit to given metadata types
+     * @param {string[]} keys customerkey of the metadata
+     * @returns {Promise.<boolean>} true if all started successfully, false if not
+     */
+    static async execute(businessUnit, selectedTypesArr, keys) {
+        Util.startLogger();
+        Util.logger.info('mcdev:: Execute');
+        const properties = await config.getProperties();
+        let counter_credBu = 0;
+        let counter_failed = 0;
+        if (!(await config.checkProperties(properties))) {
+            // return null here to avoid seeing 2 error messages for the same issue
+            return null;
+        }
+        if (Array.isArray(selectedTypesArr)) {
+            // types and keys can be provided but for each type all provided keys are applied as filter
+            for (const selectedType of Array.isArray(selectedTypesArr)
+                ? selectedTypesArr
+                : Object.keys(selectedTypesArr)) {
+                if (!Util._isValidType(selectedType)) {
+                    return;
+                }
+            }
+        }
+        if (businessUnit === '*') {
+            Util.logger.info(
+                '\n               :: Executing the entity on all BUs for all credentials'
+            );
+            let counter_credTotal = 0;
+            for (const cred in properties.credentials) {
+                Util.logger.info(`\n               :: Executing the entity on all BUs for ${cred}`);
+
+                for (const bu in properties.credentials[cred].businessUnits) {
+                    if (await this._executeBU(cred, bu, selectedTypesArr, keys)) {
+                        counter_credBu++;
+                    } else {
+                        counter_failed++;
+                    }
+                    Util.startLogger(true);
+                }
+                counter_credTotal += counter_credBu;
+                Util.logger.info(
+                    `\n               :: Executed the entity on ${counter_credBu} BUs for ${cred}\n`
+                );
+            }
+            Util.logger.info(
+                `\n               :: Executed the entity on ${counter_credTotal} BUs in total\n`
+            );
+        } else {
+            let [cred, bu] = businessUnit ? businessUnit.split('/') : [null, null];
+            // to allow all-BU via user selection we need to run this here already
+            if (
+                properties.credentials &&
+                (!properties.credentials[cred] ||
+                    (bu !== '*' && !properties.credentials[cred].businessUnits[bu]))
+            ) {
+                const buObject = await Cli.getCredentialObject(
+                    properties,
+                    cred === null ? null : cred + '/' + bu,
+                    null,
+                    true
+                );
+                if (buObject === null) {
+                    return;
+                } else {
+                    cred = buObject.credential;
+                    bu = buObject.businessUnit;
+                }
+            }
+            if (bu === '*' && properties.credentials && properties.credentials[cred]) {
+                Util.logger.info(`\n               :: Executing the entity on all BUs for ${cred}`);
+                let counter_credBu = 0;
+                for (const bu in properties.credentials[cred].businessUnits) {
+                    if (await this._executeBU(cred, bu, selectedTypesArr, keys)) {
+                        counter_credBu++;
+                    } else {
+                        counter_failed++;
+                    }
+                    Util.startLogger(true);
+                }
+                Util.logger.info(
+                    `\n               :: Executed the entity on ${counter_credBu} BUs for ${cred}\n`
+                );
+            } else {
+                // execute the entity on one BU only
+                if (await this._executeBU(cred, bu, selectedTypesArr, keys)) {
+                    counter_credBu++;
+                } else {
+                    counter_failed++;
+                }
+                Util.logger.info(`\n               :: Done\n`);
+            }
+        }
+        if (counter_credBu !== 0) {
+            Util.logger.info(`\n               :: Executed query on ${counter_credBu} BUs\n`);
+        }
+        return counter_failed === 0 ? true : false;
+    }
+    /**
+     * helper for {@link execute}
+     *
+     * @param {string} cred name of Credential
+     * @param {string} bu name of BU
+     * @param {TYPE.SupportedMetadataTypes[]} [selectedTypesArr] limit execution to given metadata type
+     * @param {string[]} keyArr customerkey of the metadata
+     * @returns {Promise.<boolean>} true if all items were executed, false otherwise
+     */
+    static async _executeBU(cred, bu, selectedTypesArr, keyArr) {
+        const properties = await config.getProperties();
+        let counter_failed = 0;
+        const buObject = await Cli.getCredentialObject(
+            properties,
+            cred === null ? null : cred + '/' + bu,
+            null,
+            true
+        );
+        if (!keyArr || (Array.isArray(keyArr) && !keyArr.length)) {
+            throw new Error('No keys were provided');
+        }
+        if (!selectedTypesArr || (Array.isArray(selectedTypesArr) && !selectedTypesArr.length)) {
+            throw new Error('No type was provided');
+        }
+        if (buObject !== null) {
+            cache.initCache(buObject);
+            cred = buObject.credential;
+            bu = buObject.businessUnit;
+        }
+        Util.logger.info(
+            `\n               :: Executing ${selectedTypesArr.join(', ')} on ${cred}/${bu}\n`
+        );
+        try {
+            // more than one type was provided, iterate types and execute items
+            for (const type of selectedTypesArr) {
+                try {
+                    MetadataTypeInfo[type].client = auth.getSDK(buObject);
+                } catch (ex) {
+                    Util.logger.error(ex.message);
+                    return;
+                }
+                // result will be undefined (false) if execute is not supported for the type
+                if (!(await MetadataTypeInfo[type].execute(keyArr))) {
+                    counter_failed++;
+                }
+            }
+        } catch (ex) {
+            Util.logger.errorStack(ex, 'mcdev.execute failed');
+        }
+        return counter_failed === 0 ? true : false;
+    }
 }
 
 module.exports = Mcdev;

package/lib/metadataTypes/Asset.js

@@ -26,7 +26,9 @@ class Asset extends MetadataType {
     static async retrieve(retrieveDir, _, subTypeArr, key) {
         const items = [];
         subTypeArr ||= this._getSubTypes();
-        await File.initPrettier();
+        if (retrieveDir) {
+            await File.initPrettier();
+        }
         // loop through subtypes and return results of each subType for caching (saving is handled per subtype)
         for (const subType of subTypeArr) {
             // each subtype contains multiple different specific types (images contains jpg and png for example)
@@ -235,7 +237,7 @@ class Asset extends MetadataType {
                     rightOperand: {
                         property: 'id',
                         simpleOperator: 'greaterThan',
-                        value: items[items.length - 1].id,
+                        value: items.at(-1).id,
                     },
                 };
                 lastPage = 0;