mcdev 7.2.0 → 7.3.0

package/lib/Builder.js

@@ -102,10 +102,10 @@ saved
      * @param {string} businessUnit references credentials from properties.json
      * @param {string} selectedType supported metadata type
      * @param {string[]} keyArr customerkey of the metadata
-     * @param {string} market market localizations
+     * @param {string[]} marketArr market localizations
      * @returns {Promise.<MultiMetadataTypeList>} -
      */
-    static async buildTemplate(businessUnit, selectedType, keyArr, market) {
+    static async buildTemplate(businessUnit, selectedType, keyArr, marketArr) {
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -119,12 +119,20 @@ saved
             );
             return;
         }
+        /** @type {TemplateMap} */
+        const templateVariables = {};
+        for (const market of marketArr) {
+            if (Util.checkMarket(market, properties)) {
+                Object.assign(templateVariables, properties.markets[market]);
+            } else {
+                // do not execute the rest of this method if a market was invalid
+                return;
+            }
+        }
         const buObject = await Cli.getCredentialObject(properties, businessUnit);
         if (buObject !== null) {
             const builder = new Builder(properties, buObject);
-            if (Util.checkMarket(market, properties)) {
-                return builder._buildTemplate(selectedType, keyArr, properties.markets[market]);
-            }
+            return builder._buildTemplate(selectedType, keyArr, templateVariables);
         }
     }
 
@@ -175,10 +183,10 @@ saved
      * @param {string} businessUnit references credentials from properties.json
      * @param {string} selectedType supported metadata type
      * @param {string[]} nameArr name of the metadata
-     * @param {string} market market localizations
+     * @param {string[]} marketArr market localizations
      * @returns {Promise.<MultiMetadataTypeList>} -
      */
-    static async buildDefinition(businessUnit, selectedType, nameArr, market) {
+    static async buildDefinition(businessUnit, selectedType, nameArr, marketArr) {
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -192,12 +200,20 @@ saved
             );
             return;
         }
+        /** @type {TemplateMap} */
+        const templateVariables = {};
+        for (const market of marketArr) {
+            if (Util.checkMarket(market, properties)) {
+                Object.assign(templateVariables, properties.markets[market]);
+            } else {
+                // do not execute the rest of this method if a market was invalid
+                return;
+            }
+        }
         const buObject = await Cli.getCredentialObject(properties, businessUnit);
         if (buObject !== null) {
             const builder = new Builder(properties, buObject);
-            if (Util.checkMarket(market, properties)) {
-                return builder._buildDefinition(selectedType, nameArr, properties.markets[market]);
-            }
+            return builder._buildDefinition(selectedType, nameArr, templateVariables);
         }
     }
 
@@ -233,25 +249,28 @@ saved
                 continue;
             }
             i++;
+            /** @type {string | string[] | string[][]} */
             const market = properties.marketList[listName][businessUnit];
-            let marketList = [];
-            if ('string' === typeof market) {
-                marketList.push(market);
-            } else {
-                marketList = market;
-            }
+            const marketList = 'string' === typeof market ? [market] : market;
+
             for (const market of marketList) {
-                if (Util.checkMarket(market, properties)) {
-                    Util.logger.info(`Executing for '${businessUnit}': '${market}'`);
-                    // omitting "await" to speed up creation
-                    responseObj[businessUnit] ||= {};
-                    responseObj[businessUnit][market] = await this.buildDefinition(
-                        businessUnit,
-                        type,
-                        nameArr,
-                        market
-                    );
+                // one can now send multiple markets to buildTemplate/buildDefinition and hence that also needs to work for marketLists
+                const marketArr = 'string' === typeof market ? [market] : market;
+                for (const market of marketArr) {
+                    if (!Util.checkMarket(market, properties)) {
+                        return;
+                    }
                 }
+
+                Util.logger.info(`Executing for '${businessUnit}': '${marketArr.join('-')}'`);
+                // omitting "await" to speed up creation
+                responseObj[businessUnit] ||= {};
+                responseObj[businessUnit][marketArr.join('-')] = await this.buildDefinition(
+                    businessUnit,
+                    type,
+                    nameArr,
+                    marketArr
+                );
             }
         }
 

package/lib/cli.js

@@ -363,6 +363,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('marketFrom', {
                     type: 'string',
+                    array: true,
                     alias: 'mf',
                     group: 'Required parameters for build:',
                     describe: 'market used for reverse building template',
@@ -370,6 +371,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('marketTo', {
                     type: 'string',
+                    array: true,
                     alias: 'mt',
                     group: 'Required parameters for build:',
                     describe: 'market used for building deployable definition',
@@ -440,6 +442,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('market', {
                     type: 'string',
+                    array: true,
                     group: 'Options for buildTemplate:',
                     describe: 'market used for reverse building template',
                 })
@@ -472,10 +475,15 @@ yargs(hideBin(process.argv))
                     argv.BU,
                     argv.TYPE,
                     csvToArray(argv.KEY),
-                    argv.MARKET || argv.market
+                    argv.MARKET ? [argv.MARKET] : argv.market
                 );
             } else {
-                Mcdev.buildTemplate(argv.BU, typeKeyCombo, null, argv.MARKET || argv.market);
+                Mcdev.buildTemplate(
+                    argv.BU,
+                    typeKeyCombo,
+                    null,
+                    argv.MARKET ? [argv.MARKET] : argv.market
+                );
             }
         }
     )
@@ -509,6 +517,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('market', {
                     type: 'string',
+                    array: true,
                     group: 'Options for buildDefinition:',
                     describe: 'market used for building deployable definition',
                 })
@@ -528,10 +537,15 @@ yargs(hideBin(process.argv))
                     argv.BU,
                     argv.TYPE,
                     csvToArray(argv.FILENAME),
-                    argv.MARKET || argv.market
+                    argv.MARKET ? [argv.MARKET] : argv.market
                 );
             } else {
-                Mcdev.buildDefinition(argv.BU, typeKeyCombo, null, argv.MARKET || argv.market);
+                Mcdev.buildDefinition(
+                    argv.BU,
+                    typeKeyCombo,
+                    null,
+                    argv.MARKET ? [argv.MARKET] : argv.market
+                );
             }
         }
     )
@@ -813,7 +827,7 @@ yargs(hideBin(process.argv))
         }
     )
     .command(
-        ['pause <BU> [TYPE] [KEY]', 'p', 'stop'],
+        ['pause <BU> [TYPE] [KEY]', 'p'],
         'pauses the entity (automation etc.)',
         (yargs) =>
             yargs
@@ -860,6 +874,54 @@ yargs(hideBin(process.argv))
             }
         }
     )
+    .command(
+        ['stop <BU> [TYPE] [KEY]'],
+        'stops the entity (journey etc.)',
+        (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)',
+                })
+                .option('metadata', {
+                    type: 'string',
+                    array: true,
+                    alias: 'm',
+                    group: 'Options for pause:',
+                    describe: 'type or type:key or type:i:id or type:n:name to fix',
+                })
+                .option('like', {
+                    type: 'string',
+                    group: 'Options for pause:',
+                    describe:
+                        'filter metadata components (can include % as wildcard or _ for a single character)',
+                })
+                .check((argv) => {
+                    if (!argv.TYPE && !argv.metadata) {
+                        throw new Error(
+                            'Error: Either specify the metadata type after the BU or use --metadata'
+                        );
+                    }
+                    return true;
+                }),
+        (argv) => {
+            Mcdev.setOptions(argv);
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
+            if ('undefined' === typeof typeKeyCombo) {
+                Mcdev.stop(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
+            } else {
+                Mcdev.stop(argv.BU, typeKeyCombo);
+            }
+        }
+    )
     .command(
         ['fixKeys <BU> [TYPE] [KEY]', 'fx'],
         'changes the key of the items to match the name',

package/lib/index.js

@@ -16,6 +16,8 @@ import MetadataTypeDefinitions from './MetadataTypeDefinitions.js';
 import Retriever from './Retriever.js';
 import cache from './util/cache.js';
 import ReplaceContentBlockReference from './util/replaceContentBlockReference.js';
+import pLimit from 'p-limit';
+import path from 'node:path';
 
 import { confirm } from '@inquirer/prompts';
 
@@ -597,10 +599,10 @@ class Mcdev {
      *
      * @param {string} businessUnit references credentials from properties.json
      * @param {string | TypeKeyCombo} selectedTypes supported metadata type (single) or complex object
-     * @param {string[] | string} [keyArr] Identifier of metadata
+     * @param {string[] | string} [keys] Identifier of metadata
      * @returns {Promise.<boolean>} true if successful, false otherwise
      */
-    static async deleteByKey(businessUnit, selectedTypes, keyArr) {
+    static async deleteByKey(businessUnit, selectedTypes, keys) {
         Util.startLogger();
         Util.logger.info('mcdev:: delete');
 
@@ -609,9 +611,8 @@ class Mcdev {
 
         /** @typedef {TypeKeyCombo} */
         let selectedTypesObj;
-        if ('string' === typeof keyArr) {
-            keyArr = [keyArr];
-        }
+        let keyArr;
+        keyArr = 'string' === typeof keys ? [keys] : keys;
         if ('string' === typeof selectedTypes) {
             selectedTypesArr = [selectedTypes];
         } else {
@@ -647,22 +648,31 @@ class Mcdev {
                 Util.logger.error(`No keys set for ${type}`);
                 return;
             }
-            for (const key of keyArr) {
-                MetadataTypeInfo[type].client = client;
-
-                Util.logger.info(
-                    Util.getGrayMsg(` - Deleting ${type} ${key} on BU ${businessUnit}`)
-                );
-                try {
-                    MetadataTypeInfo[type].properties = properties;
-                    MetadataTypeInfo[type].buObject = buObject;
-                    const result = await MetadataTypeInfo[type].deleteByKey(key);
-                    status &&= result;
-                } catch (ex) {
-                    Util.logger.errorStack(ex, ` - Deleting ${type} failed`);
-                    status = false;
-                }
-            }
+            MetadataTypeInfo[type].client = client;
+            MetadataTypeInfo[type].properties = properties;
+            MetadataTypeInfo[type].buObject = buObject;
+            const deleteLimit = pLimit(20);
+
+            await Promise.allSettled(
+                keyArr.map((key) =>
+                    deleteLimit(async () => {
+                        // Util.logger.info(
+                        //     Util.getGrayMsg(` - Deleting ${type} ${key} on BU ${businessUnit}`)
+                        // );
+                        try {
+                            const result = await MetadataTypeInfo[type].deleteByKey(key);
+                            status &&= result;
+                        } catch (ex) {
+                            Util.logger.errorStack(
+                                ex,
+                                ` - Deleting ${type} ${key} on BU ${businessUnit} failed`
+                            );
+                            status = false;
+                        }
+                        return status;
+                    })
+                )
+            );
         }
 
         return status;
@@ -1086,8 +1096,8 @@ class Mcdev {
      * @param {string} businessUnitTemplate references credentials from properties.json
      * @param {string} businessUnitDefinition references credentials from properties.json
      * @param {TypeKeyCombo} typeKeyCombo limit retrieval to given metadata type
-     * @param {string} marketTemplate market localizations
-     * @param {string} marketDefinition market localizations
+     * @param {string[]} marketTemplate market localizations
+     * @param {string[]} marketDefinition market localizations
      * @param {boolean} [bulk] runs buildDefinitionBulk instead of buildDefinition; requires marketList to be defined and given via marketDefinition
      * @returns {Promise.<MultiMetadataTypeList | object>} response from buildDefinition
      */
@@ -1105,10 +1115,7 @@ class Mcdev {
             );
             return;
         }
-        const properties = await config.getProperties();
-        if (!Util.checkMarket(marketTemplate, properties)) {
-            return;
-        }
+
         // check if types are valid
         for (const type of Object.keys(typeKeyCombo)) {
             if (!Util._isValidType(type)) {
@@ -1123,7 +1130,7 @@ class Mcdev {
         Util.logger.info('mcdev:: Build Template & Build Definition');
         await this.buildTemplate(businessUnitTemplate, typeKeyCombo, null, marketTemplate);
         return bulk
-            ? this.buildDefinitionBulk(marketDefinition, typeKeyCombo, null)
+            ? this.buildDefinitionBulk(marketDefinition[0], typeKeyCombo, null)
             : this.buildDefinition(businessUnitDefinition, typeKeyCombo, null, marketDefinition);
     }
 
@@ -1133,17 +1140,20 @@ class Mcdev {
      * @param {string} businessUnit references credentials from properties.json
      * @param {string | TypeKeyCombo} selectedTypes limit retrieval to given metadata type
      * @param {string[] | undefined} keyArr customerkey of the metadata
-     * @param {string} market market localizations
+     * @param {string[]} marketArr market localizations
      * @returns {Promise.<MultiMetadataTypeList>} -
      */
-    static async buildTemplate(businessUnit, selectedTypes, keyArr, market) {
+    static async buildTemplate(businessUnit, selectedTypes, keyArr, marketArr) {
         this.#welcomeMessage();
 
         Util.startLogger();
         Util.logger.info('mcdev:: Build Template from retrieved files');
         const properties = await config.getProperties();
-        if (!Util.checkMarket(market, properties)) {
-            return;
+        const buObject = await Cli.getCredentialObject(properties, businessUnit);
+        for (const market of marketArr) {
+            if (!Util.checkMarket(market, properties)) {
+                return;
+            }
         }
         if ('string' === typeof selectedTypes) {
             // ensure we have TypeKeyCombo here
@@ -1163,6 +1173,52 @@ class Mcdev {
         if (!Util.OPTIONS.dependencies) {
             await this._reRetrieve(businessUnit, false, selectedTypes);
         }
+        // convert names to keys
+        const retrieveDir = File.normalizePath([
+            properties.directories.retrieve,
+            buObject.credential,
+            buObject.businessUnit,
+        ]);
+        for (const type of Object.keys(selectedTypes)) {
+            const keyArr = selectedTypes[type];
+            if (keyArr.some((key) => key.startsWith('name:'))) {
+                // at least one key was provided as a name -> load all files from disk to try and find that key
+                const builTemplateCache = Object.values(
+                    await MetadataTypeInfo[type].getJsonFromFS(retrieveDir + path.sep + type)
+                );
+                selectedTypes[type] = keyArr
+                    .map((key) => {
+                        if (key.startsWith('name:')) {
+                            // key was defined by name. try and find matching item on disk
+                            const name = key.slice(5);
+                            const foundKeysByName = builTemplateCache
+                                .filter(
+                                    (item) =>
+                                        name == item[MetadataTypeInfo[type].definition.nameField]
+                                )
+                                .map((item) => item[MetadataTypeInfo[type].definition.keyField]);
+                            if (foundKeysByName.length === 1) {
+                                key = foundKeysByName[0];
+                                Util.logger.debug(
+                                    `- found ${type} key '${key}' for name '${name}'`
+                                );
+                                return key;
+                            } else if (foundKeysByName.length > 1) {
+                                Util.logger.error(
+                                    `Found multiple keys (${foundKeysByName.join(', ')}) for name: ${key}`
+                                );
+                                return;
+                            } else {
+                                Util.logger.error(`Could not find any keys for name: ${name}`);
+                                return;
+                            }
+                        } else {
+                            return key;
+                        }
+                    })
+                    .filter(Boolean);
+            }
+        }
 
         // if dependencies are enabled, we need to search for them and add them to our
         await this.addDependencies(businessUnit, selectedTypes);
@@ -1175,19 +1231,11 @@ class Mcdev {
                 businessUnit,
                 type,
                 selectedTypes[type],
-                market
+                marketArr
             );
             returnObj[type] = result[type];
         }
         Util.logger.info(`Templated ${Util.getTypeKeyCount(returnObj)} items`);
-        if (Util.OPTIONS.dependencies) {
-            Util.logger.info(
-                `You can now run buildDefinition to create the deployment package. Don't forget to adjust the BU and market!`
-            );
-            Util.logger.info(
-                `   mcdev bd ${businessUnit} ${Util.convertTypeKeyToCli(selectedTypes)} --market ${market}`
-            );
-        }
         return returnObj;
     }
 
@@ -1223,17 +1271,19 @@ class Mcdev {
      * @param {string} businessUnit references credentials from properties.json
      * @param {string | TypeKeyCombo} selectedTypes limit retrieval to given metadata type
      * @param {string[] | undefined} nameArr name of the metadata
-     * @param {string} market market localizations
+     * @param {string[]} marketArr market localizations
      * @returns {Promise.<MultiMetadataTypeList>} -
      */
-    static async buildDefinition(businessUnit, selectedTypes, nameArr, market) {
+    static async buildDefinition(businessUnit, selectedTypes, nameArr, marketArr) {
         this.#welcomeMessage();
 
         Util.startLogger();
         Util.logger.info('mcdev:: Build Definition from Template');
         const properties = await config.getProperties();
-        if (!Util.checkMarket(market, properties)) {
-            return;
+        for (const market of marketArr) {
+            if (!Util.checkMarket(market, properties)) {
+                return;
+            }
         }
         if ('string' === typeof selectedTypes) {
             // ensure we have TypeKeyCombo here
@@ -1257,7 +1307,7 @@ class Mcdev {
                 businessUnit,
                 type,
                 selectedTypes[type],
-                market
+                marketArr
             );
             returnObj[type] = result[type];
         }
@@ -1389,6 +1439,18 @@ class Mcdev {
         return this.#runMethod('pause', businessUnit, selectedTypes, keys);
     }
 
+    /**
+     * stop an item
+     *
+     * @param {string} businessUnit name of BU
+     * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
+     * @param {string[]} [keys] customerkey of the metadata
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
+     */
+    static async stop(businessUnit, selectedTypes, keys) {
+        return this.#runMethod('stop', businessUnit, selectedTypes, keys);
+    }
+
     /**
      * Updates the key to match the name field
      *
@@ -1564,7 +1626,7 @@ class Mcdev {
     /**
      * run a method across BUs
      *
-     * @param {'execute'|'pause'|'publish'|'fixKeys'|'replaceCbReference'} methodName what to run
+     * @param {'execute'|'pause'|'stop'|'publish'|'fixKeys'|'replaceCbReference'} methodName what to run
      * @param {string} businessUnit name of BU
      * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
      * @param {string[]} [keys] customerkey of the metadata
@@ -1594,6 +1656,13 @@ class Mcdev {
                 checkMetadataSupport = true;
                 break;
             }
+            case 'stop': {
+                lang_past = 'stopped';
+                lang_present = 'stopping';
+                requireKeyOrLike = true;
+                checkMetadataSupport = true;
+                break;
+            }
             case 'publish': {
                 lang_past = 'published';
                 lang_present = 'publishing';
@@ -1768,7 +1837,7 @@ class Mcdev {
     /**
      * helper for Mcdev.#runMethod
      *
-     * @param {'execute'|'pause'|'publish'|'fixKeys'|'replaceCbReference'} methodName what to run
+     * @param {'execute'|'pause'|'stop'|'publish'|'fixKeys'|'replaceCbReference'} methodName what to run
      * @param {string} cred name of Credential
      * @param {string} bu name of BU
      * @param {string} [type] limit execution to given metadata type

package/lib/metadataTypes/Asset.js

@@ -2089,7 +2089,7 @@ class Asset extends MetadataType {
             id = key ? await this._getIdForSingleRetrieve(key) : null;
         }
         if (!id) {
-            Util.logger.error(` - ${this.definition.type} not found`);
+            Util.logger.error(` - ${this.definition.type} ${key} not found`);
             return false;
         }
         return super.deleteByKeyREST('/asset/v1/content/assets/' + id, key);

package/lib/metadataTypes/Automation.js

@@ -1612,17 +1612,17 @@ class Automation extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {string} customerKey Identifier of data extension
+     * @param {string} key Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static async deleteByKey(customerKey) {
+    static async deleteByKey(key) {
         // the delete endpoint returns a general exception if the automation does not exist; handle it gracefully instead by adding a retrieve first
-        const objectId = customerKey ? await this.#getObjectIdForSingleRetrieve(customerKey) : null;
+        const objectId = key ? await this.#getObjectIdForSingleRetrieve(key) : null;
         if (!objectId) {
-            Util.logger.error(` - automation not found`);
+            Util.logger.error(` - automation ${key} not found`);
             return false;
         }
-        return super.deleteByKeySOAP(customerKey, 'CustomerKey');
+        return super.deleteByKeySOAP(key, 'CustomerKey');
     }
 
     /**

package/lib/metadataTypes/DataExtract.js

@@ -190,7 +190,7 @@ class DataExtract extends MetadataType {
         // delete only works with the query's object id
         const objectId = customerKey ? await this._getObjectIdForSingleRetrieve(customerKey) : null;
         if (!objectId) {
-            Util.logger.error(` - dataExtract not found`);
+            Util.logger.error(` - dataExtract ${customerKey} not found`);
             return false;
         }
         return super.deleteByKeyREST('/automation/v1/dataextracts/' + objectId, customerKey);