mcdev 4.3.0 → 4.3.2

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

@@ -41,8 +41,8 @@ module.exports = {
             template: false,
         },
         definitionId: {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: false,
             template: false,
         },

package/lib/util/auth.js

@@ -101,7 +101,7 @@ function setupSDK(sessionKey, authObject) {
                 credentialStore.set(sessionKey, authObject);
             },
             onConnectionError: (ex, remainingAttempts) => {
-                Util.logger.warn(
+                Util.logger.info(
                     ` - Connection problem (Code: ${ex.code}). Retrying ${remainingAttempts} time${
                         remainingAttempts > 1 ? 's' : ''
                     }${
@@ -114,8 +114,13 @@ function setupSDK(sessionKey, authObject) {
                 );
                 Util.logger.errorStack(ex);
             },
-            // logRequest: (req) => console.log('request', req), // uncomment to log requests
-            // logResponse: (res) => console.log('response:', res), // uncomment to log responses
+            // logRequest: (req) =>
+            //     console.log(`${Util.color.fgMagenta}request${Util.color.reset}`, req), // uncomment to log requests
+            // logResponse: (res) =>
+            //     console.log(
+            //         `${Util.color.bgMagenta}response${Util.color.reset}:`,
+            //         typeof res.data == 'string' && res.data.length > 10000 ? res.data : res
+            //     ), // uncomment to log responses
         },
         requestAttempts: 4,
         retryOnConnectionError: true,

package/lib/util/devops.js

@@ -111,6 +111,8 @@ const DevOps = {
             // Filter to only handle files that start with at least one of the passed filterPaths.
             // ! Filter happens after initial parse, because if file was moved its new path has to be calculated
             .filter((file) => filterPaths.some((path) => file.file.startsWith(path)))
+            .filter((file) => !file.file.endsWith('.error.log'))
+            .filter((file) => !file.file.endsWith('.md'))
             // ensure badly named files on unsupported metadata types are not in our subset
             .filter((/** @type {TYPE.DeltaPkgItem} */ file) => {
                 if (MetadataType[file.type]) {
@@ -210,10 +212,12 @@ const DevOps = {
             const copied = delta.map((file) =>
                 File.copyFile(
                     file.file,
-                    file.file.replace(
-                        path.normalize(properties.directories.retrieve),
-                        path.normalize(properties.directories.deploy)
-                    )
+                    path
+                        .normalize(file.file)
+                        .replace(
+                            path.normalize(properties.directories.retrieve),
+                            path.normalize(properties.directories.deploy)
+                        )
                 )
             );
             const results = await Promise.all(copied);

package/lib/util/util.js

@@ -364,21 +364,38 @@ const Util = {
         // group subtypes per type
         for (const type of flatList) {
             if (type.includes('-')) {
-                const key = type.split('-')[0];
-                if (finalList[key]) {
+                const [key, subKey] = Util.getTypeAndSubType(type);
+                if (finalList[key] === null) {
+                    // if main type is already required, then don't filter by subtypes
                     continue;
+                } else if (finalList[key] && subKey) {
+                    // add another subtype to the set
+                    finalList[key].add(subKey);
+                    continue;
+                } else {
+                    // create a new set with the first subtype; subKey will be always set here
+                    finalList[key] = new Set([subKey]);
+                }
+                if (subTypeDeps[key]) {
+                    // check if there are depndent subtypes that need to be added
+                    const temp = [...subTypeDeps[key]].map((a) => {
+                        const temp = a.split('-');
+                        temp.shift(); // remove first item which is the main type
+                        return temp.join('-'); // subType can include "-"
+                    });
+                    finalList[key].add(...temp);
                 }
-                finalList[key] = subTypeDeps[key]
-                    ? [...subTypeDeps[key]].map((a) => {
-                          const temp = a.split('-');
-                          temp.shift(); // remove first item which is the main type
-                          return temp.join('-'); // subType can include "-"
-                      })
-                    : null;
             } else {
                 finalList[type] = null;
             }
         }
+        // convert sets into arrays
+        for (const type of Object.keys(finalList)) {
+            if (finalList[type] instanceof Set) {
+                finalList[type] = [...finalList[type]];
+            }
+        }
+
         return finalList;
     },
 
@@ -487,6 +504,31 @@ const Util = {
     color: {
         reset: '\x1B[0m',
         dim: '\x1B[2m',
+        bright: '\x1B[1m',
+        underscore: '\x1B[4m',
+        blink: '\x1B[5m',
+        reverse: '\x1B[7m',
+        hidden: '\x1B[8m',
+
+        fgBlack: '\x1B[30m',
+        fgRed: '\x1B[31m',
+        fgGreen: '\x1B[32m',
+        fgYellow: '\x1B[33m',
+        fgBlue: '\x1B[34m',
+        fgMagenta: '\x1B[35m',
+        fgCyan: '\x1B[36m',
+        fgWhite: '\x1B[37m',
+        fgGray: '\x1B[90m',
+
+        bgBlack: '\x1B[40m',
+        bgRed: '\x1B[41m',
+        bgGreen: '\x1B[42m',
+        bgYellow: '\x1B[43m',
+        bgBlue: '\x1B[44m',
+        bgMagenta: '\x1B[45m',
+        bgCyan: '\x1B[46m',
+        bgWhite: '\x1B[47m',
+        bgGray: '\x1B[100m',
     },
     /**
      * helper that wraps a message in the correct color codes to have them printed gray

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "4.3.0",
+    "version": "4.3.2",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -50,6 +50,7 @@
         "lint-test": "eslint test/**/*.js",
         "upgrade": "npm-check --update",
         "manual-prepare": "husky install",
+        "lint-and-test": "run-s lint test",
         "test": "mocha",
         "coverage": "nyc mocha",
         "version:major": "npm version --no-commit-hooks major",

package/test/interaction.test.js

@@ -33,7 +33,7 @@ describe('interaction', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                7,
+                9,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -114,7 +114,7 @@ describe('interaction', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                7,
+                9,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/mockRoot/.mcdevrc.json

@@ -74,5 +74,5 @@
             "triggeredSendDefinition"
         ]
     },
-    "version": "4.3.0"
+    "version": "4.3.2"
 }

package/test/resourceFactory.js

@@ -1,6 +1,7 @@
 const fs = require('fs-extra');
 const path = require('node:path');
 const { XMLParser } = require('fast-xml-parser');
+const { color } = require('../lib/util/util');
 const parser = new XMLParser();
 const attributeParser = new XMLParser({ ignoreAttributes: false });
 /**
@@ -25,7 +26,11 @@ exports.loadSOAPRecords = async (mcdevAction, type, mid) => {
             encoding: 'utf8',
         });
     }
-    console.log(`error: Please create file ${testPath}`); // eslint-disable-line no-console
+    /* eslint-disable no-console */
+    console.log(
+        `${color.bgRed}${color.fgBlack}test-error${color.reset}: Please create file ${testPath}`
+    );
+    /* eslint-enable no-console */
 
     return fs.readFile(path.join('test', 'resources', mcdevAction + '-response.xml'), {
         encoding: 'utf8',
@@ -98,13 +103,15 @@ exports.handleRESTRequest = async (config) => {
         if (urlObj.searchParams.get('$filter')) {
             filterName = urlObj.searchParams.get('$filter').split(' eq ')[1];
         }
-        const testPath = path.join(
-            'test',
-            'resources',
-            config.headers.Authorization.replace('Bearer ', ''),
-            urlObj.pathname,
-            config.method + '-response.json'
-        );
+        const testPath = path
+            .join(
+                'test',
+                'resources',
+                config.headers.Authorization.replace('Bearer ', ''),
+                urlObj.pathname,
+                config.method + '-response.json'
+            )
+            .replace(':', '_'); // replace : with _ for Windows
 
         if (await fs.pathExists(testPath)) {
             // build filter logic to ensure templating works
@@ -126,7 +133,11 @@ exports.handleRESTRequest = async (config) => {
                 ];
             }
         } else {
-            console.log(`error: Please create file ${testPath}`); // eslint-disable-line no-console
+            /* eslint-disable no-console */
+            console.log(
+                `${color.bgRed}${color.fgBlack}test-error${color.reset}: Please create file ${testPath}`
+            );
+            /* eslint-enable no-console */
 
             return [
                 404,

package/test/resources/9999999/interaction/v1/interactions/key_0b76dccf-594c-b6dc-1acf-10c4493dcb84/get-response.json

@@ -0,0 +1,219 @@
+{
+    "id": "dsfdsafdsa-922c-4568-85a5-e5cc77efc3be",
+    "key": "0b76dccf-594c-b6dc-1acf-10c4493dcb84",
+    "name": "testExisting_temail",
+    "lastPublishedDate": "0001-01-01T00:00:00",
+    "description": "",
+    "version": 1,
+    "workflowApiVersion": 1,
+    "createdDate": "2022-03-24T02:20:32.74",
+    "modifiedDate": "2022-03-24T02:20:40.45",
+    "activities": [
+        {
+            "id": "9606bcb0-9246-4610-9800-963bc77fc20a",
+            "key": "EMAILV2-4",
+            "name": "testExisting_temail",
+            "description": "",
+            "type": "EMAILV2",
+            "outcomes": [
+                {
+                    "key": "1f44021a-74ac-49be-a07c-67862228214d",
+                    "arguments": {},
+                    "metaData": {
+                        "invalid": false
+                    }
+                }
+            ],
+            "arguments": {},
+            "configurationArguments": {
+                "applicationExtensionKey": "jb-email-activity",
+                "isModified": true,
+                "triggeredSend": {
+                    "autoAddSubscribers": true,
+                    "autoUpdateSubscribers": true,
+                    "bccEmail": "",
+                    "ccEmail": "",
+                    "created": {},
+                    "domainExclusions": [],
+                    "dynamicEmailSubject": "test email",
+                    "emailId": 25923,
+                    "emailSubject": "test email",
+                    "exclusionFilter": "",
+                    "isSalesforceTracking": true,
+                    "isMultipart": true,
+                    "isSendLogging": false,
+                    "isStoppedOnJobError": false,
+                    "modified": {},
+                    "preHeader": "",
+                    "priority": 4,
+                    "sendClassificationId": "1284e9b2-a7b8-e711-80cf-1402ec721c9d",
+                    "throttleOpens": "1/1/0001 12:00:00 AM",
+                    "throttleCloses": "1/1/0001 12:00:00 AM",
+                    "deliveryProfileId": "1084e9b2-a7b8-e711-80cf-1402ec721c9d",
+                    "senderProfileId": "0f84e9b2-a7b8-e711-80cf-1402ec721c9d",
+                    "isTrackingClicks": true,
+                    "publicationListId": 15
+                },
+                "triggeredSendId": "0a650d90-755e-ed11-b852-48df37d1df5b",
+                "triggeredSendKey": "testExisting_temail"
+            },
+            "metaData": {
+                "highThroughput": {
+                    "definitionKey": "testExisting_temail",
+                    "dataExtensionId": "21711373-72c1-ec11-b83b-48df37d1deb7"
+                },
+                "sections": {},
+                "isConfigured": true
+            },
+            "schema": {
+                "arguments": {
+                    "requestID": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "Out",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "messageKey": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "Out",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "activityId": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "definitionId": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": true,
+                        "access": "Hidden"
+                    },
+                    "emailSubjectDataBound": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": true,
+                        "access": "Hidden"
+                    },
+                    "contactId": {
+                        "dataType": "Number",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "contactKey": {
+                        "dataType": "Text",
+                        "isNullable": false,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "emailAddress": {
+                        "dataType": "Text",
+                        "isNullable": false,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "sourceCustomObjectId": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "sourceCustomObjectKey": {
+                        "dataType": "LongNumber",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "fieldType": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "eventData": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "obfuscationProperties": {
+                        "dataType": "Text",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    },
+                    "customObjectKey": {
+                        "dataType": "LongNumber",
+                        "isNullable": true,
+                        "direction": "In",
+                        "readOnly": true,
+                        "access": "Hidden"
+                    },
+                    "definitionInstanceId": {
+                        "dataType": "Text",
+                        "isNullable": false,
+                        "direction": "In",
+                        "readOnly": false,
+                        "access": "Hidden"
+                    }
+                }
+            }
+        }
+    ],
+    "triggers": [
+        {
+            "key": "TRIGGER",
+            "name": "TRIGGER",
+            "description": "",
+            "type": "transactional-api",
+            "outcomes": [],
+            "arguments": {},
+            "configurationArguments": {},
+            "metaData": {
+                "chainType": "none",
+                "configurationRequired": false,
+                "iconUrl": "/images/icon_journeyBuilder-event-transactional-blue.svg",
+                "title": "Transactional API Event",
+                "category": "Transactional",
+                "entrySourceGroupConfigUrl": "null"
+            }
+        }
+    ],
+    "goals": [],
+    "exits": [],
+    "notifiers": [],
+    "entryMode": "MultipleEntries",
+    "definitionType": "Transactional",
+    "channel": "email",
+    "defaults": {
+        "properties": {
+            "analyticsTracking": {
+                "enabled": false,
+                "analyticsType": "google",
+                "urlDomainsToTrack": []
+            }
+        }
+    },
+    "metaData": {},
+    "executionMode": "Production",
+    "categoryId": 6298,
+    "status": "Published",
+    "scheduledStatus": "Draft",
+    "definitionId": "dsfdsafdsa-922c-4568-85a5-e5cc77efc3be"
+}