mcdev 7.1.3 → 7.1.4

package/lib/metadataTypes/Automation.js

@@ -21,6 +21,7 @@ import pLimit from 'p-limit';
  * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
  * @typedef {import('../../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
  */
+
 /**
  * @typedef {import('../../types/mcdev.d.js').AutomationItem} AutomationItem
  * @typedef {import('../../types/mcdev.d.js').AutomationItemObj} AutomationItemObj
@@ -41,6 +42,7 @@ class Automation extends MetadataType {
     static _skipNotificationRetrieve = false;
     /** @type {AutomationMap} */
     static _cachedMetadataMap;
+
     /**
      * Retrieves Metadata of Automation
      *
@@ -376,6 +378,7 @@ class Automation extends MetadataType {
             throw new Error(JSON.stringify(results));
         }
     }
+
     /**
      * helper for {@link Automation.postRetrieveTasks} and {@link Automation.execute}
      *
@@ -399,6 +402,7 @@ class Automation extends MetadataType {
             return false;
         }
     }
+
     /**
      * manages post retrieve steps
      *
@@ -521,6 +525,7 @@ class Automation extends MetadataType {
             return null;
         }
     }
+
     /**
      * a function to start query execution via API
      *
@@ -583,6 +588,7 @@ class Automation extends MetadataType {
         Util.logger.info(`Executed ${executedKeyArr.length} of ${keyArr.length} items`);
         return executedKeyArr;
     }
+
     /**
      * helper for {@link Automation.execute}
      *
@@ -900,6 +906,7 @@ class Automation extends MetadataType {
             return null;
         }
     }
+
     /**
      * Validates the automation to be sure it can be deployed.
      * Whitelisted Activites are deployed but require configuration
@@ -946,6 +953,7 @@ class Automation extends MetadataType {
         }
         return deployable;
     }
+
     /**
      * helper for {@link MetadataType.updateREST} and {@link MetadataType.updateSOAP} that removes old files after the key was changed
      *
@@ -1013,6 +1021,7 @@ class Automation extends MetadataType {
             await this.execute(Object.keys(metadataMap));
         }
     }
+
     /**
      * helper for {@link Automation.postDeployTasks}
      *
@@ -1344,6 +1353,7 @@ class Automation extends MetadataType {
         // return time as a string without trailing "Z" and without miliseconds (separated by .)
         return dateServer.toISOString().slice(0, -1).split('.')[0];
     }
+
     /**
      * Experimental: Only working for DataExtensions:
      * Saves json content to a html table in the local file system. Will create the parent directory if it does not exist.
@@ -1461,6 +1471,7 @@ class Automation extends MetadataType {
         }
         return output;
     }
+
     /**
      * Saves json content to a html table in the local file system. Will create the parent directory if it does not exist.
      * The json's first level of keys must represent the rows and the secend level the columns
@@ -1514,6 +1525,7 @@ class Automation extends MetadataType {
             }
         }
     }
+
     /**
      * Parses metadata into a readable Markdown/HTML format then saves it
      *
@@ -1551,6 +1563,7 @@ class Automation extends MetadataType {
             );
         }
     }
+
     /**
      * 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
@@ -1578,6 +1591,7 @@ class Automation extends MetadataType {
             return super.getFilesToCommit(keyArr);
         }
     }
+
     /**
      * helper to allow us to select single metadata entries via REST
      *
@@ -1610,6 +1624,7 @@ class Automation extends MetadataType {
         }
         return super.deleteByKeySOAP(customerKey, 'CustomerKey');
     }
+
     /**
      * clean up after deleting a metadata item
      *

package/lib/metadataTypes/Campaign.js

@@ -52,6 +52,7 @@ class Campaign extends MetadataType {
 
         return res;
     }
+
     /**
      * Retrieves event definition metadata for caching
      *

package/lib/metadataTypes/ContentArea.js

@@ -50,6 +50,7 @@ class ContentArea 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, requestParams, key);
     }
+
     /**
      * generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
      *
@@ -76,6 +77,7 @@ class ContentArea extends MetadataType {
             metadata.r__folder_Path = 'my contents';
         }
     }
+
     /**
      * parses retrieved Metadata before saving
      *

package/lib/metadataTypes/DataExtension.js

@@ -20,6 +20,7 @@ import { checkbox } from '@inquirer/prompts';
  * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
  * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
  */
+
 /**
  * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldItem} DataExtensionFieldItem
  * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldMap} DataExtensionFieldMap
@@ -35,6 +36,7 @@ import { checkbox } from '@inquirer/prompts';
 class DataExtension extends MetadataType {
     /** @type {Object.<string, DataExtensionFieldMap>} key: deKey, value: deFieldMap */
     static oldFields;
+
     /**
      * Upserts dataExtensions after retrieving them from source and target to compare
      * if create or update operation is needed.
@@ -221,6 +223,7 @@ class DataExtension extends MetadataType {
         }
         return action;
     }
+
     /**
      * helper for {@link DataExtension.upsert}
      *
@@ -283,6 +286,7 @@ class DataExtension extends MetadataType {
             );
         }
     }
+
     /**
      * Updates a single dataExtension. Also updates their columns in 'dataExtension.columns'
      *
@@ -293,6 +297,7 @@ class DataExtension extends MetadataType {
     static async update(metadata, handleOutside) {
         return super.updateSOAP(metadata, handleOutside);
     }
+
     /**
      * Gets executed after deployment of metadata type
      *
@@ -914,6 +919,7 @@ class DataExtension extends MetadataType {
         const metadata = await this._retrieveAll(additionalFields);
         return { metadata: metadata, type: 'dataExtension' };
     }
+
     /**
      * manages post retrieve steps
      *
@@ -1023,6 +1029,7 @@ class DataExtension extends MetadataType {
         const response = await DataExtensionField.retrieveForCacheDE(options, additionalFields);
         return response.metadata;
     }
+
     /**
      * helps retrieving fields during templating and deploy where we dont want the full list
      *
@@ -1054,6 +1061,7 @@ class DataExtension extends MetadataType {
 
         metadata[customerKey].Fields = fieldArr;
     }
+
     /**
      * helper for {@link MetadataType.updateREST} and {@link MetadataType.updateSOAP} that removes old files after the key was changed
      *
@@ -1349,6 +1357,7 @@ class DataExtension extends MetadataType {
             Util.logger.error(`DataExtension.writeDeToX(${mode}):: error | ` + ex.message);
         }
     }
+
     /**
      * Parses metadata into a readable Markdown/HTML format then saves it
      *
@@ -1459,6 +1468,7 @@ class DataExtension extends MetadataType {
     static async retrieveForCache() {
         return this.retrieve(null, ['ObjectID', 'CustomerKey', 'Name']);
     }
+
     /**
      * Retrieves dataExtension metadata in template format.
      *
@@ -1514,6 +1524,7 @@ class DataExtension extends MetadataType {
 
         return { metadata: metadata[customerKey], type: 'dataExtension' };
     }
+
     /**
      * dataExtension logic that retrieves the folder path from cache and updates the given metadata with it after retrieve
      * it also sets the content type which is basically the subtype
@@ -1593,6 +1604,7 @@ class DataExtension extends MetadataType {
         }
         return metadata;
     }
+
     /**
      * 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/DataExtensionField.js

@@ -15,10 +15,12 @@ import { Util } from '../util/util.js';
  * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
  * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
  */
+
 /**
  * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldMap} DataExtensionFieldMap
  * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldItem} DataExtensionFieldItem
  */
+
 /**
  * DataExtensionField MetadataType
  *
@@ -26,6 +28,7 @@ import { Util } from '../util/util.js';
  */
 class DataExtensionField extends MetadataType {
     static fixShared_fields;
+
     /**
      * Retrieves all records and saves it to disk
      *
@@ -36,6 +39,7 @@ class DataExtensionField extends MetadataType {
     static async retrieve(retrieveDir, additionalFields) {
         return super.retrieveSOAP(retrieveDir, null, null, additionalFields);
     }
+
     /**
      * Retrieves all records for caching
      *
@@ -46,6 +50,7 @@ class DataExtensionField extends MetadataType {
     static async retrieveForCacheDE(requestParams, additionalFields) {
         return super.retrieveSOAP(null, requestParams, null, additionalFields);
     }
+
     /**
      * helper for DataExtension.retrieveFieldsForSingleDe that sorts the fields into an array
      *
@@ -71,6 +76,7 @@ class DataExtensionField extends MetadataType {
     static sortDeFields(a, b) {
         return a.Ordinal - b.Ordinal;
     }
+
     /**
      * manages post retrieve steps; only used by DataExtension class
      *
@@ -91,6 +97,7 @@ class DataExtensionField extends MetadataType {
         }
         return metadata;
     }
+
     /**
      * Mofifies passed deployColumns for update by mapping ObjectID to their target column's values.
      * Removes FieldType field if its the same in deploy and target column, because it results in an error even if its of the same type
@@ -333,6 +340,7 @@ class DataExtensionField extends MetadataType {
             return false;
         }
     }
+
     /**
      * clean up after deleting a metadata item
      *

package/lib/metadataTypes/DataExtract.js

@@ -37,6 +37,7 @@ class DataExtract extends MetadataType {
     static async retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/dataextracts/', null, key);
     }
+
     /**
      * Retrieves Metadata of  Data Extract Activity for caching
      *
@@ -137,6 +138,7 @@ class DataExtract extends MetadataType {
         delete metadata.r__dataExtractType_name;
         return metadata;
     }
+
     /**
      * manages post retrieve steps
      *
@@ -159,6 +161,7 @@ class DataExtract extends MetadataType {
         }
         return structuredClone(metadata);
     }
+
     /**
      * helper to allow us to select single metadata entries via REST
      *

package/lib/metadataTypes/DataExtractType.js

@@ -35,6 +35,7 @@ class DataExtractType extends MetadataType {
     static retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/dataextracttypes/', null, key);
     }
+
     /**
      * Retrieves Metadata of  Data Extract Type for caching.
      *

package/lib/metadataTypes/Discovery.js

@@ -15,6 +15,7 @@ import { Util } from '../util/util.js';
  * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
  * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
  */
+
 /**
  * ImportFile MetadataType
  *

package/lib/metadataTypes/Email.js

@@ -46,6 +46,7 @@ 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, requestParams, key);
     }
+
     /**
      * Helper for writing Metadata to disk, used for Retrieve and deploy
      *
@@ -64,6 +65,7 @@ class Email extends MetadataType {
         }
         return super.saveResults(results, retrieveDir, overrideType, templateVariables);
     }
+
     /**
      * manages post retrieve steps
      *

package/lib/metadataTypes/Event.js

@@ -26,6 +26,7 @@ import deepEqual from 'deep-equal';
  */
 class Event extends MetadataType {
     static reCacheDataExtensions = [];
+
     /**
      * Retrieves Metadata of Event Definition.
      * Endpoint /interaction/v1/eventDefinitions return all Event Definitions with all details.
@@ -141,6 +142,7 @@ class Event extends MetadataType {
             false
         );
     }
+
     /**
      * Deploys metadata - merely kept here to be able to print {@link Util.logBeta} once per deploy
      *
@@ -215,6 +217,7 @@ class Event extends MetadataType {
 
         return metadata;
     }
+
     /**
      * helper for {@link MetadataType.upsert}
      *
@@ -320,6 +323,7 @@ class Event extends MetadataType {
         }
         return createOrUpdateAction;
     }
+
     /**
      * Gets executed after deployment of metadata type
      *

package/lib/metadataTypes/FileTransfer.js

@@ -37,6 +37,7 @@ class FileTransfer extends MetadataType {
     static async retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, key);
     }
+
     /**
      * Retrieves Metadata of  FileTransfer Activity for caching
      *

package/lib/metadataTypes/Folder.js

@@ -381,7 +381,13 @@ class Folder extends MetadataType {
                 const response = await super.createREST(restPayload, '/email/v1/category', true);
                 if (response?.objectId) {
                     // convert the response to the same format as the SOAP response
+
+                    // set the new folder ID
                     metadataEntry.ID = response.categoryId;
+                    // set the client ID to ensure we can find the newly created folders as parents for folders created afterwards inside of it
+                    metadataEntry.Client = {
+                        ID: metadataEntry.Client?.ID || this.buObject.mid,
+                    };
                     // the following is a bit of a hack to make the response look like the SOAP response; not sure if we actually need that anywhere like this --> future developers feel free to double check
                     const returnObject = {
                         Results: [
@@ -399,9 +405,13 @@ class Folder extends MetadataType {
             } else {
                 const response = await super.createSOAP(metadataEntry, true);
                 if (response) {
+                    // set the client ID to ensure we can find the newly created folders as parents for folders created afterwards inside of it
+                    metadataEntry.Client = {
+                        ID: metadataEntry.Client?.ID || this.buObject.mid,
+                    };
+                    // set the new folder ID
+                    metadataEntry.ID = response.Results[0].NewID;
                     response.Results[0].Object = metadataEntry;
-                    response.Results[0].Object.ID = response.Results[0].NewID;
-                    response.Results[0].Object.CustomerKey = metadataEntry.CustomerKey;
                     delete response.Results[0].Object.$;
 
                     Util.logger.info(` - created folder: ${path}`);
@@ -618,6 +628,7 @@ class Folder extends MetadataType {
         );
         return response.Results;
     }
+
     /**
      * Gets executed after retreive of metadata type
      *
@@ -627,6 +638,7 @@ class Folder extends MetadataType {
     static postRetrieveTasks(metadata) {
         return structuredClone(metadata);
     }
+
     /**
      * Helper for writing Metadata to disk, used for Retrieve and deploy
      *

package/lib/metadataTypes/ImportFile.js

@@ -142,6 +142,7 @@ class ImportFile extends MetadataType {
             );
         }
     }
+
     /**
      * helper to allow us to select single metadata entries via REST
      *
@@ -188,6 +189,7 @@ class ImportFile extends MetadataType {
             '/automation/v1/imports/' + importFile.importDefinitionId
         );
     }
+
     /**
      * Deploys metadata
      *

package/lib/metadataTypes/Journey.js

@@ -196,6 +196,7 @@ class Journey extends MetadataType {
             }
         }
     }
+
     /**
      * Delete a metadata item from the specified business unit
      *
@@ -259,6 +260,7 @@ class Journey extends MetadataType {
             false
         );
     }
+
     /**
      * Deploys metadata - merely kept here to be able to print {@link Util.logBeta} once per deploy
      *
@@ -295,6 +297,7 @@ class Journey extends MetadataType {
     static create(metadata) {
         return super.createREST(metadata, '/interaction/v1/interactions/');
     }
+
     /**
      * Helper for writing Metadata to disk, used for Retrieve and deploy
      *
@@ -518,6 +521,7 @@ class Journey extends MetadataType {
 
         return metadata;
     }
+
     /**
      * helper for {@link Journey.postRetrieveTasks}
      *
@@ -1347,6 +1351,7 @@ class Journey extends MetadataType {
         }
         return action;
     }
+
     /**
      *
      * @param {MetadataTypeItem} item single metadata item
@@ -1479,6 +1484,7 @@ class Journey extends MetadataType {
         // no error means we have a new item to deploy and need to update the item in our retrieve folder
         return item;
     }
+
     /**
      * Gets executed after deployment of metadata type
      *
@@ -1494,6 +1500,7 @@ class Journey extends MetadataType {
             await this.publish(idArr);
         }
     }
+
     /**
      * a function to publish the journey via API
      *
@@ -1614,6 +1621,7 @@ class Journey extends MetadataType {
         );
         return executedKeyArr.filter(Boolean);
     }
+
     /**
      * helper for {@link Journey.publish}
      *

package/lib/metadataTypes/List.js

@@ -58,6 +58,7 @@ class List extends MetadataType {
         const results = await super.retrieveSOAP(retrieveDir, requestParams, key);
         return await this._retrieveParentAllSubs(results);
     }
+
     /**
      * Gets metadata cache with limited fields and does not store value to disk
      *
@@ -187,6 +188,7 @@ class List extends MetadataType {
     static postRetrieveTasks(list) {
         return this.parseMetadata(list);
     }
+
     /**
      * parses retrieved Metadata before saving
      *