mcdev 7.1.3 → 7.2.0

package/lib/metadataTypes/MetadataType.js

@@ -215,6 +215,7 @@ class MetadataType {
     static postRetrieveTasks(metadata, targetDir, isTemplating) {
         return structuredClone(metadata);
     }
+
     /**
      * generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
      *
@@ -240,6 +241,7 @@ class MetadataType {
             );
         }
     }
+
     /**
      * generic script that retrieves the folder ID from cache and updates the given metadata with it before deploy
      *
@@ -272,6 +274,7 @@ class MetadataType {
         const metadata = {};
         return { metadata: {}, type: this.definition.type };
     }
+
     /**
      * Gets metadata from Marketing Cloud
      *
@@ -294,6 +297,7 @@ class MetadataType {
     static async retrieveForCache(additionalFields, subTypeArr, key) {
         return this.retrieve(null, additionalFields, subTypeArr, key);
     }
+
     /**
      * Gets metadata cache with limited fields and does not store value to disk
      *
@@ -313,6 +317,7 @@ class MetadataType {
         );
         return { metadata: null, type: this.definition.type };
     }
+
     /**
      * Retrieve a specific Script by Name
      *
@@ -468,6 +473,7 @@ class MetadataType {
         );
         return;
     }
+
     /**
      * Abstract refresh method that needs to be implemented in child metadata type
      *
@@ -500,6 +506,7 @@ class MetadataType {
         await this.replaceCbReferenceLoop(metadataMap, retrieveDir, findAssetKeys);
         return findAssetKeys;
     }
+
     /**
      * this iterates over all items found in the retrieve folder and executes the type-specific method for replacing references
      *
@@ -573,6 +580,7 @@ class MetadataType {
         }
         return keysForDeploy;
     }
+
     /**
      * Abstract execute method that needs to be implemented in child metadata type
      *
@@ -600,6 +608,7 @@ class MetadataType {
         );
         return [];
     }
+
     /**
      * Abstract pause method that needs to be implemented in child metadata type
      *
@@ -625,6 +634,7 @@ class MetadataType {
         // should be set up type by type but the *_generic version is likely a good start for many types
         return true;
     }
+
     /**
      * test if metadata was actually changed or not to potentially skip it during deployment
      *
@@ -681,6 +691,7 @@ class MetadataType {
         }
         return false;
     }
+
     /**
      * MetadataType upsert, after retrieving from target and comparing to check if create or update operation is needed.
      *
@@ -1200,6 +1211,7 @@ class MetadataType {
             return null;
         }
     }
+
     /**
      *
      * @param {SOAPError} ex error that occured
@@ -1216,6 +1228,7 @@ class MetadataType {
             Util.logger.error(` ☇ error ${msg} ${this.definition.type}${name}: ${errorMsg}`);
         }
     }
+
     /**
      * helper for {@link MetadataType._handleSOAPErrors}
      *
@@ -1232,6 +1245,7 @@ class MetadataType {
         }
         return ex.message;
     }
+
     /**
      * Retrieves SOAP via generic fuel-soap wrapper based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
@@ -1321,6 +1335,7 @@ class MetadataType {
             type: this.definition.type,
         };
     }
+
     /**
      *
      * @param {object[]} urlArray {uri: string, id: string} combo of URL and ID/key of metadata
@@ -1377,6 +1392,7 @@ class MetadataType {
 
         return null;
     }
+
     /**
      * Used to execute a query/automation etc.
      *
@@ -1588,6 +1604,7 @@ class MetadataType {
             }, metadataEntry);
         }
     }
+
     /**
      * Remove fields from metadata entry that are not createable
      *
@@ -1681,6 +1698,7 @@ class MetadataType {
         // this metadata type has no filters defined or no match was found
         return false;
     }
+
     /**
      * optionally filter by what folder something is in
      *
@@ -1750,6 +1768,7 @@ class MetadataType {
         // this metadata type has no filters defined or no match was found
         return false;
     }
+
     /**
      * internal helper
      *
@@ -1780,6 +1799,7 @@ class MetadataType {
         // no filters matched
         return false;
     }
+
     /**
      * internal helper
      *
@@ -1993,6 +2013,7 @@ class MetadataType {
 
         return saveClone;
     }
+
     /**
      * helper for {@link MetadataType.buildDefinitionForNested}
      * searches extracted file for template variable names and applies the market values
@@ -2005,6 +2026,7 @@ class MetadataType {
         // replace template variables with their values
         return Mustache.render(code, templateVariables, {}, ['{{{', '}}}']);
     }
+
     /**
      * helper for {@link MetadataType.buildTemplateForNested}
      * searches extracted file for template variable values and applies the market variable names
@@ -2017,6 +2039,7 @@ class MetadataType {
         // replace template variables with their values
         return Util.replaceByObject(code, templateVariables);
     }
+
     /**
      * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types (e.g script, asset, query)
@@ -2038,6 +2061,7 @@ class MetadataType {
         // generic version here does nothing. actual cases handled in type classes
         return null;
     }
+
     /**
      * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
@@ -2059,6 +2083,7 @@ class MetadataType {
         // generic version here does nothing. actual cases handled in type classes
         return null;
     }
+
     /**
      * check template directory for complex types that open subfolders for their subtypes
      *
@@ -2069,6 +2094,7 @@ class MetadataType {
     static async findSubType(templateDir, templateName) {
         return null;
     }
+
     /**
      * optional method used for some types to try a different folder structure
      *
@@ -2083,6 +2109,7 @@ class MetadataType {
         // we just want to push the method into the catch here
         return;
     }
+
     /**
      * Builds definition based on template
      * NOTE: Most metadata files should use this generic method, unless custom
@@ -2196,6 +2223,7 @@ class MetadataType {
             throw new Error(`${this.definition.type}:: ${ex.message}`);
         }
     }
+
     /**
      *  Standardizes a check for multiple messages
      *
@@ -2270,6 +2298,7 @@ class MetadataType {
         Util.logger.error(`Deletion is not yet supported for ${this.definition.typeName}!`);
         return false;
     }
+
     /**
      * clean up after deleting a metadata item
      *
@@ -2327,6 +2356,7 @@ class MetadataType {
             return false;
         }
     }
+
     /**
      * Delete a data extension from the specified business unit
      *
@@ -2354,6 +2384,7 @@ class MetadataType {
             return false;
         }
     }
+
     /**
      * Returns metadata of a business unit that is saved locally
      *
@@ -2377,6 +2408,7 @@ class MetadataType {
             throw new Error(ex.message);
         }
     }
+
     /**
      * should return only the json for all but asset, query and script that are saved as multiple files
      * additionally, the documentation for dataExtension and automation should be returned
@@ -2396,6 +2428,7 @@ class MetadataType {
         const fileList = keyArr.map((key) => File.normalizePath([path, key + typeExtension]));
         return fileList;
     }
+
     /**
      *
      * @param {string[]} keyArr customerkey of the metadata
@@ -2632,6 +2665,7 @@ class MetadataType {
         }
         return keysForDeploy;
     }
+
     /**
      * helper for getKeysForFixing and createOrUpdate
      *

package/lib/metadataTypes/MobileKeyword.js

@@ -252,6 +252,7 @@ class MobileKeyword extends MetadataType {
     static create(metadata) {
         return super.createREST(metadata, '/legacy/v1/beta/mobile/keyword/');
     }
+
     /**
      * Updates a single item
      *
@@ -307,6 +308,7 @@ class MobileKeyword extends MetadataType {
             return metadata;
         }
     }
+
     /**
      * helper for {@link MobileKeyword.postRetrieveTasks} and {@link MobileKeyword._buildForNested}
      *
@@ -319,6 +321,7 @@ class MobileKeyword extends MetadataType {
 
         return { fileExt, code };
     }
+
     /**
      * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
@@ -346,6 +349,7 @@ class MobileKeyword extends MetadataType {
             'definition'
         );
     }
+
     /**
      * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
@@ -471,6 +475,7 @@ class MobileKeyword extends MetadataType {
         this.#setCodeAndKeyword(metadata);
         return metadata;
     }
+
     /**
      * helper for {@link MetadataType.createREST}
      *
@@ -481,6 +486,7 @@ class MobileKeyword extends MetadataType {
     static async postCreateTasks(metadataEntry, apiResponse) {
         await super.postDeployTasks_legacyApi(metadataEntry, apiResponse);
     }
+
     /**
      * helper for {@link MetadataType.updateREST}
      *
@@ -520,6 +526,7 @@ class MobileKeyword extends MetadataType {
             return null;
         }
     }
+
     /**
      * Delete a metadata item from the specified business unit
      *
@@ -552,6 +559,7 @@ class MobileKeyword extends MetadataType {
         // delete local copy: retrieve/cred/bu/type/...-meta.amp
         super.postDeleteTasks(customerKey, [`${this.definition.type}-meta.amp`]);
     }
+
     /**
      * should return only the json for all but asset, query and script that are saved as multiple files
      * additionally, the documentation for dataExtension and automation should be returned

package/lib/metadataTypes/MobileMessage.js

@@ -95,6 +95,7 @@ class MobileMessage extends MetadataType {
     static create(metadata) {
         return super.createREST(metadata, '/legacy/v1/beta/mobile/message/');
     }
+
     /**
      * helper for {@link MobileMessage.preDeployTasks} that loads extracted code content back into JSON
      *
@@ -122,6 +123,7 @@ class MobileMessage extends MetadataType {
             throw new Error(`Could not find ${codePath}.${fileExtension}`);
         }
     }
+
     /**
      * helper for {@link MobileMessage.postRetrieveTasks} and {@link MobileMessage._buildForNested}
      *
@@ -330,6 +332,7 @@ class MobileMessage extends MetadataType {
 
         return metadata;
     }
+
     /**
      * helper for {@link MetadataType.createREST}
      *
@@ -340,6 +343,7 @@ class MobileMessage extends MetadataType {
     static async postCreateTasks(metadataEntry, apiResponse) {
         await super.postDeployTasks_legacyApi(metadataEntry, apiResponse);
     }
+
     /**
      * helper for {@link MetadataType.updateREST}
      *
@@ -350,6 +354,7 @@ class MobileMessage extends MetadataType {
     static async postUpdateTasks(metadataEntry, apiResponse) {
         await super.postDeployTasks_legacyApi(metadataEntry, apiResponse);
     }
+
     /**
      * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
@@ -377,6 +382,7 @@ class MobileMessage extends MetadataType {
             'definition'
         );
     }
+
     /**
      * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
@@ -471,6 +477,7 @@ class MobileMessage extends MetadataType {
         }
         return nestedFilePaths;
     }
+
     /**
      * Delete a metadata item from the specified business unit
      * ! the endpoint expects the ID and not a key but for mcdev in this case key==id

package/lib/metadataTypes/Query.js

@@ -59,6 +59,7 @@ class Query extends MetadataType {
             key
         );
     }
+
     /**
      * a function to start query execution via API
      *
@@ -87,6 +88,7 @@ class Query extends MetadataType {
         Util.logger.info(`Executed ${executedKeyArr.length} of ${keyArr.length} items`);
         return executedKeyArr;
     }
+
     /**
      * helper to allow us to select single metadata entries via REST
      *
@@ -261,6 +263,7 @@ class Query extends MetadataType {
             this.definition.targetUpdateTypeMapping[metadata.targetUpdateTypeName];
         return metadata;
     }
+
     /**
      * helper for {@link Query.buildDefinitionForNested}
      * searches extracted SQL file for template variables and applies the market values
@@ -284,6 +287,7 @@ class Query extends MetadataType {
         // replace template variables with their values
         return super.applyTemplateValues(code, templateVariables);
     }
+
     /**
      * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
@@ -311,6 +315,7 @@ class Query extends MetadataType {
             'definition'
         );
     }
+
     /**
      * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
@@ -339,6 +344,7 @@ class Query extends MetadataType {
             'template'
         );
     }
+
     /**
      * helper for {@link Query.buildTemplateForNested} / {@link Query.buildDefinitionForNested}
      * handles extracted code if any are found for complex types
@@ -439,6 +445,7 @@ class Query extends MetadataType {
         }
         return errors;
     }
+
     /**
      * Delete a metadata item from the specified business unit
      *
@@ -454,6 +461,7 @@ class Query extends MetadataType {
         }
         return super.deleteByKeyREST('/automation/v1/queries/' + objectId, customerKey);
     }
+
     /**
      * clean up after deleting a metadata item
      *
@@ -465,6 +473,7 @@ class Query extends MetadataType {
         // delete local copy: retrieve/cred/bu/.../...-meta.sql
         await super.postDeleteTasks(customerKey, [`${this.definition.type}-meta.sql`]);
     }
+
     /**
      * Gets executed after deployment of metadata type
      *

package/lib/metadataTypes/Role.js

@@ -119,6 +119,7 @@ class Role extends MetadataType {
         }
         return { metadata: parsed, type: this.definition.type };
     }
+
     /**
      * Gets executed before deploying metadata
      *

package/lib/metadataTypes/Script.js

@@ -44,6 +44,7 @@ class Script extends MetadataType {
         await File.initPrettier('ssjs');
         return super.retrieveREST(retrieveDir, '/automation/v1/scripts/', null, key);
     }
+
     /**
      * Retrieves script metadata for caching
      *
@@ -125,6 +126,7 @@ class Script extends MetadataType {
         }
         return code;
     }
+
     /**
      * prepares a Script for deployment
      *
@@ -141,6 +143,7 @@ class Script extends MetadataType {
 
         return metadata;
     }
+
     /**
      * helper for {@link MetadataType.buildDefinition}
      * handles extracted code if any are found for complex types
@@ -168,6 +171,7 @@ class Script extends MetadataType {
             'definition'
         );
     }
+
     /**
      * helper for {@link MetadataType.buildTemplate}
      * handles extracted code if any are found for complex types
@@ -275,6 +279,7 @@ class Script extends MetadataType {
 
         return this.getCodeExtractItem(metadata);
     }
+
     /**
      * manages post retrieve steps
      *
@@ -343,6 +348,7 @@ class Script extends MetadataType {
         ]);
         return fileList;
     }
+
     /**
      * helper to allow us to select single metadata entries via REST
      *
@@ -378,6 +384,7 @@ class Script extends MetadataType {
         }
         return super.deleteByKeyREST('/automation/v1/scripts/' + objectId, customerKey);
     }
+
     /**
      * clean up after deleting a metadata item
      *

package/lib/metadataTypes/SendClassification.js

@@ -46,6 +46,7 @@ class SendClassification extends MetadataType {
         }
         return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
+
     /**
      * Updates a single item
      *
@@ -75,6 +76,7 @@ class SendClassification extends MetadataType {
     static deleteByKey(customerKey) {
         return super.deleteByKeySOAP(customerKey);
     }
+
     /**
      * prepares a import definition for deployment
      *

package/lib/metadataTypes/SenderProfile.js

@@ -46,6 +46,7 @@ class SenderProfile extends MetadataType {
         }
         return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
+
     /**
      * Updates a single item
      *
@@ -106,6 +107,7 @@ class SenderProfile extends MetadataType {
         }
         return metadata;
     }
+
     /**
      *
      * @param {MetadataTypeItem} item single metadata item

package/lib/metadataTypes/TransactionalEmail.js

@@ -47,6 +47,24 @@ class TransactionalEmail extends TransactionalMessage {
         return super.update(metadata);
     }
 
+    /**
+     * Updates a single item
+     *
+     * @param {MetadataTypeItem} metadata how the item shall look after the update
+     * @returns {Promise} Promise
+     */
+    static create(metadata) {
+        if (metadata.definitionType === 'Transactional' && metadata.channel === 'email') {
+            // only send this during create or else we might end up with an unexpected outcome
+            Util.logger.warn(
+                ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${
+                    metadata[this.definition.keyField]
+                }): While possible, it is not recommended to create transactional journeys via transactionalEmail. Instead, create the journey and then publish it (mcdev deploy cred/bu journey --publish)`
+            );
+        }
+        return super.create(metadata);
+    }
+
     /**
      * prepares for deployment
      *
@@ -93,6 +111,7 @@ class TransactionalEmail extends TransactionalMessage {
 
         return metadata;
     }
+
     /**
      * helper for {@link TransactionalEmail.createREST}
      *
@@ -114,6 +133,7 @@ class TransactionalEmail extends TransactionalMessage {
             delete apiResponse.journey;
         }
     }
+
     /**
      * Gets executed after deployment of metadata type
      *
@@ -122,9 +142,8 @@ class TransactionalEmail extends TransactionalMessage {
     static async postDeployTasks() {
         if (this._createdJourneyKeys?.length) {
             Util.logger.warn(
-                `Please download related journeys via: mcdev r ${this.buObject.credential}/${
-                    this.buObject.businessUnit
-                } journey "${this._createdJourneyKeys.join(',')}"`
+                `Please download related journeys via: mcdev retrieve ${this.buObject.credential}/${this.buObject.businessUnit} -m
+                ${this._createdJourneyKeys.map((el) => `"journey:${el}"`).join(' ')}`
             );
         }
         delete this._createdJourneyKeys;
@@ -218,6 +237,7 @@ class TransactionalEmail extends TransactionalMessage {
 
         return metadata;
     }
+
     /**
      * Delete a metadata item from the specified business unit
      *

package/lib/metadataTypes/TransactionalMessage.js

@@ -24,6 +24,7 @@ import { Util } from '../util/util.js';
 class TransactionalMessage extends MetadataType {
     // define this.subType as string here for intellisense; requires to be redefined in child class
     static subType;
+
     /**
      * Retrieves Metadata
      *
@@ -90,6 +91,7 @@ class TransactionalMessage extends MetadataType {
         // we should therefore use the already defined retrieve method
         return this.retrieve(undefined, undefined, undefined, key);
     }
+
     /**
      * Updates a single item
      *
@@ -112,6 +114,7 @@ class TransactionalMessage extends MetadataType {
     static create(metadata) {
         return super.createREST(metadata, '/messaging/v1/' + this.subType + '/definitions');
     }
+
     /**
      * Delete a metadata item from the specified business unit
      *

package/lib/metadataTypes/TransactionalPush.js

@@ -51,6 +51,7 @@ class TransactionalPush extends TransactionalMessage {
 
         return metadata;
     }
+
     /**
      * manages post retrieve steps
      *

package/lib/metadataTypes/TransactionalSMS.js

@@ -25,6 +25,7 @@ import cache from '../util/cache.js';
  */
 class TransactionalSMS extends TransactionalMessage {
     static subType = 'sms';
+
     /**
      * clean up after deleting a metadata item
      *
@@ -88,6 +89,7 @@ class TransactionalSMS extends TransactionalMessage {
 
         return metadata;
     }
+
     /**
      * helper for {@link TransactionalSMS.preDeployTasks} that loads extracted code content back into JSON
      *
@@ -114,6 +116,7 @@ class TransactionalSMS extends TransactionalMessage {
             throw new Error(`Could not find ${codePath}.amp`);
         }
     }
+
     /**
      * manages post retrieve steps
      *
@@ -188,6 +191,7 @@ class TransactionalSMS extends TransactionalMessage {
 
         return { json: metadata, codeArr: codeArr, subFolder: null };
     }
+
     /**
      * helper for {@link TransactionalSMS.postRetrieveTasks} and {@link TransactionalSMS._buildForNested}
      *
@@ -200,6 +204,7 @@ class TransactionalSMS extends TransactionalMessage {
 
         return { fileExt, code };
     }
+
     /**
      * helper for {@link TransactionalMessage.buildDefinition}
      * handles extracted code if any are found for complex types
@@ -227,6 +232,7 @@ class TransactionalSMS extends TransactionalMessage {
             'definition'
         );
     }
+
     /**
      * helper for {@link TransactionalMessage.buildTemplate}
      * handles extracted code if any are found for complex types
@@ -320,6 +326,7 @@ class TransactionalSMS extends TransactionalMessage {
         }
         return nestedFilePaths;
     }
+
     /**
      * very simplified test for HTML code in our SMS
      *
@@ -329,6 +336,7 @@ class TransactionalSMS extends TransactionalMessage {
     static _isHTML(code) {
         return /(<([^>]+)>)/gi.test(code);
     }
+
     /**
      * should return only the json for all but asset, query and script that are saved as multiple files
      * additionally, the documentation for dataExtension and automation should be returned