mcdev 4.2.1 → 4.3.0

package/lib/metadataTypes/Email.js

@@ -16,14 +16,10 @@ class Email extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
-    static retrieve(retrieveDir, _, __, ___, key) {
-        Util.logger.warn(
-            ' - Classic E-Mails are deprecated and will be discontinued by SFMC in the near future. Ensure that you migrate any existing E-Mails to Content Builder as soon as possible.'
-        );
+    static retrieve(retrieveDir, _, __, key) {
         /** @type {TYPE.SoapRequestParams} */
         let requestParams = null;
         if (key) {
@@ -36,7 +32,25 @@ class Email extends MetadataType {
             };
         }
         // !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
-        return super.retrieveSOAP(retrieveDir, null, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams);
+    }
+    /**
+     * Helper for writing Metadata to disk, used for Retrieve and deploy
+     *
+     * @param {TYPE.MetadataTypeMap} results metadata results from deploy
+     * @param {string} retrieveDir directory where metadata should be stored after deploy/retrieve
+     * @param {string} [overrideType] for use when there is a subtype (such as folder-queries)
+     * @param {TYPE.TemplateMap} [templateVariables] variables to be replaced in the metadata
+     * @returns {Promise.<TYPE.MetadataTypeMap>} Promise of saved metadata
+     */
+    static async saveResults(results, retrieveDir, overrideType, templateVariables) {
+        if (Object.keys(results).length) {
+            // only execute the following if records were found
+            Util.logger.warn(
+                ' - Classic E-Mails are deprecated and will be discontinued by SFMC in the near future. Ensure that you migrate any existing E-Mails to Content Builder as soon as possible.'
+            );
+        }
+        return super.saveResults(results, retrieveDir, overrideType, templateVariables);
     }
     /**
      * manages post retrieve steps

package/lib/metadataTypes/EmailSendDefinition.js

@@ -17,11 +17,10 @@ class EmailSendDefinition extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
-    static retrieve(retrieveDir, _, __, ___, key) {
+    static retrieve(retrieveDir, _, __, key) {
         /** @type {TYPE.SoapRequestParams} */
         let requestParams = {
             filter: {
@@ -53,7 +52,7 @@ class EmailSendDefinition extends MetadataType {
                 },
             };
         }
-        return super.retrieveSOAP(retrieveDir, null, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams);
     }
 
     /**
@@ -79,12 +78,11 @@ class EmailSendDefinition extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(buObject, customerKey) {
-        return super.deleteByKeySOAP(buObject, customerKey, false);
+    static deleteByKey(customerKey) {
+        return super.deleteByKeySOAP(customerKey, false);
     }
 
     /**
@@ -97,8 +95,7 @@ class EmailSendDefinition extends MetadataType {
         // re-add IsPlatformObject, required for visibility
         metadata.IsPlatformObject = false;
         // folder
-        metadata.CategoryID = cache.searchForField('folder', metadata.r__folder_Path, 'Path', 'ID');
-        delete metadata.r__folder_Path;
+        super.setFolderId(metadata);
         // email
         metadata.Email = {};
         if (metadata.r__email_Name) {

package/lib/metadataTypes/EventDefinition.js

@@ -20,11 +20,11 @@ class EventDefinition extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
-    static retrieve(retrieveDir, _, __, ___, key) {
+    static retrieve(retrieveDir, _, __, key) {
+        Util.logBeta(this.definition.type);
         return super.retrieveREST(
             retrieveDir,
             `/interaction/v1/EventDefinitions${
@@ -54,6 +54,7 @@ class EventDefinition extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeItemObj>} Promise of metadata
      */
     static async retrieveAsTemplate(templateDir, name, templateVariables) {
+        Util.logBeta(this.definition.type);
         const res = await this.client.rest.get(
             '/interaction/v1/EventDefinitions?name=' + encodeURIComponent(name)
         );
@@ -116,6 +117,32 @@ class EventDefinition extends MetadataType {
         this.keepRetrieveFields(val);
         return val;
     }
+    /**
+     * Delete a metadata item from the specified business unit
+     *
+     * @param {string} key Identifier of item
+     * @returns {Promise.<boolean>} deletion success status
+     */
+    static deleteByKey(key) {
+        Util.logBeta(this.definition.type);
+        return super.deleteByKeyREST(
+            '/interaction/v1/eventDefinitions/key:' + encodeURIComponent(key),
+            key,
+            false
+        );
+    }
+    /**
+     * Deploys metadata - merely kept here to be able to print {@link Util.logBeta} once per deploy
+     *
+     * @param {TYPE.MetadataTypeMap} metadata metadata mapped by their keyField
+     * @param {string} deployDir directory where deploy metadata are saved
+     * @param {string} retrieveDir directory where metadata after deploy should be saved
+     * @returns {Promise.<TYPE.MetadataTypeMap>} Promise of keyField => metadata map
+     */
+    static async deploy(metadata, deployDir, retrieveDir) {
+        Util.logBeta(this.definition.type);
+        return super.deploy(metadata, deployDir, retrieveDir);
+    }
 
     /**
      * Creates a single Event Definition

package/lib/metadataTypes/FileTransfer.js

@@ -19,11 +19,10 @@ class FileTransfer extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
-    static async retrieve(retrieveDir, _, __, ___, key) {
+    static async retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, null, key);
     }
     /**

package/lib/metadataTypes/Filter.js

@@ -18,11 +18,10 @@ class Filter extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
-    static async retrieve(retrieveDir, _, __, ___, key) {
+    static async retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/filters/', null, null, key);
     }
 }

package/lib/metadataTypes/Folder.js

@@ -18,21 +18,19 @@ class Folder extends MetadataType {
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {string[]} [additionalFields] Returns specified fields even if their retrieve definition is not set to true
-     * @param {TYPE.BuObject} buObject properties for auth
-     * @param {void} [___] unused parameter
+     * @param {string[]} [subTypeArr] content type of folder
      * @param {string} [key] customer key of single item to retrieve
-     * @param {string[]} [contentTypeList] content type of folder
      * @returns {Promise} Promise
      */
-    static async retrieve(retrieveDir, additionalFields, buObject, ___, key, contentTypeList) {
+    static async retrieve(retrieveDir, additionalFields, subTypeArr, key) {
         if (key) {
             Util.logger.error(`Folder.retrieve() does not support key parameter`);
         }
-        const queryAllFolders = await this.retrieveHelper(additionalFields, true, contentTypeList);
+        const queryAllFolders = await this.retrieveHelper(additionalFields, true, subTypeArr);
 
-        if (buObject.eid !== buObject.mid) {
+        if (this.buObject.eid !== this.buObject.mid) {
             queryAllFolders.push(
-                ...(await this.retrieveHelper(additionalFields, false, contentTypeList))
+                ...(await this.retrieveHelper(additionalFields, false, subTypeArr))
             );
         }
         const sortPairs = toposort(queryAllFolders.map((a) => [a.ParentFolder.ID, a.ID]));
@@ -45,7 +43,7 @@ class Folder extends MetadataType {
             }
             // by default folders do not have an external key, we set this to ID plus EID as this will be unique
             else if (!val.CustomerKey) {
-                val.CustomerKey = [buObject.eid, val.ID].join('-');
+                val.CustomerKey = [this.buObject.eid, val.ID].join('-');
             }
             // ensure name is a string and not a number (SFMC-SDK workaround)
             val.Name = val.Name + '';
@@ -108,7 +106,7 @@ class Folder extends MetadataType {
             // remove keys which are listed in other BUs and skip root
             if (
                 idMap[id].Client?.ID &&
-                (buObject.mid == idMap[id].Client.ID ||
+                (this.buObject.mid == idMap[id].Client.ID ||
                     this.definition.folderTypesFromParent.includes(
                         idMap[id].ContentType.toLowerCase()
                     ))
@@ -141,7 +139,7 @@ class Folder extends MetadataType {
             }
         }
         if (retrieveDir) {
-            const savedMetadata = await this.saveResults(metadata, retrieveDir, buObject.mid);
+            const savedMetadata = await this.saveResults(metadata, retrieveDir, this.buObject.mid);
             Util.logger.info(
                 `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})`
             );
@@ -152,12 +150,12 @@ class Folder extends MetadataType {
     /**
      * Retrieves folder metadata for caching
      *
-     * @param {TYPE.BuObject} buObject properties for auth
-     * @param {string[]} [contentTypeList] content type of folder
+     * @param {void} _ unused
+     * @param {string[]} [subTypeArr] content type of folder
      * @returns {Promise} Promise
      */
-    static retrieveForCache(buObject, contentTypeList) {
-        return this.retrieve(null, null, buObject, null, null, contentTypeList);
+    static retrieveForCache(_, subTypeArr) {
+        return this.retrieve(null, null, subTypeArr, null);
     }
 
     /**

package/lib/metadataTypes/FtpLocation.js

@@ -16,11 +16,10 @@ class FtpLocation extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
-    static retrieve(retrieveDir, _, __, ___, key) {
+    static retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/ftplocations/', null, null, key);
     }
 

package/lib/metadataTypes/ImportFile.js

@@ -20,11 +20,10 @@ class ImportFile extends MetadataType {
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter
      * @param {void} [__] unused parameter
-     * @param {void} [___] unused parameter
      * @param {string} [key] customer key of single item to retrieve
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
-    static retrieve(retrieveDir, _, __, ___, key) {
+    static retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/imports/', null, null, key);
     }