mcdev 7.0.3 → 7.0.4

package/lib/metadataTypes/Role.js

@@ -169,13 +169,15 @@ class Role extends MetadataType {
         }
         if (!metadata) {
             try {
-                metadata = await this.readBUMetadataForType(
-                    File.normalizePath([
-                        this.properties.directories.retrieve,
-                        this.buObject.credential,
-                        Util.parentBuName,
-                    ]),
-                    true
+                metadata = (
+                    await this.readBUMetadataForType(
+                        File.normalizePath([
+                            this.properties.directories.retrieve,
+                            this.buObject.credential,
+                            Util.parentBuName,
+                        ]),
+                        true
+                    )
                 ).role;
             } catch (ex) {
                 Util.logger.error(ex.message);

package/lib/metadataTypes/SenderProfile.js

@@ -161,6 +161,7 @@ class SenderProfile extends MetadataType {
 
         if (!changes) {
             const ex = new Error('No changes made to the code.');
+            // @ts-expect-error custom error object
             ex.code = 200;
             throw ex;
         }

package/lib/metadataTypes/TransactionalEmail.js

@@ -117,9 +117,9 @@ class TransactionalEmail extends TransactionalMessage {
     /**
      * Gets executed after deployment of metadata type
      *
-     * @returns {void}
+     * @returns {Promise.<void>} -
      */
-    static postDeployTasks() {
+    static async postDeployTasks() {
         if (this._createdJourneyKeys?.length) {
             Util.logger.warn(
                 `Please download related journeys via: mcdev r ${this.buObject.credential}/${

package/lib/metadataTypes/TriggeredSend.js

@@ -544,6 +544,7 @@ class TriggeredSend extends MetadataType {
 
         if (!changes) {
             const ex = new Error('No changes made to the code.');
+            // @ts-expect-error custom error object
             ex.code = 200;
             throw ex;
         }

package/lib/metadataTypes/User.js

@@ -340,7 +340,6 @@ class User extends MetadataType {
         if (configs.length > 0) {
             Util.logger.info('Deploying: BU assignment changes');
             // run update
-            // @ts-expect-error bad jsodc in SFMC-SDK
             const buResponse = await this.client.soap.configure('AccountUser', configs);
             // process response
             if (buResponse.OverallStatus === 'OK') {
@@ -745,6 +744,7 @@ class User extends MetadataType {
                     installedPackage: 0,
                 };
                 for (const id in savedMetadata) {
+                    /** @typedef {UserDocument} */
                     const item = savedMetadata[id];
                     if (item.c__type === 'Installed Package') {
                         counter.installedPackage++;
@@ -974,13 +974,15 @@ class User extends MetadataType {
         if (!metadata) {
             // load users from disk if document was called directly and not part of a retrieve
             try {
-                metadata = await this.readBUMetadataForType(
-                    File.normalizePath([
-                        this.properties.directories.retrieve,
-                        this.buObject.credential,
-                        Util.parentBuName,
-                    ]),
-                    true
+                metadata = (
+                    await this.readBUMetadataForType(
+                        File.normalizePath([
+                            this.properties.directories.retrieve,
+                            this.buObject.credential,
+                            Util.parentBuName,
+                        ]),
+                        true
+                    )
                 ).user;
             } catch (ex) {
                 Util.logger.error(ex.message);
@@ -1015,7 +1017,9 @@ class User extends MetadataType {
             }
             const defaultBUName = this._getBuName(user.DefaultBusinessUnit);
             const LastSuccessfulLogin = user.LastSuccessfulLogin.split('.')[0];
+
             users.push({
+                ...user, // keep that here to satisfy the type
                 TYPE: user.c__type,
                 UserID: user.UserID,
                 AccountUserID: user.c__AccountUserID,
@@ -1023,13 +1027,13 @@ class User extends MetadataType {
                 Name: user.Name,
                 Email: user.Email,
                 NotificationEmailAddress: user.NotificationEmailAddress,
-                ActiveFlag: user.ActiveFlag === true ? '✓' : '-',
-                IsLocked: user.IsLocked === true ? '✓' : '-',
-                IsAPIUser: user.IsAPIUser === true ? '✓' : '-',
-                MustChangePassword: user.MustChangePassword === true ? '✓' : '-',
-                DefaultBusinessUnit: defaultBUName,
-                AssociatedBus: associatedBus,
-                Roles: roles,
+                ActiveFlagDocs: user.ActiveFlag === true ? '✓' : '-',
+                IsLockedDocs: user.IsLocked === true ? '✓' : '-',
+                IsAPIUserDocs: user.IsAPIUser === true ? '✓' : '-',
+                MustChangePasswordDocs: user.MustChangePassword === true ? '✓' : '-',
+                DefaultBusinessUnitDocs: defaultBUName,
+                AssociatedBusDocs: associatedBus,
+                RolesDocs: roles,
                 LastSuccessfulLogin: user.LastSuccessfulLogin
                     ? // on create & update, LastSuccessfulLogin often gets overwritten with the current date
                       LastSuccessfulLogin === user.CreatedDate.split('.')[0] ||
@@ -1041,39 +1045,39 @@ class User extends MetadataType {
                 ModifiedDate: user.ModifiedDate ? user.ModifiedDate.split('T').join(' ') : 'n/a',
                 ModifiedBy: user.Client.ModifiedBy || 'n/a',
                 TimeZoneName: user.c__TimeZoneName.slice(1, 10),
-                LocaleCode: user.c__LocaleCode,
+                c__LocaleCode: user.c__LocaleCode,
             });
         }
         users.sort((a, b) => (a.Name < b.Name ? -1 : a.Name > b.Name ? 1 : 0));
         const columnsToPrint = [
             ['Name', 'Name'],
             ['Last successful Login', 'LastSuccessfulLogin'],
-            ['Active', 'ActiveFlag'],
-            ['Access Locked out', 'IsLocked'],
-            ['API User', 'IsAPIUser'],
-            ['Must change PW', 'MustChangePassword'],
-            ['Default BU', 'DefaultBusinessUnit'],
-            ['BU Access', 'AssociatedBus'],
-            ['Roles', 'Roles'],
+            ['Active', 'ActiveFlagDocs'],
+            ['Access Locked out', 'IsLockedDocs'],
+            ['API User', 'IsAPIUserDocs'],
+            ['Must change PW', 'MustChangePasswordDocs'],
+            ['Default BU', 'DefaultBusinessUnitDocs'],
+            ['BU Access', 'AssociatedBusDocs'],
+            ['Roles', 'RolesDocs'],
             ['Login', 'UserID'],
             ['ID', 'AccountUserID'],
             ['Key', 'CustomerKey'],
             ['E-Mail', 'Email'],
             ['Notification E-Mail', 'NotificationEmailAddress'],
             ['Timezone', 'TimeZoneName'],
-            ['SFMC Locale', 'LocaleCode'],
+            ['SFMC Locale', 'c__LocaleCode'],
             ['Modified Date', 'ModifiedDate'],
             ['Modified By', 'ModifiedBy'],
             ['Created Date', 'CreatedDate'],
         ];
         let output = `# User Overview - ${this.buObject.credential}`;
         output += this._generateDocMd(
-            users.filter((user) => user.TYPE === 'User' && user.ActiveFlag === '✓'),
+            users.filter((user) => user.TYPE === 'User' && user.ActiveFlagDocs === '✓'),
             'User',
             columnsToPrint
         );
         output += this._generateDocMd(
-            users.filter((user) => user.TYPE === 'User' && user.ActiveFlag === '-'),
+            users.filter((user) => user.TYPE === 'User' && user.ActiveFlagDocs === '-'),
             'Inactivated User',
             columnsToPrint
         );
@@ -1124,7 +1128,7 @@ class User extends MetadataType {
     /**
      * manages post retrieve steps
      *
-     * @param {MetadataTypeItem} metadata a single item
+     * @param {UserDocument} metadata a single item
      * @returns {MetadataTypeItem | void} a single item
      */
     static postRetrieveTasks(metadata) {

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

@@ -279,12 +279,12 @@ export default {
         //     retrieving: false,
         //     template: false,
         // },
-        // 'configurationArguments.unconfigured': {
-        //     isCreateable: false,
-        //     isUpdateable: false,
-        //     retrieving: false,
-        //     template: false,
-        // },
+        'configurationArguments.unconfigured': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
         // 'configurationArguments.version': {
         //     isCreateable: false,
         //     isUpdateable: false,
@@ -928,7 +928,7 @@ export default {
             template: false,
         },
         'schema.name': {
-            isCreateable: false,
+            isCreateable: true,
             isUpdateable: true,
             retrieving: false,
             template: false,
@@ -963,7 +963,7 @@ export default {
             retrieving: true,
             template: true,
         },
-        r__dataExtension_CustomerKey: {
+        r__dataExtension_key: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,

package/lib/util/auth.js

@@ -42,7 +42,6 @@ const Auth = {
         const sdk = setupSDK(credential, authObject);
         try {
             // check credentials to allow clear log output and stop execution
-            // @ts-expect-error - params are optional but jsdoc in SFMC-SDK says otherwise
             const test = await sdk.auth.getAccessToken();
             if (test.error) {
                 throw new Error(test.error_description);

package/lib/util/cli.js

@@ -557,7 +557,6 @@ const Cli = {
                 return 0;
             });
             // add end-of-list marker
-            // @ts-expect-error type checking this push() makes things very complicated...
             typeChoices.push(new inquirer.Separator(' ==== '));
             responses = await inquirer.prompt([
                 {

package/lib/util/devops.js

@@ -74,7 +74,6 @@ const DevOps = {
                 name: commit.date + ' / ' + commit.message + ' / ' + commit.author_name,
                 value: commit.hash,
             }));
-            // @ts-expect-error type checking this push() makes things very complicated...
             display.push(new inquirer.Separator(' ==== '));
 
             const responses = await inquirer.prompt([
@@ -99,6 +98,7 @@ const DevOps = {
         /**
          * @type {DeltaPkgItem[]}
          */
+        // @ts-expect-error TODO LATER
         const delta = (await git.diffSummary([range])).files
             // populate additional info for all changed files
             .map((/** @type {DeltaPkgItem} */ file) => {
@@ -317,7 +317,7 @@ const DevOps = {
             const copied = delta
                 .filter((file) => !file.file.endsWith('.md')) // filter documentation files
                 .map((file) =>
-                    File.copyFile(
+                    File.copyFileSimple(
                         file.file,
                         path
                             .normalize(file.file)
@@ -561,7 +561,6 @@ const DevOps = {
         for (let i = 1; i < tabled.length; i++) {
             for (let field of tabled[i]) {
                 if (field !== '') {
-                    // @ts-expect-error bad typing in jsonToTable
                     field = field === true ? '✓' : field === false ? '✗' : field;
                     output += `| ${field} `;
                 }

package/lib/util/file.js

@@ -1,6 +1,4 @@
-/* eslint-disable no-control-regex */
 'use strict';
-
 import fs from 'fs-extra';
 
 import path from 'node:path';
@@ -50,7 +48,7 @@ const File = {
      * @param {string} to - full filepath including name where file should go
      * @returns {Promise.<{status:'ok'|'skipped'|'failed', statusMessage:string, file:string}>} - results object
      */
-    async copyFile(from, to) {
+    async copyFileSimple(from, to) {
         try {
             await fs.copy(from, to);
             return { status: 'ok', statusMessage: null, file: from };
@@ -321,6 +319,7 @@ const File = {
 
             // save prettier errror into log file
             // Note: we have to filter color codes from prettier's error message before saving it to file
+            /* eslint-disable no-control-regex */
             this.writeToFile(
                 directory,
                 filename + '.error',
@@ -331,6 +330,7 @@ const File = {
                     ''
                 )}`
             );
+            /* eslint-enable no-control-regex */
 
             formatted = content;
         }
@@ -371,7 +371,7 @@ const File = {
      * @param {string | string[]} directory directory where the file is stored
      * @param {string} filename name of the file without '.json' ending
      * @param {boolean} cleanPath filters illegal chars if true
-     * @returns {Promise.<object> | object | void} Promise or JSON object depending on if async or not; void on error
+     * @returns {Promise.<object | object | void>} Promise or JSON object depending on if async or not; void on error
      */
     readJSONFile: async function (directory, filename, cleanPath) {
         try {
@@ -409,11 +409,8 @@ const File = {
         try {
             directory = this.filterIllegalPathChars(this.normalizePath(directory));
             filename = this.filterIllegalFilenames(filename);
-            // @ts-expect-error - somehow, the declared type does not allow for encoding to be passed in as a string, despite that working and being stated in the docs.
-            return await fs.readFile(
-                path.join(directory, filename + '.' + filetype),
-                encoding || 'utf8'
-            );
+            // @ts-expect-error somehow, the typing for fs-extra is not correct
+            return fs.readFile(path.join(directory, filename + '.' + filetype), encoding || 'utf8');
         } catch (ex) {
             Util.logger.debug('File.readFilteredFilename:: error | ' + ex.message);
         }
@@ -574,6 +571,6 @@ const File = {
         }
     },
 };
-const FileFs = { ...fs, ...File };
 
+const FileFs = Object.assign(fs, File);
 export default FileFs;

package/lib/util/replaceContentBlockReference.js

@@ -93,6 +93,7 @@ export default class ReplaceContentBlockReference {
     static replaceReference(str, parentName, fromList, to) {
         if (!str) {
             const ex = new Error('No string provided');
+            // @ts-expect-error custom error object
             ex.code = 200;
             throw ex;
         }
@@ -133,6 +134,7 @@ export default class ReplaceContentBlockReference {
         }
         if (!changes) {
             const ex = new Error('No changes made to the code.');
+            // @ts-expect-error custom error object
             ex.code = 200;
             throw ex;
         }
@@ -158,7 +160,7 @@ export default class ReplaceContentBlockReference {
                 break;
             }
             case 'name': {
-                if (isSsjs) {
+                if (isSsjs && typeof identifier === 'string') {
                     identifier = identifier.replaceAll('\\\\', '\\');
                 }
                 reference = ReplaceContentBlockReference.assetCacheMap.name[identifier];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "7.0.3",
+    "version": "7.0.4",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -54,7 +54,7 @@
         "debug": "node --nolazy --inspect-brk=9229 lib/cli.js",
         "lint:fix": "eslint --fix lib/**/*.js types/*.js test/**/*.js",
         "lint": "eslint lib/**/*.js types/*.js test/**/*.js",
-        "lint-ts": "tsc -p jsconfig.json --maxNodeModuleJsDepth 1 --noEmit",
+        "lint-ts": "tsc -p tsconfig.npmScripts.json",
         "prepare": "husky || true",
         "lint-and-test": "run-s lint test",
         "test": "mocha --reporter-option maxDiffSize=25000",
@@ -78,7 +78,7 @@
         "prettier": "3.3.2",
         "prettier-plugin-sql": "0.18.0",
         "semver": "7.6.0",
-        "sfmc-sdk": "2.0.1",
+        "sfmc-sdk": "2.1.1",
         "simple-git": "3.25.0",
         "toposort": "2.0.2",
         "update-notifier": "7.0.0",
@@ -87,8 +87,10 @@
     },
     "devDependencies": {
         "@eslint/js": "9.6.0",
-        "@types/mocha": "10.0.6",
+        "@types/fs-extra": "11.0.4",
+        "@types/mocha": "10.0.7",
         "@types/node": "20.14.9",
+        "@types/yargs": "17.0.32",
         "assert": "2.1.0",
         "axios-mock-adapter": "1.22.0",
         "c8": "10.0.0",
@@ -97,19 +99,19 @@
         "eslint": "9.6.0",
         "eslint-config-prettier": "9.1.0",
         "eslint-config-ssjs": "2.0.0",
-        "eslint-plugin-jsdoc": "48.2.7",
+        "eslint-plugin-jsdoc": "48.5.2",
         "eslint-plugin-mocha": "10.4.3",
         "eslint-plugin-prettier": "5.1.2",
-        "eslint-plugin-unicorn": "53.0.0",
+        "eslint-plugin-unicorn": "54.0.0",
         "fast-xml-parser": "4.4.0",
-        "globals": "15.6.0",
+        "globals": "15.8.0",
         "husky": "9.0.11",
         "lint-staged": "15.2.7",
-        "mocha": "10.4.0",
+        "mocha": "10.6.0",
         "mock-fs": "5.2.0",
         "npm-run-all": "4.1.5",
         "prettier-eslint": "16.3.0",
-        "typescript": "5.4.5"
+        "typescript": "5.5.3"
     },
     "optionalDependencies": {
         "fsevents": "*"

package/test/general.test.js

@@ -461,8 +461,8 @@ describe('GENERAL', () => {
                 );
                 assert.equal(
                     Object.keys(result[buName]['dataExtension']).length,
-                    5,
-                    'retrieve should have returned 5 dataExtension'
+                    7,
+                    'retrieve should have returned 7 dataExtension'
                 );
                 assert.equal(
                     Object.keys(result[buName]['dataExtract']).length,
@@ -1191,6 +1191,24 @@ describe('GENERAL', () => {
                 );
             });
         });
+
+        describe('Delete --metadata ~~~', () => {
+            it('Should delete the item', async () => {
+                const argvMetadata = [
+                    'asset:testExisting_asset',
+                    'automation:testExisting_automation',
+                    'journey:testExisting_journey_Quicksend/1',
+                    'journey:testExisting_journey_Multistep/1',
+                ];
+                const typeKeyCombo = handler.metadataToTypeKey(argvMetadata);
+                // WHEN
+                const isDeleted = await handler.deleteByKey('testInstance/testBU', typeKeyCombo);
+                // THEN
+                assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+                assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+                return;
+            });
+        });
     });
 
     describe('without --metadata ================', () => {

package/test/mockRoot/.mcdevrc.json

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

package/test/mockRoot/deploy/testInstance/testBU/event/testExisting_event.event-meta.json

@@ -0,0 +1,201 @@
+{
+    "type": "APIEvent",
+    "name": "testExisting_event",
+    "description": "updated on deploy",
+    "mode": "Production",
+    "eventDefinitionKey": "testExisting_event",
+    "schema": {
+        "fields": [
+            {
+                "name": "ContactId",
+                "dataType": "Text",
+                "maxLength": 18,
+                "isNullable": false,
+                "isPrimaryKey": true
+            },
+            {
+                "name": "Type",
+                "dataType": "Text",
+                "maxLength": "50",
+                "isNullable": false,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Status",
+                "dataType": "Text",
+                "maxLength": "50",
+                "isNullable": false,
+                "isPrimaryKey": true
+            },
+            {
+                "name": "Respondent",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "FirstName",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "LastName",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "PreferredLanguage",
+                "dataType": "Text",
+                "maxLength": "50",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "TouchPoint",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Datestamp",
+                "dataType": "Date",
+                "defaultValue": "GetDate()",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "StartDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "defaultValue": "",
+                "isPrimaryKey": false
+            },
+            {
+                "name": "EndDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "BroadcastedNotificationDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "defaultValue": "",
+                "isPrimaryKey": false
+            },
+            {
+                "name": "FirstReminderDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "SecondReminderDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Title",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "DisplayName",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Text",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Description",
+                "dataType": "Text",
+                "maxLength": "4000",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Channel",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "FirstReminderChannel",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "SecondReminderChannel",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "Email",
+                "dataType": "Email",
+                "maxLength": "",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "ArticleOrTaskID",
+                "dataType": "Text",
+                "maxLength": "18",
+                "isNullable": false,
+                "isPrimaryKey": true
+            },
+            {
+                "name": "Points",
+                "dataType": "Number",
+                "maxLength": "",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "TaskType",
+                "dataType": "Text",
+                "maxLength": "255",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "TaskArea",
+                "dataType": "Text",
+                "maxLength": "255",
+                "isNullable": true,
+                "isPrimaryKey": false
+            },
+            {
+                "name": "AddedField",
+                "dataType": "Text",
+                "maxLength": "255",
+                "isNullable": true,
+                "isPrimaryKey": false
+            }
+        ],
+        "sendableCustomObjectField": "ContactId",
+        "sendableSubscriberField": "_SubscriberKey"
+    },
+    "isVisibleInPicker": true,
+    "r__dataExtension_key": "testExisting_event - 2024-07-05T080154625"
+}