mcdev 7.1.3 → 7.2.0

package/lib/util/util.js

@@ -53,6 +53,7 @@ export const Util = {
     packageJsonMcdev: readJsonSync(path.join(__dirname, '../../package.json')),
     OPTIONS: {},
     changedKeysMap: {},
+
     /**
      * helper that allows filtering an object by its keys
      *
@@ -71,6 +72,7 @@ export const Util = {
                 return obj;
             }, {});
     },
+
     /**
      * extended Array.includes method that allows check if an array-element starts with a certain string
      *
@@ -81,6 +83,7 @@ export const Util = {
     includesStartsWith(arr, search) {
         return this.includesStartsWithIndex(arr, search) >= 0;
     },
+
     /**
      * extended Array.includes method that allows check if an array-element starts with a certain string
      *
@@ -91,6 +94,7 @@ export const Util = {
     includesStartsWithIndex(arr, search) {
         return Array.isArray(arr) ? arr.findIndex((el) => el.startsWith(search)) : -1;
     },
+
     /**
      * check if a market name exists in current mcdev config
      *
@@ -156,6 +160,7 @@ export const Util = {
             throw new Error(`Market List ${mlName} is not defined`);
         }
     },
+
     /**
      * used to ensure the program tells surrounding software that an unrecoverable error occured
      *
@@ -165,6 +170,7 @@ export const Util = {
         // Util.logger.debug('Util.signalFataError() sets process.exitCode = 1 unless already set');
         process.exitCode ||= 1;
     },
+
     /**
      * SFMC accepts multiple true values for Boolean attributes for which we are checking here.
      * The same problem occurs when evaluating boolean CLI flags
@@ -175,6 +181,7 @@ export const Util = {
     isTrue(attrValue) {
         return ['true', 'TRUE', 'True', '1', 1, 'Y', 'y', true].includes(attrValue);
     },
+
     /**
      * SFMC accepts multiple false values for Boolean attributes for which we are checking here.
      * The same problem occurs when evaluating boolean CLI flags
@@ -285,6 +292,7 @@ export const Util = {
 
         return typeChoices;
     },
+
     /**
      * wrapper around our standard winston logging to console and logfile
      *
@@ -367,6 +375,7 @@ export const Util = {
      * @type {Logger}
      */
     logger: null,
+
     /**
      * initiate winston logger
      *
@@ -439,6 +448,7 @@ export const Util = {
                 /* eslint-enable unicorn/prefer-ternary */
                 myWinston.debug(stack);
             },
+
             /**
              * errors should cause surrounding applications to take notice
              * hence we overwrite the default error function here
@@ -458,6 +468,7 @@ export const Util = {
             `:: mcdev ${Util.packageJsonMcdev.version} :: ⚡ mcdev ${processArgv.join(' ')}`
         );
     },
+
     /**
      * Logger helper for Metadata functions
      *
@@ -484,6 +495,7 @@ export const Util = {
             Util.logger[level](`${type}.${method}: ${prependSource}${JSON.stringify(payload)}`);
         }
     },
+
     /**
      * replaces values in a JSON object string, based on a series of
      * key-value pairs (obj)
@@ -663,6 +675,7 @@ export const Util = {
     resolveObjPath(path, obj) {
         return path.split('.').reduce((prev, curr) => (prev ? prev[curr] : null), obj);
     },
+
     /**
      * helper to run other commands as if run manually by user
      *
@@ -693,6 +706,7 @@ export const Util = {
             return null;
         }
     },
+
     /**
      * standardize check to ensure only one result is returned from template search
      *
@@ -714,6 +728,7 @@ export const Util = {
             return matching[0];
         }
     },
+
     /**
      * configures what is displayed in the console
      *
@@ -749,6 +764,7 @@ export const Util = {
             Util.logger.level = Util.OPTIONS.loggerLevel;
         }
     },
+
     /**
      * outputs a warning that the given type is still in beta
      *
@@ -789,6 +805,7 @@ export const Util = {
         bgWhite: '\x1B[47m',
         bgGray: '\x1B[100m',
     },
+
     /**
      * helper that wraps a message in the correct color codes to have them printed gray
      *
@@ -798,6 +815,7 @@ export const Util = {
     getGrayMsg(msg) {
         return `${Util.color.dim}${msg}${Util.color.reset}`;
     },
+
     /**
      * helper to print the subtypes we filtered by
      *
@@ -814,6 +832,7 @@ export const Util = {
             );
         }
     },
+
     /**
      * helper to print the subtypes we filtered by
      *
@@ -836,6 +855,7 @@ export const Util = {
         }
         return '';
     },
+
     /**
      * pause execution of code; useful when multiple server calls are dependent on each other and might not be executed right away
      *
@@ -851,6 +871,7 @@ export const Util = {
             setTimeout(resolve, ms);
         });
     },
+
     /**
      * helper for Asset.extractCode and Script.prepExtractedCode to determine if a code block is a valid SSJS block
      *
@@ -904,6 +925,7 @@ export const Util = {
         // no script found
         return null;
     },
+
     /**
      * allows us to filter just like with SQL's LIKE operator
      *
@@ -925,6 +947,7 @@ export const Util = {
         // Check matches
         return new RegExp('^' + search + '$', 'gi').test(testString);
     },
+
     /**
      * returns true if no LIKE filter is defined or if all filters match
      *
@@ -962,6 +985,7 @@ export const Util = {
             return false;
         });
     },
+
     /**
      * helper used by SOAP methods to ensure the type always uses an upper-cased first letter
      *
@@ -971,6 +995,7 @@ export const Util = {
     capitalizeFirstLetter(str) {
         return str.charAt(0).toUpperCase() + str.slice(1);
     },
+
     /**
      * helper for Retriever and Deployer class
      *
@@ -996,6 +1021,7 @@ export const Util = {
         }
         return typeKeyMap;
     },
+
     /**
      * helper that converts TypeKeyCombo objects into a string with all relevant -m parameters
      *
@@ -1016,6 +1042,7 @@ export const Util = {
                   .join(' ')
             : '';
     },
+
     /**
      * helper that converts TypeKeyCombo objects into a string with all relevant -m parameters
      *
@@ -1049,6 +1076,7 @@ export const Util = {
                   .join(', ')
             : '';
     },
+
     /**
      * helper that checks how many keys are defined in TypeKeyCombo object
      *
@@ -1078,6 +1106,7 @@ export const Util = {
             }
         }
     },
+
     /**
      *
      * @param {Array} array array to be chunked

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "7.1.3",
+    "version": "7.2.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -71,7 +71,7 @@
         "console.table": "0.10.0",
         "deep-equal": "2.2.3",
         "fs-extra": "11.2.0",
-        "inquirer": "10.0.1",
+        "inquirer": "10.1.8",
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
         "p-limit": "6.1.0",
@@ -81,38 +81,38 @@
         "sfmc-sdk": "2.1.2",
         "simple-git": "3.25.0",
         "toposort": "2.0.2",
-        "update-notifier": "7.0.0",
-        "winston": "3.13.1",
+        "update-notifier": "7.2.0",
+        "winston": "3.14.2",
         "yargs": "17.7.2"
     },
     "devDependencies": {
-        "@eslint/js": "9.7.0",
+        "@eslint/js": "9.9.0",
         "@types/fs-extra": "11.0.4",
         "@types/inquirer": "9.0.7",
         "@types/mocha": "10.0.7",
-        "@types/node": "22.0.2",
-        "@types/yargs": "17.0.32",
+        "@types/node": "22.4.2",
+        "@types/yargs": "17.0.33",
         "assert": "2.1.0",
-        "axios-mock-adapter": "1.22.0",
+        "axios-mock-adapter": "2.0.0",
         "c8": "10.0.0",
         "chai": "5.1.1",
         "chai-files": "1.4.0",
-        "eslint": "9.8.0",
+        "eslint": "9.9.0",
         "eslint-config-prettier": "9.1.0",
         "eslint-config-ssjs": "2.0.0",
-        "eslint-plugin-jsdoc": "48.8.3",
+        "eslint-plugin-jsdoc": "50.2.2",
         "eslint-plugin-mocha": "10.5.0",
         "eslint-plugin-prettier": "5.2.1",
         "eslint-plugin-unicorn": "55.0.0",
         "fast-xml-parser": "4.4.1",
-        "globals": "15.8.0",
-        "husky": "9.1.4",
-        "lint-staged": "15.2.7",
-        "mocha": "10.7.0",
+        "globals": "15.9.0",
+        "husky": "9.1.5",
+        "lint-staged": "15.2.9",
+        "mocha": "10.7.3",
         "mock-fs": "5.2.0",
         "npm-run-all": "4.1.5",
         "prettier-eslint": "16.3.0",
-        "typescript": "5.5.3"
+        "typescript": "5.5.4"
     },
     "optionalDependencies": {
         "fsevents": "*"

package/test/general.test.js

@@ -61,7 +61,7 @@ describe('GENERAL', () => {
 
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
-                    36,
+                    38,
                     'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
                 );
                 return;
@@ -110,7 +110,7 @@ describe('GENERAL', () => {
 
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
-                    36,
+                    38,
                     'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
                 );
                 return;
@@ -159,7 +159,7 @@ describe('GENERAL', () => {
 
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
-                    36,
+                    38,
                     'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
                 );
                 return;
@@ -231,7 +231,7 @@ describe('GENERAL', () => {
 
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
-                    84,
+                    86,
                     'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
                 );
                 return;
@@ -296,7 +296,7 @@ describe('GENERAL', () => {
 
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
-                    84,
+                    86,
                     'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
                 );
                 return;
@@ -361,7 +361,7 @@ describe('GENERAL', () => {
 
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
-                    84,
+                    86,
                     'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
                 );
                 return;
@@ -478,7 +478,7 @@ describe('GENERAL', () => {
                 );
                 assert.equal(
                     Object.keys(result[buName]['dataExtension']).length,
-                    7,
+                    8,
                     'retrieve should have returned 7 dataExtension'
                 );
                 assert.equal(
@@ -918,7 +918,7 @@ describe('GENERAL', () => {
                 // download first before we test buildTemplate
                 await handler.retrieve('testInstance/testBU');
 
-                const expectedApiCallsRetrieve = 78;
+                const expectedApiCallsRetrieve = 81;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,
@@ -1046,7 +1046,7 @@ describe('GENERAL', () => {
             });
 
             it('buildTemplate + buildDefinition for multiple types with keys and --dependencies and --retrieve', async () => {
-                const expectedApiCallsRetrieve = 82;
+                const expectedApiCallsRetrieve = 85;
 
                 // preparation
                 const argvMetadata = [
@@ -1454,7 +1454,7 @@ describe('GENERAL', () => {
                 // download everything before we test buildTemplate
                 await handler.retrieve('testInstance/testBU');
 
-                const expectedApiCallsRetrieve = 78;
+                const expectedApiCallsRetrieve = 81;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,
@@ -1564,7 +1564,7 @@ describe('GENERAL', () => {
             });
 
             it('build multiple type with keys and --dependencies and --retrieve', async () => {
-                const expectedApiCallsRetrieve = 82;
+                const expectedApiCallsRetrieve = 85;
 
                 // preparation
                 const argvMetadata = [
@@ -1849,7 +1849,7 @@ describe('GENERAL', () => {
                 // download first before we test buildTemplate
                 await handler.retrieve('testInstance/testBU');
 
-                const expectedApiCallsRetrieve = 78;
+                const expectedApiCallsRetrieve = 81;
                 assert.equal(
                     testUtils.getAPIHistoryLength(),
                     expectedApiCallsRetrieve,
@@ -2075,7 +2075,7 @@ describe('GENERAL', () => {
                 assert.equal(process.exitCode, 0, 'publish should not have thrown an error');
                 assert.deepEqual(
                     publish['testInstance/testBU']?.journey,
-                    ['id:3c3f4112-9b43-43ca-8a89-aa0375b2c1a2/1'],
+                    ['testExisting_journey_Quicksend'],
                     'should have published the right journey'
                 );
                 return;

package/test/mockRoot/.mcdevrc.json

@@ -100,5 +100,5 @@
             "verification"
         ]
     },
-    "version": "7.1.3"
+    "version": "7.2.0"
 }

package/test/resourceFactory.js

@@ -2,6 +2,13 @@ import fs from 'fs-extra';
 import path from 'node:path';
 import { XMLParser } from 'fast-xml-parser';
 import { Util } from '../lib/util/util.js';
+
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const projectRootHelper = __dirname.split(path.sep);
+projectRootHelper.pop();
+const projectRoot = projectRootHelper.join(path.sep) + path.sep;
+
 const parser = new XMLParser();
 const attributeParser = new XMLParser({ ignoreAttributes: false });
 /** @type {typeof Util.color} */
@@ -32,6 +39,7 @@ if (Util.isRunViaVSCodeExtension) {
 
 export const tWarn = `${color.bgYellow}${color.fgBlack}TEST-WARNING${color.reset}`;
 export const tError = `${color.bgRed}${color.fgBlack}TEST-ERROR${color.reset}`;
+
 /**
  * gets mock SOAP metadata for responding
  *
@@ -47,6 +55,7 @@ async function loadSOAPRecords(mcdevAction, type, mid, filter, QueryAllAccounts)
     const testPath = path.join('test', 'resources', mid.toString(), type, mcdevAction);
     const filterPath = getFilterPath(filter, QueryAllAccounts);
     if (await fs.pathExists(testPath + filterPath + '-response.xml')) {
+        console.log('loading ' + projectRoot + testPath + filterPath + '-response.xml'); // eslint-disable-line no-console
         return fs.readFile(testPath + filterPath + '-response.xml', {
             encoding: 'utf8',
         });
@@ -62,6 +71,7 @@ async function loadSOAPRecords(mcdevAction, type, mid, filter, QueryAllAccounts)
             );
             /* eslint-enable no-console */
         }
+        console.log('loading ' + projectRoot + testPath + '-response.xml'); // eslint-disable-line no-console
         return fs.readFile(testPath + '-response.xml', {
             encoding: 'utf8',
         });
@@ -80,6 +90,7 @@ async function loadSOAPRecords(mcdevAction, type, mid, filter, QueryAllAccounts)
         encoding: 'utf8',
     });
 }
+
 /**
  * helper for {@link loadSOAPRecords} to get the filter path
  *
@@ -119,6 +130,7 @@ export function filterToPath(filter, shorten) {
     }
     return '';
 }
+
 /**
  * helper for filterToPath
  *
@@ -155,6 +167,7 @@ function _filterToPath(filter, shorten) {
         throw new Error('unknown filter type');
     }
 }
+
 /**
  * based on request, respond with different soap data
  *
@@ -179,11 +192,15 @@ export const handleSOAPRequest = async (config) => {
             break;
         }
         case 'Create': {
+            let filter = null;
+            if (fullObj.Envelope.Body.CreateRequest.Objects['@_xsi:type'] === 'DataFolder') {
+                filter = `ContentType=${fullObj.Envelope.Body.CreateRequest.Objects.ContentType},Name=${fullObj.Envelope.Body.CreateRequest.Objects.Name},ParentFolderID=${fullObj.Envelope.Body.CreateRequest.Objects.ParentFolder.ID}`;
+            }
             responseXML = await loadSOAPRecords(
                 config.headers.SOAPAction.toLocaleLowerCase(),
                 fullObj.Envelope.Body.CreateRequest.Objects['@_xsi:type'],
                 jObj.Envelope.Header.fueloauth,
-                null
+                filter
             );
 
             break;
@@ -297,6 +314,12 @@ export const handleRESTRequest = async (config) => {
             if (myObj) {
                 const op = simpleOperators[myObj.simpleOperator];
                 filterBody = `${myObj.property}${op}${op === 'IN' ? myObj.value.join(',') : myObj.value}`;
+            } else if (config.url === '/email/v1/category') {
+                const data = JSON.parse(config.data);
+
+                filterBody = Object.keys(data)
+                    .map((key) => `${key}=${data[key]}`)
+                    .join(',');
             }
         }
         const testPathFilterBody = filterBody ? testPath + '-' + filterBody : null;
@@ -313,7 +336,7 @@ export const handleRESTRequest = async (config) => {
                 response.count = response.items.length;
                 return [200, JSON.stringify(response)];
             } else {
-                console.log('loading ' + testPathFilter + '.json'); // eslint-disable-line no-console
+                console.log('loading ' + projectRoot + testPathFilter + '.json'); // eslint-disable-line no-console
                 return [
                     200,
                     await fs.readFile(testPathFilter + '.json', {
@@ -329,7 +352,7 @@ export const handleRESTRequest = async (config) => {
                 }),
             ];
         } else if (testPathFilterBody && (await fs.pathExists(testPathFilterBody + '.json'))) {
-            console.log('loading ' + testPathFilterBody + '.json'); // eslint-disable-line no-console
+            console.log('loading ' + projectRoot + testPathFilterBody + '.json'); // eslint-disable-line no-console
             return [
                 200,
                 await fs.readFile(testPathFilterBody + '.json', {
@@ -379,7 +402,7 @@ export const handleRESTRequest = async (config) => {
                 response.count = response.items.length;
                 return [200, JSON.stringify(response)];
             } else {
-                console.log('loading ' + testPath + '.json'); // eslint-disable-line no-console
+                console.log('loading ' + projectRoot + testPath + '.json'); // eslint-disable-line no-console
 
                 return [
                     200,

package/test/resources/9999999/dataExtension/retrieve-response.xml

@@ -190,6 +190,35 @@
                 <RetainUntil />
                 <CategoryID>2</CategoryID>
             </Results>
+            <Results xsi:type="DataExtension">
+                <PartnerKey xsi:nil="true" />
+                <CreatedDate>2024-08-21T09:54:28.807</CreatedDate>
+                <ModifiedDate>2024-08-21T09:54:28.807</ModifiedDate>
+                <ObjectID>3c3a54a5-d55f-ef11-b876-f40343c95928</ObjectID>
+                <CustomerKey>testExisting_temail_notPublished</CustomerKey>
+                <Name>testExisting_temail_notPublished</Name>
+                <Description>Triggered Send Source Data Extension Template</Description>
+                <IsSendable>true</IsSendable>
+                <IsTestable>false</IsTestable>
+                <SendableDataExtensionField>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <Name>SubscriberKey</Name>
+                </SendableDataExtensionField>
+                <SendableSubscriberField>
+                    <Name>_SubscriberKey</Name>
+                </SendableSubscriberField>
+                <Template>
+                    <PartnerKey xsi:nil="true" />
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>B6E8AE4C-3D93-49B1-B299-E0AE734213DD</CustomerKey>
+                </Template>
+                <RowBasedRetention>false</RowBasedRetention>
+                <ResetRetentionPeriodOnImport>false</ResetRetentionPeriodOnImport>
+                <DeleteAtEndOfRetentionPeriod>false</DeleteAtEndOfRetentionPeriod>
+                <RetainUntil />
+                <CategoryID>2</CategoryID>
+            </Results>
         </RetrieveResponseMsg>
     </soap:Body>
 </soap:Envelope>