mcdev 7.0.1 → 7.0.3

package/lib/util/init.config.js

@@ -240,7 +240,9 @@ const Init = {
         const creationLog = [];
         await File.ensureDir('deploy/');
         await File.ensureDir('src/cloudPages');
-        const relevantForcedUpdates = await this._getForcedUpdateList(versionBeforeUpgrade);
+        const relevantForced = await this._getForcedUpdateList(versionBeforeUpgrade);
+
+        await this._removeIdeConfigFiles(relevantForced);
 
         // copy in .gitignore (cant be retrieved via npm install directly)
         const gitignoreFileName = path.resolve(
@@ -253,7 +255,7 @@ const Init = {
             creationLog.push(
                 await this._createIdeConfigFile(
                     ['.' + path.sep, '', '.gitignore'],
-                    relevantForcedUpdates,
+                    relevantForced,
                     fileContent
                 )
             );
@@ -280,7 +282,7 @@ const Init = {
                         creationLog.push(
                             await this._createIdeConfigFile(
                                 [subdir + path.sep, fileArr.join('.'), ext],
-                                relevantForcedUpdates
+                                relevantForced
                             )
                         );
                     }
@@ -328,12 +330,13 @@ const Init = {
      * returns list of files that need to be updated
      *
      * @param {string} projectVersion version found in config file of the current project
-     * @returns {Promise.<string[]>} relevant files with path that need to be updated
+     * @returns {Promise.<{updates:string[],deletes:string[]}>} relevant files with path that need to be updated
      */
     async _getForcedUpdateList(projectVersion) {
         // list of files that absolutely need to get overwritten, no questions asked, when upgrading from a version lower than the given.
         let forceIdeConfigUpdate;
-        const relevantForcedUpdates = [];
+        const updates = [];
+        const deletes = [];
         if (await File.pathExists(Util.configFileName)) {
             forceIdeConfigUpdate = await File.readJSON(
                 path.resolve(__dirname, Util.boilerplateDirectory, 'forcedUpdates.json')
@@ -341,27 +344,33 @@ const Init = {
             // return all if no project version was found or only changes from "newer" versions otherwise
             for (const element of forceIdeConfigUpdate) {
                 if (!projectVersion || semver.gt(element.version, projectVersion)) {
-                    relevantForcedUpdates.push(
+                    updates.push(
                         // adapt it for local file systems
                         ...element.files.map((item) => path.normalize(item))
                     );
+                    if (element.filesRemove) {
+                        deletes.push(
+                            // adapt it for local file systems
+                            ...element.filesRemove.map((item) => path.normalize(item))
+                        );
+                    }
                 } else {
                     continue;
                 }
             }
         }
 
-        return relevantForcedUpdates;
+        return { updates, deletes };
     },
     /**
      * handles creation/update of one config file from the boilerplate at a time
      *
      * @param {string[]} fileNameArr 0: path, 1: filename, 2: extension with dot
-     * @param {string[]} relevantForcedUpdates if fileNameArr is in this list we require an override
+     * @param {{updates:string[],deletes:string[]}} relevantForced if fileNameArr is in this list we require an override
      * @param {string} [boilerplateFileContent] in case we cannot copy files 1:1 this can be used to pass in content
      * @returns {Promise.<boolean>} install successful or error occured
      */
-    async _createIdeConfigFile(fileNameArr, relevantForcedUpdates, boilerplateFileContent) {
+    async _createIdeConfigFile(fileNameArr, relevantForced, boilerplateFileContent) {
         let update = false;
         const fileName = fileNameArr.join('');
         const boilerplateFileName = path.resolve(
@@ -372,16 +381,27 @@ const Init = {
         );
         boilerplateFileContent ||= await File.readFile(boilerplateFileName, 'utf8');
 
+        let todo = null;
+
         if (await File.pathExists(fileName)) {
-            const existingFileContent = await File.readFile(fileName, 'utf8');
-            if (existingFileContent === boilerplateFileContent) {
-                Util.logger.info(`- ✔️  ${fileName} found. No update needed`);
-                return true;
+            if (relevantForced.deletes.includes(path.normalize(fileName))) {
+                Util.logger.info(
+                    `- ✋  ${fileName} found but it is required to delete it. Commencing rename instead for your convenience:`
+                );
+                todo = 'delete';
+            } else {
+                const existingFileContent = await File.readFile(fileName, 'utf8');
+                if (existingFileContent === boilerplateFileContent) {
+                    Util.logger.info(`- ✔️  ${fileName} found. No update needed`);
+                    return true;
+                }
             }
-            if (relevantForcedUpdates.includes(path.normalize(fileName))) {
+
+            if (relevantForced.updates.includes(path.normalize(fileName))) {
                 Util.logger.info(
                     `- ✋  ${fileName} found but an update is required. Commencing with override:`
                 );
+                todo = 'update';
             } else {
                 Util.logger.info(
                     `- ✋  ${fileName} found with differences to the new standard version. We recommend updating it.`
@@ -400,33 +420,60 @@ const Init = {
                         return true;
                     }
                 }
+                update = true;
             }
-            update = true;
 
             // ensure our update is not leading to data loss in case config files were not versioned correctly by the user
             await File.rename(fileName, fileName + '.BAK');
+        } else if (!relevantForced.deletes.includes(path.normalize(fileName))) {
+            todo = 'create';
         }
-        const saveStatus = await File.writeToFile(
-            fileNameArr[0],
-            fileNameArr[1],
-            fileNameArr[2].slice(1),
-            boilerplateFileContent
-        );
-
-        if (saveStatus) {
-            Util.logger.info(
-                `- ✔️  ${fileName} ${
-                    update
-                        ? `updated (we created a backup of the old file under ${fileName + '.BAK'})`
-                        : 'created'
-                }`
+        if (todo === 'create' || todo === 'update') {
+            const saveStatus = await File.writeToFile(
+                fileNameArr[0],
+                fileNameArr[1],
+                fileNameArr[2].slice(1),
+                boilerplateFileContent
             );
+
+            if (saveStatus) {
+                Util.logger.info(
+                    `- ✔️  ${fileName} ${
+                        update
+                            ? `updated (we created a backup of the old file under ${fileName + '.BAK'})`
+                            : 'created'
+                    }`
+                );
+                return true;
+            } else {
+                Util.logger.warn(`- ❌  ${fileName} ${update ? 'update' : 'creation'} failed`);
+                return false;
+            }
+        } else if (todo === 'delete') {
+            await File.rename(fileName, fileName + '.BAK');
+            Util.logger.info(`- ✔️  ${fileName} removed (renamed to ${fileName + '.BAK'})`);
             return true;
-        } else {
-            Util.logger.warn(`- ❌  ${fileName} ${update ? 'update' : 'creation'} failed`);
-            return false;
         }
     },
+    /**
+     * handles deletion of no longer needed config files
+     *
+     * @param {{updates:string[],deletes:string[]}} relevantForced if file is in .deletes, we require deleting/renaming it
+     * @returns {Promise.<boolean>} deletion successful or error occured
+     */
+    async _removeIdeConfigFiles(relevantForced) {
+        for (const fileName of relevantForced.deletes) {
+            if (await File.pathExists(fileName)) {
+                Util.logger.info(
+                    `- ✋  ${fileName} found but it is required to delete it. Commencing rename instead for your convenience:`
+                );
+
+                await File.rename(fileName, fileName + '.BAK');
+                Util.logger.info(`- ✔️  ${fileName} removed (renamed to ${fileName + '.BAK'})`);
+            }
+        }
+        return true;
+    },
     /**
      * helper method for this.upgradeProject that upgrades project config if needed
      *

package/lib/util/init.npm.js

@@ -57,6 +57,8 @@ const Init = {
                 if (fileContent) {
                     projectPackageJson = JSON.parse(fileContent);
                 }
+                // type="module" is solely required for the new flat configs of ESLint >=9
+                Util.execSync('npm', ['pkg', 'set', 'type="module"'], true);
                 Util.logger.info('✔️  package.json created');
             } catch {
                 Util.logger.error('No package.json found. Please run "npm init" manually');
@@ -105,6 +107,8 @@ const Init = {
                 !projectPackageJson.devDependencies ||
                 !projectPackageJson.devDependencies[name] ||
                 versionsDefault[name] == 'latest' ||
+                // filters out file:.. references instead of versions that would otherwise lead to an error in semver.gt()
+                !semver.valid(versionsProject[name]) ||
                 semver.gt(versionsDefault[name], versionsProject[name])
         );
         if (loadDependencies.length) {
@@ -152,6 +156,10 @@ const Init = {
         if (!currentContent.license || currentContent.license === 'ISC') {
             currentContent.license = 'UNLICENSED';
         }
+        if (!currentContent.type || currentContent.type !== 'module') {
+            // type="module" is solely required for the new flat configs of ESLint >=9
+            currentContent.type = 'module';
+        }
         return currentContent;
     },
 };

package/lib/util/replaceContentBlockReference.js

@@ -45,7 +45,7 @@ export default class ReplaceContentBlockReference {
         key: {},
         name: {},
     };
-    /** @type {{id: RegExp[], key: RegExp[], name: RegExp[]}} */
+    /** @type {Object.<string, {id: RegExp[], key: RegExp[], name: RegExp[]}>} */
     static #regexBy = {
         // TODO: handle cases in which variables or functions are passed into ContentBlockByX
 
@@ -140,7 +140,6 @@ export default class ReplaceContentBlockReference {
     }
     /**
      *
-     * @private
      * @param {ContentBlockConversionTypes} from replace with
      * @param {string|number} identifier id, key or name of asset
      * @param {string} parentName name of the object that was passed in; used in error message only
@@ -250,6 +249,7 @@ saved
         const resultAssetShared = await Asset.retrieveForCache(
             undefined,
             ['asset', 'code', 'textfile', 'block', 'other'],
+            undefined,
             true
         );
         for (const element of Object.values(resultAssetShared.metadata)) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "7.0.1",
+    "version": "7.0.3",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -67,7 +67,7 @@
         "beauty-amp-core2": "0.4.9",
         "cli-progress": "3.12.0",
         "command-exists": "1.2.9",
-        "conf": "12.0.0",
+        "conf": "13.0.1",
         "console.table": "0.10.0",
         "deep-equal": "2.2.3",
         "fs-extra": "11.2.0",
@@ -86,23 +86,25 @@
         "yargs": "17.7.2"
     },
     "devDependencies": {
+        "@eslint/js": "9.6.0",
         "@types/mocha": "10.0.6",
-        "@types/node": "20.14.2",
+        "@types/node": "20.14.9",
         "assert": "2.1.0",
         "axios-mock-adapter": "1.22.0",
         "c8": "10.0.0",
         "chai": "5.1.1",
         "chai-files": "1.4.0",
-        "eslint": "8.57.0",
+        "eslint": "9.6.0",
         "eslint-config-prettier": "9.1.0",
-        "eslint-config-ssjs": "1.1.11",
+        "eslint-config-ssjs": "2.0.0",
         "eslint-plugin-jsdoc": "48.2.7",
         "eslint-plugin-mocha": "10.4.3",
         "eslint-plugin-prettier": "5.1.2",
         "eslint-plugin-unicorn": "53.0.0",
         "fast-xml-parser": "4.4.0",
+        "globals": "15.6.0",
         "husky": "9.0.11",
-        "lint-staged": "15.2.5",
+        "lint-staged": "15.2.7",
         "mocha": "10.4.0",
         "mock-fs": "5.2.0",
         "npm-run-all": "4.1.5",

package/test/mockRoot/.mcdevrc.json

@@ -100,5 +100,5 @@
             "verification"
         ]
     },
-    "version": "7.0.1"
+    "version": "7.0.3"
 }

package/test/resources/9999999/automation/create-callout-expected.json

@@ -0,0 +1,66 @@
+{
+    "description": "created on deploy",
+    "key": "testNew_automation",
+    "name": "testNew_automation",
+    "status": "Scheduled",
+    "steps": [
+        {
+            "activities": [
+                {
+                    "displayOrder": 1,
+                    "activityObjectId": "56c5370a-f988-4f36-b0ee-0f876573f6d7",
+                    "name": "testExisting_dataExtract",
+                    "objectTypeId": 73
+                },
+                {
+                    "displayOrder": 2,
+                    "activityObjectId": "9b1c7bf9-4964-ed11-b849-48df37d1de8b",
+                    "name": "testExisting_emailSend",
+                    "objectTypeId": 42
+                },
+                {
+                    "displayOrder": 3,
+                    "activityObjectId": "72c328ac-f5b0-4e37-91d3-a775666f15a6",
+                    "name": "testExisting_fileTransfer",
+                    "objectTypeId": 53
+                },
+                {
+                    "displayOrder": 4,
+                    "activityObjectId": "9d16f42c-2260-ed11-b849-48df37d1de8b",
+                    "name": "testExisting_importFile",
+                    "objectTypeId": 43
+                },
+                {
+                    "displayOrder": 5,
+                    "activityObjectId": "549f0568-607c-4940-afef-437965094dat",
+                    "name": "testExisting_query",
+                    "objectTypeId": 300
+                },
+                {
+                    "displayOrder": 6,
+                    "activityObjectId": "39f6a488-20eb-4ba0-b0b9-023725b574e4",
+                    "name": "testExisting_script",
+                    "objectTypeId": 423
+                },
+                {
+                    "displayOrder": 7,
+                    "activityObjectId": "testNew_RANDOM_NEW_GUID",
+                    "name": "testNew_RANDOM_NEW_GUID",
+                    "objectTypeId": 1000
+                }
+            ],
+            "annotation": "",
+            "stepNumber": 0
+        }
+    ],
+    "categoryId": 290937,
+    "startSource": {
+        "schedule": {
+            "startDate": "2020-05-14T02:30:32.11",
+            "endDate": "2079-06-06T21:00:00",
+            "icalRecur": "FREQ=MINUTELY;UNTIL=20790607T050000;INTERVAL=5",
+            "timezoneId": 5
+        },
+        "typeId": 1
+    }
+}

package/test/resources/9999999/automation/update-callout-expected.json

@@ -0,0 +1,68 @@
+{
+    "description": "updated on deploy",
+    "key": "testExisting_automation",
+    "name": "testExisting_automation",
+    "status": "PausedSchedule",
+    "steps": [
+        {
+            "activities": [
+                {
+                    "displayOrder": 1,
+                    "activityObjectId": "56c5370a-f988-4f36-b0ee-0f876573f6d7",
+                    "name": "testExisting_dataExtract",
+                    "objectTypeId": 73
+                },
+                {
+                    "displayOrder": 2,
+                    "activityObjectId": "9b1c7bf9-4964-ed11-b849-48df37d1de8b",
+                    "name": "testExisting_emailSend",
+                    "objectTypeId": 42
+                },
+                {
+                    "displayOrder": 3,
+                    "activityObjectId": "72c328ac-f5b0-4e37-91d3-a775666f15a6",
+                    "name": "testExisting_fileTransfer",
+                    "objectTypeId": 53
+                },
+                {
+                    "displayOrder": 4,
+                    "activityObjectId": "9d16f42c-2260-ed11-b849-48df37d1de8b",
+                    "name": "testExisting_importFile",
+                    "objectTypeId": 43
+                },
+                {
+                    "displayOrder": 5,
+                    "activityObjectId": "549f0568-607c-4940-afef-437965094dat",
+                    "name": "testExisting_query",
+                    "objectTypeId": 300
+                },
+                {
+                    "displayOrder": 6,
+                    "activityObjectId": "39f6a488-20eb-4ba0-b0b9-023725b574e4",
+                    "name": "testExisting_script",
+                    "objectTypeId": 423
+                }
+            ],
+            "annotation": "",
+            "stepNumber": 0
+        }
+    ],
+    "notifications": [
+        {
+            "email": ["error-updated@test.accenture.com"],
+            "message": "test updated",
+            "type": "Error"
+        }
+    ],
+    "categoryId": 290937,
+    "startSource": {
+        "schedule": {
+            "endDate": "2022-07-30T00:00:00",
+            "icalRecur": "FREQ=DAILY;COUNT=1;INTERVAL=1",
+            "startDate": "2022-07-30T00:00:00",
+            "timezoneId": 5
+        },
+        "typeId": 1
+    },
+    "id": "08afb0e2-b00a-4c88-ad2e-1f7f8788c560"
+}

package/test/resources/9999999/automation/v1/automations/08afb0e2-b00a-4c88-ad2e-1f7f8788c560/get-response.json

@@ -28,13 +28,6 @@
             "name": "",
             "step": 1,
             "activities": [
-                {
-                    "id": "8081a992-a27d-4a43-984a-d60114ea1025",
-                    "name": "testExisting_dataExtract",
-                    "activityObjectId": "56c5370a-f988-4f36-b0ee-0f876573f6d7",
-                    "objectTypeId": 73,
-                    "displayOrder": 1
-                },
                 {
                     "id": "d3774dc2-a271-4a44-8cbe-f630a6d6545e",
                     "name": "testExisting_emailSend",
@@ -42,6 +35,13 @@
                     "objectTypeId": 42,
                     "displayOrder": 2
                 },
+                {
+                    "id": "8081a992-a27d-4a43-984a-d60114ea1025",
+                    "name": "testExisting_dataExtract",
+                    "activityObjectId": "56c5370a-f988-4f36-b0ee-0f876573f6d7",
+                    "objectTypeId": 73,
+                    "displayOrder": 1
+                },
                 {
                     "id": "2c77fc42-85eb-4611-98f9-223d29d89d72",
                     "name": "testExisting_fileTransfer",

package/test/type.automation.test.js

@@ -85,13 +85,27 @@ describe('type: automation', () => {
                 5,
                 'three automations expected'
             );
+            // get what was sent to the server API
+            const createCallout = testUtils.getRestCallout('post', '/automation/v1/automations/%');
+            const updateCallout = testUtils.getRestCallout('patch', '/automation/v1/automations/%');
+
             // insert
+            assert.deepEqual(
+                createCallout,
+                await testUtils.getExpectedJson('9999999', 'automation', 'create-callout'),
+                'sent metadata was not equal expected for create'
+            );
             assert.deepEqual(
                 await testUtils.getActualJson('testNew_automation', 'automation'),
                 await testUtils.getExpectedJson('9999999', 'automation', 'create'),
                 'returned metadata was not equal expected for create'
             );
             // update
+            assert.deepEqual(
+                updateCallout,
+                await testUtils.getExpectedJson('9999999', 'automation', 'update-callout'),
+                'sent metadata was not equal expected for create'
+            );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_automation', 'automation'),
                 await testUtils.getExpectedJson('9999999', 'automation', 'update'),
@@ -147,6 +161,13 @@ describe('type: automation', () => {
                 5,
                 'five cached automation expected'
             );
+
+            // const scheduleCalloutList = testUtils.getSoapCallout('Schedule');
+            // const objectIds = {
+            //     testNew_automation: 'a8afb0e2-b00a-4c88-ad2e-1f7f8788c560',
+            //     testExisting_automation: '08afb0e2-b00a-4c88-ad2e-1f7f8788c560',
+            // };
+
             assert.equal(
                 deployed['testInstance/testBU'].automation
                     ? Object.keys(deployed['testInstance/testBU'].automation).length
@@ -169,7 +190,32 @@ describe('type: automation', () => {
                 'expected specific automation to have been deployed'
             );
 
+            // insert
+            // assert.equal(
+            //     scheduleCalloutList.find((item) => item.includes(objectIds['testNew_automation'])),
+            //     await testUtils.getExpectedFile(
+            //         '9999999',
+            //         'automation',
+            //         'schedule-callout-new',
+            //         'xml'
+            //     ),
+            //     'sent metadata was not equal expected for create'
+            // );
+
             // update
+            // assert.deepEqual(
+            //     scheduleCalloutList.find((item) =>
+            //         item.includes(objectIds['testExisting_automation'])
+            //     ),
+            //     await testUtils.getExpectedFile(
+            //         '9999999',
+            //         'automation',
+            //         'schedule-callout-existing',
+            //         'xml'
+            //     ),
+            //     'sent metadata was not equal expected for create'
+            // );
+
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_automation', 'automation'),
                 await testUtils.getExpectedJson('9999999', 'automation', 'update'),

package/test/utils.js

@@ -9,7 +9,7 @@ import { fileURLToPath } from 'node:url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // for some reason doesnt realize below reference
-// eslint-disable-next-line no-unused-vars
+
 import fsmock from 'mock-fs';
 
 let apimock;
@@ -184,8 +184,9 @@ export function mockSetup(isDeploy) {
             path.resolve(__dirname, '../boilerplate/files/.beautyamp.json')
         ),
         '.prettierrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.prettierrc')),
-        '.eslintrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintrc')),
-        '.eslintignore': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintignore')),
+        'eslint.config.js': fsmock.load(
+            path.resolve(__dirname, '../boilerplate/files/eslint.config.js')
+        ),
         '.mcdevrc.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdevrc.json')),
         '.mcdev-auth.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdev-auth.json')),
         'boilerplate/config.json': fsmock.load(
@@ -273,6 +274,30 @@ export function getRestCallout(method, url) {
     );
     return JSON.parse(myCallout.data);
 }
+/**
+ *
+ * @param {'Schedule'|'Retrieve'|'Create'|'Update'|'Delete'|'Describe'|'Execute'} requestAction soap request types
+ * @param {string} [objectType] optionall filter requests by object
+ * @returns {object[]} json payload of the requests
+ */
+export function getSoapCallout(requestAction, objectType) {
+    const method = 'post';
+    const url = '/Service.asmx';
+    const subset = apimock.history[method];
+    const myCallout = subset
+        // find soap requests
+        .filter((item) => item.url === url)
+        // find soap requestst of the correct request type
+        .filter((item) => item.headers.SOAPAction === requestAction)
+        // find soap requestst of the correct request type
+        .filter(
+            (item) =>
+                !objectType ||
+                item.data.split('<ObjectType>')[1].split('</ObjectType>')[0] === objectType
+        )
+        .map((item) => item.data);
+    return myCallout;
+}
 /**
  * helper to return most important fields for each api call
  *

package/.eslintignore

@@ -1,3 +0,0 @@
-/docs/**
-/node_modules/**
-/retrieve/**