mcdev 7.5.0 → 7.6.1

package/lib/metadataTypes/MetadataType.js

@@ -508,13 +508,15 @@ class MetadataType {
     /**
      * Abstract refresh method that needs to be implemented in child metadata type
      *
-     * @returns {void}
+     * @param {string[]} [keyArr] metadata keys
+     * @param {boolean} [checkKey] whether to check if the key is valid
+     * @returns {Promise.<string[]>} Returns list of keys that were refreshed
      */
-    static refresh() {
+    static async refresh(keyArr, checkKey = true) {
         Util.logger.error(
             ` ☇ skipping ${this.definition.type}: refresh is not supported yet for ${this.definition.type}`
         );
-        return;
+        return [];
     }
 
     /**
@@ -631,9 +633,10 @@ class MetadataType {
      * Abstract execute method that needs to be implemented in child metadata type
      *
      * @param {string[]} keyArr customerkey of the metadata
+     * @param {MetadataTypeMapObj} [cache] metadata cache used by refresh to avoid recaching
      * @returns {Promise.<string[]>} Returns list of keys that were executed
      */
-    static async execute(keyArr) {
+    static async execute(keyArr, cache) {
         Util.logger.error(
             ` ☇ skipping ${this.definition.type}: execute is not supported yet for ${this.definition.type}`
         );
@@ -644,9 +647,10 @@ class MetadataType {
      * Abstract pause method that needs to be implemented in child metadata type
      *
      * @param {string[]} keyArr customerkey of the metadata
+     * @param {MetadataTypeMapObj} [cache] metadata cache used by refresh to avoid recaching
      * @returns {Promise.<string[]>} Returns list of keys that were paused
      */
-    static async pause(keyArr) {
+    static async pause(keyArr, cache) {
         Util.logger.error(
             ` ☇ skipping ${this.definition.type}: pause is not supported yet for ${this.definition.type}`
         );
@@ -2466,7 +2470,9 @@ class MetadataType {
             } else {
                 const errorMsg = ex?.results?.length
                     ? `${ex.results[0].StatusMessage} (Code ${ex.results[0].ErrorCode})`
-                    : ex.message;
+                    : ex?.json?.Results?.length
+                      ? `${ex.json.Results[0].StatusMessage} (Code ${ex.json.Results[0].ErrorCode})`
+                      : ex.message;
                 Util.logger.error(
                     ` - Deleting ${this.definition.type} '${customerKey}' failed: ${errorMsg}`
                 );

package/lib/metadataTypes/TriggeredSend.js

@@ -6,7 +6,10 @@ import cache from '../util/cache.js';
 import asset from './Asset.js';
 import folder from './Folder.js';
 import list from './List.js';
+import sendClassification from './SendClassification.js';
+import senderProfile from './SenderProfile.js';
 import ReplaceCbReference from '../util/replaceContentBlockReference.js';
+import pLimit from 'p-limit';
 
 /**
  * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
@@ -303,24 +306,32 @@ class TriggeredSend extends MetadataType {
      *
      * @param {string[]} [keyArr] metadata keys
      * @param {boolean} [checkKey] whether to check if the key is valid
-     * @returns {Promise.<void>} -
+     * @returns {Promise.<string[]>} Returns list of keys that were refreshed
      */
     static async refresh(keyArr, checkKey = true) {
-        console.time('Time'); // eslint-disable-line no-console
         if (!keyArr) {
             keyArr = await this.getKeysForValidTSDs((await this.findRefreshableItems()).metadata);
             checkKey = false;
         }
         // then executes pause, publish, start on them.
-        const refreshList = [];
         Util.logger.info(`Refreshing ${keyArr.length} ${this.definition.typeName}...`);
         Util.logger.debug(`Refreshing keys: ${keyArr.join(', ')}`);
-        for (const key of keyArr) {
-            refreshList.push(this._refreshItem(key, checkKey));
-        }
-        const successCounter = (await Promise.all(refreshList)).filter(Boolean).length;
-        Util.logger.info(`Refreshed ${successCounter} of ${keyArr.length}`);
-        console.timeEnd('Time'); // eslint-disable-line no-console
+        const refreshedKeyArr = [];
+        const rateLimit = pLimit(10);
+        await Promise.all(
+            keyArr.map((key) =>
+                rateLimit(async () => {
+                    const result = await this._refreshItem(key, checkKey);
+                    if (result) {
+                        refreshedKeyArr.push(key);
+                    }
+                })
+            )
+        );
+        Util.logger.info(
+            `Refreshed ${refreshedKeyArr.length} of ${keyArr.length} ${this.definition.type}`
+        );
+        return refreshedKeyArr;
     }
 
     /**
@@ -347,7 +358,6 @@ class TriggeredSend extends MetadataType {
     static async findRefreshableItems(assetLoaded = false) {
         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',
@@ -359,13 +369,31 @@ class TriggeredSend extends MetadataType {
                 'triggered_send',
                 'triggered_send_journeybuilder',
             ],
-            asset: ['message'],
-            list: null,
         };
+        for (const dep of this.definition.dependencies) {
+            if (dep === 'email') {
+                // skip deprecated classic emails here, assuming they cannot be updated and hence are not relevant for {@link refresh}
+                continue;
+            }
+            const [type, subtype] = dep.split('-');
+            if (requiredCache[type]) {
+                requiredCache[type].push(subtype);
+            } else {
+                requiredCache[type] = subtype ? [subtype] : null;
+            }
+        }
+        for (const [type, subTypeArr] of Object.entries(requiredCache)) {
+            if (Array.isArray(subTypeArr)) {
+                // make sure entries are unique
+                requiredCache[type] = [...new Set(subTypeArr)];
+            }
+        }
         const cacheTypes = {
             asset,
             folder,
             list,
+            sendClassification,
+            senderProfile,
         };
         for (const [type, subTypeArr] of Object.entries(requiredCache)) {
             if (type === 'asset' && assetLoaded) {
@@ -373,6 +401,9 @@ class TriggeredSend extends MetadataType {
             }
             Util.logger.info(` - Caching dependent Metadata: ${type}`);
             Util.logSubtypes(subTypeArr);
+            if (!cacheTypes[type]) {
+                throw new Error(`Cache type ${type} not implemented.`);
+            }
             cacheTypes[type].client = this.client;
             cacheTypes[type].buObject = this.buObject;
             cacheTypes[type].properties = this.properties;
@@ -452,7 +483,7 @@ class TriggeredSend extends MetadataType {
                 throw new Error(test.Results[0].StatusMessage);
             }
             delete item.TriggeredSendStatus;
-            Util.logger.info(` - paused ${this.definition.typeName}: ${key}`);
+            Util.logger.info(` - 🛑 paused ${this.definition.typeName}: ${key}`);
         } catch (ex) {
             const errorMsg = super.getSOAPErrorMsg(ex);
 
@@ -470,7 +501,7 @@ class TriggeredSend extends MetadataType {
                 throw new Error(test.Results[0].StatusMessage);
             }
             delete item.RefreshContent;
-            Util.logger.info(` - published ${this.definition.typeName}: ${key}`);
+            Util.logger.info(` - 🔃 published ${this.definition.typeName}: ${key}`);
         } catch (ex) {
             const errorMsg = super.getSOAPErrorMsg(ex);
             Util.logger.error(
@@ -487,7 +518,7 @@ class TriggeredSend extends MetadataType {
                 throw new Error(test.Results[0].StatusMessage);
             }
             delete item.RefreshContent;
-            Util.logger.info(` - started ${this.definition.typeName}: ${key}`);
+            Util.logger.info(` - ✅ started ${this.definition.typeName}: ${key}`);
         } catch (ex) {
             const errorMsg = super.getSOAPErrorMsg(ex);
             Util.logger.error(

package/lib/metadataTypes/definitions/Automation.definition.js

@@ -27,6 +27,7 @@ export default {
         'dataExtract',
         'emailSend',
         'fileTransfer',
+        'fileLocation',
         'folder-automations',
         'importFile',
         'query',

package/lib/metadataTypes/definitions/Journey.definition.js

@@ -60,6 +60,7 @@ export default {
     lastmodNameField: null,
     restPagination: true,
     restPageSize: 500,
+    maxKeyLength: 200, // confirmed max length
     type: 'journey',
     typeDescription: 'Journey (internally called "Interaction").',
     typeRetrieveByDefault: true,

package/lib/metadataTypes/definitions/TransactionalEmail.definition.js

@@ -20,6 +20,7 @@ export default {
     lastmodNameField: null,
     restPagination: true,
     restPageSize: 100,
+    maxKeyLength: 36, // confirmed max length
     type: 'transactionalEmail',
     typeDescription: 'Lets you send immediate Email messages via API events',
     typeRetrieveByDefault: true,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "7.5.0",
+    "version": "7.6.1",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -71,7 +71,7 @@
         "beauty-amp-core2": "0.4.9",
         "cli-progress": "3.12.0",
         "command-exists": "1.2.9",
-        "conf": "13.0.1",
+        "conf": "13.1.0",
         "console.table": "0.10.0",
         "deep-equal": "2.2.3",
         "fs-extra": "11.2.0",
@@ -79,45 +79,45 @@
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
         "p-limit": "6.1.0",
-        "prettier": "3.3.3",
+        "prettier": "3.4.2",
         "prettier-plugin-sql": "0.18.1",
         "semver": "7.6.3",
         "sfmc-sdk": "2.1.2",
         "simple-git": "3.27.0",
         "toposort": "2.0.2",
         "update-notifier": "7.3.1",
-        "winston": "3.15.0",
+        "winston": "3.17.0",
         "yargs": "17.7.2",
         "yocto-spinner": "0.1.1"
     },
     "devDependencies": {
-        "@eslint/js": "9.10.0",
+        "@eslint/js": "9.17.0",
         "@types/fs-extra": "11.0.4",
         "@types/inquirer": "9.0.7",
         "@types/mocha": "10.0.8",
-        "@types/node": "22.9.0",
+        "@types/node": "22.10.2",
         "@types/yargs": "17.0.33",
         "assert": "2.1.0",
-        "axios-mock-adapter": "2.1.0",
+        "axios-mock-adapter": "2.0.0",
         "c8": "10.0.0",
-        "chai": "5.1.1",
+        "chai": "5.1.2",
         "chai-files": "1.4.0",
-        "eslint": "9.10.0",
+        "eslint": "9.17.0",
         "eslint-config-prettier": "9.1.0",
         "eslint-config-ssjs": "2.0.0",
-        "eslint-plugin-jsdoc": "50.5.0",
+        "eslint-plugin-jsdoc": "50.6.1",
         "eslint-plugin-mocha": "10.5.0",
         "eslint-plugin-prettier": "5.2.1",
-        "eslint-plugin-unicorn": "56.0.0",
+        "eslint-plugin-unicorn": "56.0.1",
         "fast-xml-parser": "4.4.1",
-        "globals": "15.12.0",
-        "husky": "9.1.6",
+        "globals": "15.14.0",
+        "husky": "9.1.7",
         "lint-staged": "15.2.10",
-        "mocha": "10.7.3",
+        "mocha": "11.0.1",
         "mock-fs": "5.3.0",
         "npm-run-all": "4.1.5",
         "prettier-eslint": "16.3.0",
-        "typescript": "5.6.3"
+        "typescript": "5.7.2"
     },
     "optionalDependencies": {
         "fsevents": "*"

package/test/general.test.js

@@ -708,7 +708,7 @@ describe('GENERAL', () => {
                 // download first before we test buildTemplate
                 await handler.retrieve('testInstance/testBU', ['automation', 'query']);
 
-                const expectedApiCallsRetrieve = 30;
+                const expectedApiCallsRetrieve = 31;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,
@@ -813,7 +813,7 @@ describe('GENERAL', () => {
             });
 
             it('buildTemplate + buildDefinition for multiple types with keys and --retrieve', async () => {
-                const expectedApiCallsRetrieve = 30;
+                const expectedApiCallsRetrieve = 31;
 
                 // preparation
                 const argvMetadata = [
@@ -1170,7 +1170,7 @@ describe('GENERAL', () => {
                 // download first before we test buildTemplate
                 await handler.retrieve('testInstance/testBU', ['automation', 'query']);
 
-                const expectedApiCallsRetrieve = 30;
+                const expectedApiCallsRetrieve = 31;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,
@@ -1362,7 +1362,7 @@ describe('GENERAL', () => {
                 // download first before we test buildTemplate
                 await handler.retrieve('testInstance/testBU', ['automation', 'query']);
 
-                const expectedApiCallsRetrieve = 30;
+                const expectedApiCallsRetrieve = 31;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,
@@ -1669,7 +1669,7 @@ describe('GENERAL', () => {
                 // download first before we test buildTemplate
                 await handler.retrieve('testInstance/testBU', ['automation', 'query']);
 
-                const expectedApiCallsRetrieve = 30;
+                const expectedApiCallsRetrieve = 31;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,

package/test/mockRoot/.mcdevrc.json

@@ -126,5 +126,5 @@
             "verification"
         ]
     },
-    "version": "7.5.0"
+    "version": "7.6.1"
 }