mcdev 4.3.4 → 5.0.0

package/lib/metadataTypes/Role.js

@@ -4,6 +4,7 @@ const TYPE = require('../../types/mcdev.d');
 const MetadataType = require('./MetadataType');
 const Util = require('../util/util');
 const File = require('../util/file');
+const cache = require('../util/cache');
 
 /**
  * ImportFile MetadataType
@@ -28,15 +29,8 @@ class Role extends MetadataType {
             return;
         }
 
-        const fields = Object.keys(this.definition.fields).reduce((accumulator, currentValue) => {
-            if (this.definition.fields[currentValue].retrieving) {
-                accumulator.push(currentValue);
-            }
-            return accumulator;
-        }, []);
-        // manually add ObjectID for retrieves as it is no longer automatically returned, and is needed for updates
-        fields.push('ObjectID');
-        /** @type {TYPE.SoapRequestParams} */
+        const fields = super.getFieldNamesToRetrieve(null, !retrieveDir);
+
         let requestParams = {
             // filter individual roles
             filter: {
@@ -45,24 +39,63 @@ class Role extends MetadataType {
                 rightOperand: false,
             },
         };
+        /** @type {TYPE.SoapRequestParams} */
         if (key) {
             // move original filter down one level into rightOperand and add key filter into leftOperand
-            requestParams = {
-                filter: {
-                    leftOperand: {
-                        leftOperand: 'CustomerKey',
-                        operator: 'equals',
-                        rightOperand: key,
-                    },
-                    operator: 'AND',
-                    rightOperand: requestParams.filter,
-                },
+            const keyFilter = {
+                leftOperand: 'CustomerKey',
+                operator: 'equals',
+                rightOperand: key,
             };
+            requestParams = requestParams
+                ? {
+                      filter: {
+                          leftOperand: keyFilter,
+                          operator: 'AND',
+                          rightOperand: requestParams.filter,
+                      },
+                  }
+                : keyFilter;
         }
 
         const results = await this.client.soap.retrieve('Role', fields, requestParams);
 
         const parsed = this.parseResponseBody(results);
+        if (!retrieveDir) {
+            // retrieve "Marketing Cloud%" roles not returned by SOAP API
+            const { roles, timeZones } = await this.client.rest.get(
+                '/platform/v1/setup/quickflow/data'
+            );
+            // this endpoint does not provide keys
+            const roleNameKeyMap = {
+                'Marketing Cloud Administrator': 'SYS_DEF_IMHADMIN',
+                'Marketing Cloud Channel Manager': 'SYS_DEF_CHANNELMANAGER',
+                'Marketing Cloud Content Editor/Publisher': 'SYS_DEF_CONTENTEDIT',
+                'Marketing Cloud Security Administrator': 'SYS_DEF_SECURITYADMIN',
+                'Marketing Cloud Viewer': 'SYS_DEF_VIEWER',
+            };
+            for (const role of roles) {
+                if (roleNameKeyMap[role.roleName]) {
+                    parsed[roleNameKeyMap[role.roleName]] = {
+                        CustomerKey: roleNameKeyMap[role.roleName],
+                        Name: role.roleName,
+                        ObjectID: role.roleID,
+                        Desscription: role.description,
+                        CreatedDate: '2012-02-21T02:09:19.983',
+                        IsSystemDefined: true,
+                        c__notAssignable: true,
+                    };
+                }
+            }
+            // the languages object is incomplete. the actual list is much longer --> ignoring it here
+            // convert timeZones to object
+            const timeZonesObj = {};
+            for (const timeZone of timeZones) {
+                timeZonesObj[timeZone.id] = timeZone;
+            }
+            // cache timeZones to share it with other type-classes
+            cache.setMetadata('_timezone', timeZonesObj);
+        }
         if (retrieveDir) {
             const savedMetadata = await super.saveResults(parsed, retrieveDir, null);
             Util.logger.info(
@@ -238,8 +271,14 @@ class Role extends MetadataType {
         // Reached end: write permission into this.allPermissions
         if (element.Operation) {
             const permSplit = _permission.split(' > ');
-            const basePermission = permSplit.shift();
-            const permissionName = permSplit.join(' > ');
+            const permOperation = permSplit.pop();
+            let basePermission = permSplit.shift();
+            if (basePermission === 'Interactive Marketing Hub') {
+                basePermission = 'Salesforce Marketing Cloud';
+            }
+            const permissionName = `<nobr><b>${permSplit.join(
+                ' > '
+            )}</b> > ${permOperation}</nobr>`;
             if (!this.allPermissions[basePermission]) {
                 this.allPermissions[basePermission] = {};
             }

package/lib/metadataTypes/Script.js

@@ -23,7 +23,7 @@ class Script extends MetadataType {
      */
     static async retrieve(retrieveDir, _, __, key) {
         await File.initPrettier('ssjs');
-        return super.retrieveREST(retrieveDir, '/automation/v1/scripts/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/scripts/', null, key);
     }
     /**
      * Retrieves script metadata for caching
@@ -47,7 +47,6 @@ class Script extends MetadataType {
         return super.retrieveREST(
             templateDir,
             '/automation/v1/scripts/?$filter=name%20eq%20' + encodeURIComponent(name),
-            null,
             templateVariables
         );
     }
@@ -91,7 +90,7 @@ class Script extends MetadataType {
      * @returns {Promise.<string>} content for metadata.script
      */
     static async _mergeCode(metadata, deployDir, templateName) {
-        templateName = templateName || metadata[this.definition.keyField];
+        templateName ||= metadata[this.definition.keyField];
         let code;
         const codePath = File.normalizePath([
             deployDir,

package/lib/metadataTypes/SendClassification.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const TYPE = require('../../types/mcdev.d');
+const MetadataType = require('./MetadataType');
+
+/**
+ * SendClassification MetadataType
+ *
+ * @augments MetadataType
+ */
+class SendClassification extends MetadataType {
+    /**
+     * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @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) {
+        /** @type {TYPE.SoapRequestParams} */
+        let requestParams = null;
+        if (key) {
+            requestParams = {
+                filter: {
+                    leftOperand: 'CustomerKey',
+                    operator: 'equals',
+                    rightOperand: key,
+                },
+            };
+        }
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
+    }
+}
+
+// Assign definition to static attributes
+SendClassification.definition = require('../MetadataTypeDefinitions').sendClassification;
+
+module.exports = SendClassification;

package/lib/metadataTypes/SetDefinition.js

@@ -19,13 +19,7 @@ class SetDefinition extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(
-            retrieveDir,
-            '/hub/v1/contacts/schema/setDefinitions',
-            null,
-            null,
-            key
-        );
+        return super.retrieveREST(retrieveDir, '/hub/v1/contacts/schema/setDefinitions', null, key);
     }
     /**
      * Retrieves Metadata of schema set definitions for caching.

package/lib/metadataTypes/TransactionalEmail.js

@@ -71,8 +71,7 @@ class TransactionalEmail extends TransactionalMessage {
         // journey
         if (metadata.journey?.interactionKey) {
             // ! update & create enpoints dont accept journey.interactionKey. They only allow to create a new journey
-            // cache.searchForField('interaction', metadata.journey.interactionKey, 'key', 'key');
-            metadata.options = metadata.options || {};
+            metadata.options ||= {};
             metadata.options.createJourney = true; // only send this during create or else we might end up with an unexpected outcome
             delete metadata.journey.interactionKey;
         }
@@ -143,7 +142,7 @@ class TransactionalEmail extends TransactionalMessage {
         if (metadata.journey?.interactionKey) {
             try {
                 // we merely want to be able to show a warning if it does not exist
-                cache.searchForField('interaction', metadata.journey.interactionKey, 'key', 'key');
+                cache.searchForField('journey', metadata.journey.interactionKey, 'key', 'key');
             } catch (ex) {
                 Util.logger.warn(
                     ` - ${this.definition.type} ${metadata[this.definition.nameField]} (${

package/lib/metadataTypes/TransactionalMessage.js

@@ -13,8 +13,7 @@ class TransactionalMessage extends MetadataType {
     // define this.subType as string here for intellisense; requires to be redefined in child class
     static subType;
     /**
-     * Retrieves Metadata of Mobile Keywords
-     * Endpoint /legacy/v1/beta/mobile/code/ return all Mobile Codes with all details.
+     * Retrieves Metadata
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {void} [_] unused parameter

package/lib/metadataTypes/TransactionalSMS.js

@@ -21,29 +21,22 @@ class TransactionalSMS extends TransactionalMessage {
      * @returns {void}
      */
     static async postDeleteTasks(customerKey) {
-        // delete local copy: retrieve/cred/bu/type/...json
-        const fileName = File.normalizePath([
-            this.properties.directories.retrieve,
-            this.buObject.credential,
-            this.buObject.businessUnit,
-            this.definition.type,
-            `${customerKey}.${this.definition.type}-meta.`,
-        ]);
-        await File.remove(fileName + 'json');
-        await File.remove(fileName + 'amp');
+        // delete local copy: retrieve/cred/bu/type/...-meta.json
+        // delete local copy: retrieve/cred/bu/type/...-meta.amp
+        super.postDeleteTasks(customerKey, [`${this.definition.type}-meta.amp`]);
     }
 
     /**
      * prepares for deployment
      *
      * @param {TYPE.MetadataTypeItem} metadata a single item
-     * @param {string} dir directory of deploy files
-     * @returns {TYPE.MetadataTypeItem} Promise
+     * @param {string} deployDir directory of deploy files
+     * @returns {Promise.<TYPE.MetadataTypeItem>} Promise
      */
-    static async preDeployTasks(metadata, dir) {
+    static async preDeployTasks(metadata, deployDir) {
         // code
         metadata.content = {
-            message: await this._mergeCode(metadata, dir),
+            message: await this._mergeCode(metadata, deployDir),
         };
 
         if (this._isHTML(metadata.content?.message)) {
@@ -81,7 +74,7 @@ class TransactionalSMS extends TransactionalMessage {
      * @returns {Promise.<string>} content for metadata.script
      */
     static async _mergeCode(metadata, deployDir, templateName) {
-        templateName = templateName || metadata[this.definition.keyField];
+        templateName ||= metadata[this.definition.keyField];
         const codePath = File.normalizePath([
             deployDir,
             this.definition.type,

package/lib/metadataTypes/{TriggeredSendDefinition.js → TriggeredSend.js}

@@ -16,7 +16,7 @@ const cacheTypes = {
  *
  * @augments MetadataType
  */
-class TriggeredSendDefinition extends MetadataType {
+class TriggeredSend extends MetadataType {
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
@@ -50,7 +50,7 @@ class TriggeredSendDefinition extends MetadataType {
             };
         }
 
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 
     /**
@@ -67,13 +67,12 @@ class TriggeredSendDefinition extends MetadataType {
      * Updates a single TSD.
      *
      * @param {TYPE.MetadataTypeItem} metadata single metadata entry
-     * @param {boolean} [handleOutside] if the API reponse is irregular this allows you to handle it outside of this generic method
      * @returns {Promise} Promise
      */
-    static update(metadata, handleOutside) {
+    static update(metadata) {
         // * in case of update and active definition, we need to pause first.
         // * this should be done manually to not accidentally pause production queues without restarting them
-        return super.updateSOAP(metadata, null, handleOutside);
+        return super.updateSOAP(metadata);
     }
 
     /**
@@ -83,7 +82,7 @@ class TriggeredSendDefinition extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return super.deleteByKeySOAP(customerKey, false);
+        return super.deleteByKeySOAP(customerKey);
     }
 
     /**
@@ -153,7 +152,7 @@ class TriggeredSendDefinition extends MetadataType {
                     'legacyData.legacyId',
                     'name'
                 );
-                metadata.r__assetMessage_Name = contentBuilderEmailName;
+                metadata.r__assetMessage_Name_readOnly = contentBuilderEmailName;
                 const contentBuilderEmailKey = cache.searchForField(
                     'asset',
                     metadata.Email.ID,
@@ -213,7 +212,7 @@ class TriggeredSendDefinition extends MetadataType {
             delete metadata.r__email_Name;
         } else if (metadata.r__assetMessage_Key) {
             // content builder
-            // * this ignores r__assetMessage_Name on purpose as that is only unique per parent folder but useful during PR reviews
+            // * this ignores r__assetMessage_Name_readOnly on purpose as that is only unique per parent folder but useful during PR reviews
             metadata.Email = {
                 ID: cache.searchForField(
                     'asset',
@@ -223,7 +222,7 @@ class TriggeredSendDefinition extends MetadataType {
                 ),
             };
             delete metadata.r__assetMessage_Key;
-            delete metadata.r__assetMessage_Name;
+            delete metadata.r__assetMessage_Name_readOnly;
         } else if (metadata?.Email?.ID) {
             throw new Error(
                 `r__assetMessage_Key / r__email_Name not defined but instead found Email.ID. Please try re-retrieving this TSD from your BU.`
@@ -247,13 +246,13 @@ class TriggeredSendDefinition extends MetadataType {
      * TSD-specific refresh method that finds active TSDs and refreshes them
      *
      * @param {string[]} [keyArr] metadata keys
+     * @param {boolean} [checkKey=true] whether to check if the key is valid
      * @returns {Promise.<void>} -
      */
-    static async refresh(keyArr) {
+    static async refresh(keyArr, checkKey = true) {
         console.time('Time'); // eslint-disable-line no-console
-        let checkKey = true;
         if (!keyArr) {
-            keyArr = await this._findRefreshableItems();
+            keyArr = await this.getKeysForValidTSDs((await this.findRefreshableItems()).metadata);
             checkKey = false;
         }
         // then executes pause, publish, start on them.
@@ -269,16 +268,31 @@ class TriggeredSendDefinition extends MetadataType {
     }
 
     /**
-     * helper for {@link refresh} that finds active TSDs on the server and filters it by the same rules that {@link retrieve} is using to avoid refreshing TSDs with broken dependencies
+     * helper for {@link refresh} that extracts the keys from the TSD item map and eli
      *
+     * @param {TYPE.MetadataTypeMapObj} metadata TSD item map
      * @returns {Promise.<string[]>} keyArr
      */
-    static async _findRefreshableItems() {
+    static async getKeysForValidTSDs(metadata) {
+        const keyArr = Object.keys(metadata).filter((key) => {
+            const test = this.postRetrieveTasks(metadata[key]);
+            return test?.CustomerKey || false;
+        });
+        Util.logger.info(`Found ${keyArr.length} refreshable items.`);
+        return keyArr;
+    }
+    /**
+     * helper for {@link refresh} that finds active TSDs on the server and filters it by the same rules that {@link retrieve} is using to avoid refreshing TSDs with broken dependencies
+     *
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of TSD item map
+     */
+    static async findRefreshableItems() {
         Util.logger.info('Finding refreshable items...');
         // cache dependencies to test for broken links
         // skip deprecated classic emails here, assuming they cannot be updated and hence are not relevant for {@link refresh}
         const requiredCache = {
             folder: [
+                'hidden',
                 'list',
                 'mysubs',
                 'suppression_list',
@@ -311,13 +325,7 @@ class TriggeredSendDefinition extends MetadataType {
                 rightOperand: ['dummy', 'Active'], // using equals does not work for this field for an unknown reason and IN requires at least 2 values, hence the 'dummy' entry
             },
         };
-        const metadata = (await super.retrieveSOAP(null, requestParams)).metadata;
-        const keyArr = Object.keys(metadata).filter((key) => {
-            const test = this.postRetrieveTasks(metadata[key]);
-            return test?.CustomerKey || false;
-        });
-        Util.logger.info(`Found ${keyArr.length} refreshable items.`);
-        return keyArr;
+        return super.retrieveSOAP(null, requestParams);
     }
 
     /**
@@ -343,7 +351,7 @@ class TriggeredSendDefinition extends MetadataType {
             };
             try {
                 test = (
-                    await super.retrieveSOAP(null, requestParams, [
+                    await super.retrieveSOAP(null, requestParams, key, [
                         'CustomerKey',
                         'TriggeredSendStatus',
                     ])
@@ -370,7 +378,7 @@ class TriggeredSendDefinition extends MetadataType {
         // pause
         try {
             item.TriggeredSendStatus = 'Inactive';
-            test = await this.update(item, true);
+            test = await super.updateSOAP(item, true);
             if (test.OverallStatus !== 'OK') {
                 throw new Error(test.Results[0].StatusMessage);
             }
@@ -388,7 +396,7 @@ class TriggeredSendDefinition extends MetadataType {
         // publish
         try {
             item.RefreshContent = 'true';
-            test = await this.update(item, true);
+            test = await super.updateSOAP(item, true);
             if (test.OverallStatus !== 'OK') {
                 throw new Error(test.Results[0].StatusMessage);
             }
@@ -405,7 +413,7 @@ class TriggeredSendDefinition extends MetadataType {
         // start
         try {
             item.TriggeredSendStatus = 'Active';
-            test = await this.update(item, true);
+            test = await super.updateSOAP(item, true);
             if (test.OverallStatus !== 'OK') {
                 throw new Error(test.Results[0].StatusMessage);
             }
@@ -423,6 +431,6 @@ class TriggeredSendDefinition extends MetadataType {
 }
 
 // Assign definition to static attributes
-TriggeredSendDefinition.definition = require('../MetadataTypeDefinitions').triggeredSendDefinition;
+TriggeredSend.definition = require('../MetadataTypeDefinitions').triggeredSend;
 
-module.exports = TriggeredSendDefinition;
+module.exports = TriggeredSend;