Merge remote-tracking branch 'origin/develop' into feature/706-refres…

…h-triggeredsends-on-email-update # Conflicts: # docs/dist/documentation.md
Accenture · Mar 23, 2023 · 6d4810e · 6d4810e
2 parents 9986a80 + 7195e8e
commit 6d4810e
Show file tree

Hide file tree

Showing 63 changed files with 3,217 additions and 1,121 deletions.
diff --git a/.github/workflows/code-analysis.yml b/.github/workflows/code-analysis.yml
@@ -52,6 +52,8 @@ jobs:
                   languages: ${{ matrix.language }}
             - name: Perform CodeQL Analysis
               uses: github/codeql-action/analyze@v2
+              with:
+                category: "/language:${{matrix.language}}"
 
             # Assuming code passes, run tests
             - run: npm run test
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -5,7 +5,6 @@
     // List of extensions which should be recommended for users of this workspace.
     "recommendations": [
         // collaboration
-        "gruntfuggly.todo-tree",
         "aaron-bond.better-comments",
         "github.vscode-pull-request-github",
 
@@ -15,11 +14,8 @@
         // Formatting & colors
         "editorconfig.editorconfig",
         "esbenp.prettier-vscode",
-        "sergey-agadzhanov.ampscript",
 
         // Markdown / Readme.md
-        "yzhang.markdown-all-in-one",
-        "davidanson.vscode-markdownlint",
         "joernberkefeld.markdown-preview-bitbucket-innersource"
     ]
 }
diff --git a/boilerplate/config.json b/boilerplate/config.json
@@ -69,7 +69,7 @@
         }
     },
     "metaDataTypes": {
-        "documentOnRetrieve": ["accountUser", "automation", "dataExtension", "role"],
+        "documentOnRetrieve": ["user", "automation", "dataExtension", "role"],
         "retrieve": []
     }
 }
diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md
diff --git a/lib/Deployer.js b/lib/Deployer.js
@@ -183,7 +183,7 @@ class Deployer {
      */
     static async _deployBU(cred, bu, properties, typeArr, keyArr, fromRetrieve) {
         const buPath = `${cred}/${bu}`;
-        Util.logger.info(`::Deploying ${buPath}`);
+        Util.logger.info(`:: Deploying to ${buPath}`);
         const buObject = await Cli.getCredentialObject(properties, buPath, null, true);
         let multiMetadataTypeMap;
 

diff --git a/lib/MetadataTypeDefinitions.js b/lib/MetadataTypeDefinitions.js
@@ -4,7 +4,6 @@
  * Provides access to all metadataType classes
  */
 const MetadataTypeDefinitions = {
-    accountUser: require('./metadataTypes/definitions/AccountUser.definition'),
     asset: require('./metadataTypes/definitions/Asset.definition'),
     attributeGroup: require('./metadataTypes/definitions/AttributeGroup.definition'),
     automation: require('./metadataTypes/definitions/Automation.definition'),
@@ -17,12 +16,12 @@ const MetadataTypeDefinitions = {
     dataExtractType: require('./metadataTypes/definitions/DataExtractType.definition'),
     discovery: require('./metadataTypes/definitions/Discovery.definition'),
     email: require('./metadataTypes/definitions/Email.definition'),
-    emailSendDefinition: require('./metadataTypes/definitions/EmailSendDefinition.definition'),
-    eventDefinition: require('./metadataTypes/definitions/EventDefinition.definition'),
+    emailSend: require('./metadataTypes/definitions/EmailSend.definition'),
+    event: require('./metadataTypes/definitions/Event.definition'),
+    fileLocation: require('./metadataTypes/definitions/FileLocation.definition'),
     fileTransfer: require('./metadataTypes/definitions/FileTransfer.definition'),
     filter: require('./metadataTypes/definitions/Filter.definition'),
     folder: require('./metadataTypes/definitions/Folder.definition'),
-    ftpLocation: require('./metadataTypes/definitions/FtpLocation.definition'),
     importFile: require('./metadataTypes/definitions/ImportFile.definition'),
     interaction: require('./metadataTypes/definitions/Interaction.definition'),
     list: require('./metadataTypes/definitions/List.definition'),
@@ -36,7 +35,8 @@ const MetadataTypeDefinitions = {
     transactionalEmail: require('./metadataTypes/definitions/TransactionalEmail.definition'),
     transactionalPush: require('./metadataTypes/definitions/TransactionalPush.definition'),
     transactionalSMS: require('./metadataTypes/definitions/TransactionalSMS.definition'),
-    triggeredSendDefinition: require('./metadataTypes/definitions/TriggeredSendDefinition.definition'),
+    triggeredSend: require('./metadataTypes/definitions/TriggeredSend.definition'),
+    user: require('./metadataTypes/definitions/User.definition'),
 };
 
 module.exports = MetadataTypeDefinitions;
diff --git a/lib/MetadataTypeInfo.js b/lib/MetadataTypeInfo.js
@@ -4,7 +4,6 @@
  * Provides access to all metadataType classes
  */
 const MetadataTypeInfo = {
-    accountUser: require('./metadataTypes/AccountUser'),
     asset: require('./metadataTypes/Asset'),
     attributeGroup: require('./metadataTypes/AttributeGroup'),
     automation: require('./metadataTypes/Automation'),
@@ -17,12 +16,12 @@ const MetadataTypeInfo = {
     dataExtractType: require('./metadataTypes/DataExtractType'),
     discovery: require('./metadataTypes/Discovery'),
     email: require('./metadataTypes/Email'),
-    emailSendDefinition: require('./metadataTypes/EmailSendDefinition'),
-    eventDefinition: require('./metadataTypes/EventDefinition'),
+    emailSend: require('./metadataTypes/EmailSend'),
+    event: require('./metadataTypes/Event'),
+    fileLocation: require('./metadataTypes/FileLocation'),
     fileTransfer: require('./metadataTypes/FileTransfer'),
     filter: require('./metadataTypes/Filter'),
     folder: require('./metadataTypes/Folder'),
-    ftpLocation: require('./metadataTypes/FtpLocation'),
     importFile: require('./metadataTypes/ImportFile'),
     interaction: require('./metadataTypes/Interaction'),
     list: require('./metadataTypes/List'),
@@ -36,7 +35,8 @@ const MetadataTypeInfo = {
     transactionalEmail: require('./metadataTypes/TransactionalEmail'),
     transactionalPush: require('./metadataTypes/TransactionalPush'),
     transactionalSMS: require('./metadataTypes/TransactionalSMS'),
-    triggeredSendDefinition: require('./metadataTypes/TriggeredSendDefinition'),
+    triggeredSend: require('./metadataTypes/TriggeredSend'),
+    user: require('./metadataTypes/User'),
 };
 
 module.exports = MetadataTypeInfo;
diff --git a/lib/index.js b/lib/index.js
@@ -219,6 +219,15 @@ class Mcdev {
             cache.initCache(buObject);
             cred = buObject.credential;
             bu = buObject.businessUnit;
+            // clean up old folders after types were renamed
+            // TODO: Remove this with version 5.0.0
+            const renamedTypes = {
+                emailSend: 'emailSendDefinition',
+                event: 'eventDefinition',
+                fileLocation: 'ftpLocation',
+                triggeredSend: 'triggeredSendDefinition',
+                user: 'accountUser',
+            };
             Util.logger.info(`\n               :: Retrieving ${cred}/${bu}\n`);
             const retrieveTypesArr = [];
             if (selectedTypesArr) {
@@ -243,6 +252,18 @@ class Mcdev {
                     if (!keys) {
                         // dont delete directories if we are just re-retrieving a single file
                         await File.remove(File.normalizePath(removePathArr));
+                        // clean up old folders after types were renamed
+                        // TODO: Remove this with version 5.0.0
+                        if (renamedTypes[type]) {
+                            await File.remove(
+                                File.normalizePath([
+                                    properties.directories.retrieve,
+                                    cred,
+                                    bu,
+                                    renamedTypes[type],
+                                ])
+                            );
+                        }
                     }
                 }
             }
@@ -344,7 +365,7 @@ class Mcdev {
             return;
         }
         try {
-            const parentBUOnlyTypes = ['accountUser', 'role'];
+            const parentBUOnlyTypes = ['user', 'role'];
             const buObject = await Cli.getCredentialObject(
                 properties,
                 parentBUOnlyTypes.includes(type) ? businessUnit.split('/')[0] : businessUnit,
@@ -412,7 +433,7 @@ class Mcdev {
     static async refresh(businessUnit, type, keyArr) {
         Util.logger.info('mcdev:: refresh');
         if (!type || !Util._isValidType(type, true)) {
-            type = 'triggeredSendDefinition';
+            type = 'triggeredSend';
             Util.logger.info(' - setting type to ' + type);
         }
         const properties = await config.getProperties();