mcdev 4.2.1 → 4.3.0

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

@@ -1,7 +1,7 @@
 // asset types https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/base-asset-types.htm
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['folder'],
+    dependencies: ['folder-asset', 'folder-asset-shared'],
     folderType: 'asset',
     hasExtended: false,
     idField: 'id',

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

@@ -27,7 +27,7 @@ module.exports = {
         'dataExtract',
         'emailSendDefinition',
         'fileTransfer',
-        'folder',
+        'folder-automations',
         'importFile',
         'query',
         'script',

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

@@ -1,6 +1,15 @@
 module.exports = {
     bodyIteratorField: 'Results',
-    dependencies: ['folder', 'dataExtensionTemplate'],
+    dependencies: [
+        'folder-hidden',
+        'folder-dataextension',
+        'folder-salesforcedataextension',
+        'folder-shared_data',
+        'folder-shared_dataextension',
+        'folder-shared_salesforcedataextension',
+        'folder-synchronizeddataextension',
+        'dataExtensionTemplate',
+    ],
     folderType: 'dataextension',
     filter: {
         CustomerKey: [

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'Results',
-    dependencies: ['folder'],
+    dependencies: ['folder-hidden', 'folder-email', 'folder-shared_email_default'],
     hasExtended: false,
     idField: 'ID',
     keepId: true,

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'Results',
-    dependencies: ['folder', 'email', 'asset-message', 'dataExtension', 'list'], // filter, SendClassification, SenderProfile, DeliveryProfile
+    dependencies: ['folder-userinitiatedsends', 'email', 'asset-message', 'dataExtension', 'list'], // filter, SendClassification, SenderProfile, DeliveryProfile
     folderType: 'userinitiatedsends',
     hasExtended: false,
     idField: 'ObjectID',

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

@@ -12,15 +12,48 @@ module.exports = {
     restPagination: true,
     type: 'eventDefinition',
     typeDescription: 'Used in Journeys (Interactions) to define Entry Events.',
-    typeRetrieveByDefault: false,
+    typeRetrieveByDefault: true,
     typeName: 'Journey: Entry Event Definition',
     fields: {
+        'arguments.audienceCount': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'arguments.audienceDefinitionID': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'arguments.audienceDescription': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'arguments.audienceSource': {
+            skipValidation: true,
+        },
+        'arguments.audienceName': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         'arguments.automationId': {
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
             template: true,
         },
+        'arguments.buildAudienceDefinitionID': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         'arguments.contactAttributeGroup': {
             isCreateable: true,
             isUpdateable: true,
@@ -832,6 +865,12 @@ module.exports = {
             retrieving: true,
             template: false,
         },
+        'schema.isPlatformObject': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         'schema.fields': {
             isCreateable: true,
             isUpdateable: true,

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

@@ -1,6 +1,36 @@
 module.exports = {
     bodyIteratorField: 'Results',
     dependencies: [],
+    subTypes: [
+        'asset-shared',
+        'asset',
+        'contextual_suppression_list',
+        'dataextension',
+        'filteractivity',
+        'filterdefinition',
+        'journey',
+        'list',
+        'mysubs',
+        'mysubs',
+        'publication',
+        'queryactivity',
+        'salesforcedataextension',
+        'shared_content',
+        'shared_data',
+        'shared_dataextension',
+        'shared_email',
+        'shared_item',
+        'shared_portfolio',
+        'shared_publication',
+        'shared_salesforcedataextension',
+        'shared_suppression_list',
+        'shared_template',
+        'ssjsactivity',
+        'suppression_list',
+        'synchronizeddataextension',
+        'triggered_send_journeybuilder',
+        'triggered_send',
+    ],
     deployFolderTypes: [
         // lower-case values!
         'asset',
@@ -41,6 +71,7 @@ module.exports = {
     ],
     hasExtended: false,
     idField: 'ID',
+    keepId: true,
     keyField: 'CustomerKey',
     nameField: 'Name',
     restPagination: false,

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['folder', 'ftpLocation', 'dataExtension', 'list'], // folder has to be kept in here to resolve lists correctly
+    dependencies: ['ftpLocation', 'dataExtension', 'list'],
     destinationObjectTypeMapping: {
         unknown: 783,
         DataExtension: 310,

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

@@ -1,6 +1,11 @@
+// overview: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/jb-api-specification.html
+// obj definition: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/getting-started-spec.html
+// insert: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/postCreateInteraction.html
+// update: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/putUpdateInteraction.html
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: [],
+    dependencies: ['folder-journey', 'triggeredSendDefinition', 'eventDefinition'], // ! interaction and transactionalEmail both link to each other. caching transactionalEmail here "manually" instead of via dependencies array, assuming that it is quicker than the other way round
+    folderIdField: 'categoryId',
     hasExtended: false,
     idField: 'id',
     keyField: 'key',
@@ -9,10 +14,11 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
-    restPagination: false,
+    restPagination: true,
+    restPageSize: 250,
     type: 'interaction',
-    typeDescription: 'Journey from Builder (internally called "Interaction").',
-    typeRetrieveByDefault: false,
+    typeDescription: 'Journey (internally called "Interaction").',
+    typeRetrieveByDefault: true,
     typeName: 'Journey',
     fields: {
         activities: {
@@ -61,10 +67,10 @@ module.exports = {
             template: null,
         },
         definitionId: {
-            isCreateable: true,
-            isUpdateable: true,
-            retrieving: true,
-            template: true,
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         definitionType: {
             isCreateable: true,
@@ -104,9 +110,9 @@ module.exports = {
         },
         id: {
             isCreateable: false,
-            isUpdateable: true,
-            retrieving: false,
-            template: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
         },
         key: {
             isCreateable: true,
@@ -117,7 +123,7 @@ module.exports = {
         lastPublishedDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: false,
+            retrieving: true,
             template: false,
         },
         'metaData.templateId': {
@@ -128,9 +134,9 @@ module.exports = {
         },
         modifiedDate: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
-            template: false,
+            template: true,
         },
         name: {
             isCreateable: true,
@@ -151,10 +157,10 @@ module.exports = {
             template: false,
         },
         status: {
-            isCreateable: true,
+            isCreateable: false,
             isUpdateable: true,
             retrieving: true,
-            template: true,
+            template: false,
         },
         triggers: {
             isCreateable: true,
@@ -169,16 +175,16 @@ module.exports = {
             template: false,
         },
         'triggers[].key': {
-            isCreateable: false,
-            isUpdateable: false,
-            retrieving: false,
-            template: false,
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
         },
         'triggers[].name': {
-            isCreateable: false,
-            isUpdateable: false,
-            retrieving: false,
-            template: false,
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
         },
         'triggers[].description': {
             isCreateable: true,
@@ -388,15 +394,30 @@ module.exports = {
         },
         version: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
             template: false,
         },
         workflowApiVersion: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        metaData: {
+            skipValidation: true,
+        },
+        notifiers: {
+            skipValidation: true,
+        },
+        tags: {
+            skipValidation: true,
+        },
+        r__folder_Path: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
-            template: false,
+            template: true,
         },
     },
 };

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'Results',
-    dependencies: ['folder'],
+    dependencies: ['folder-mysubs', 'folder-list', 'folder-publication'],
     folderType: 'list',
     hasExtended: false,
     idField: 'ObjectID',

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['folder', 'dataExtension'],
+    dependencies: ['folder-queryactivity', 'dataExtension'],
     folderType: 'queryactivity',
     filter: {
         description: ['Query created by Query Studio'],

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

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['folder'],
+    dependencies: ['folder-ssjsactivity'],
     folderType: 'ssjsactivity',
     hasExtended: false,
     idField: 'ssjsActivityId',

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

@@ -9,7 +9,8 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
-    restPagination: false,
+    restPagination: true,
+    restPageSize: 100,
     type: 'transactionalEmail',
     typeDescription: 'Lets you send immediate Email messages via API events',
     typeRetrieveByDefault: true,

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

@@ -9,7 +9,8 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
-    restPagination: false,
+    restPagination: true,
+    restPageSize: 100,
     type: 'transactionalPush',
     typeDescription: 'Lets you send immediate Push messages via API events',
     typeRetrieveByDefault: true,

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

@@ -9,7 +9,8 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
-    restPagination: false,
+    restPagination: true,
+    restPageSize: 100,
     type: 'transactionalSMS',
     typeDescription: 'Lets you send immediate SMS messages via API events',
     typeRetrieveByDefault: true,

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

@@ -1,6 +1,13 @@
 module.exports = {
     bodyIteratorField: 'Results',
-    dependencies: ['folder', 'email', 'asset-message', 'list'], // SendClassification, SenderProfile, DeliveryProfile
+    dependencies: [
+        'folder-hidden',
+        'folder-triggered_send',
+        'folder-triggered_send_journeybuilder',
+        'email',
+        'asset-message',
+        'list',
+    ], // SendClassification, SenderProfile, DeliveryProfile
     folderType: 'triggered_send',
     hasExtended: false,
     idField: 'ObjectID',
@@ -380,7 +387,7 @@ module.exports = {
         },
         RefreshContent: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: false,
             templating: false,
         },
@@ -525,5 +532,6 @@ module.exports = {
         r__folder_Path: { skipValidation: true },
         r__assetMessage_Name: { skipValidation: true },
         r__assetMessage_Key: { skipValidation: true },
+        r__list_PathName: { skipValidation: true },
     },
 };

package/lib/util/auth.js

@@ -91,9 +91,9 @@ const Auth = {
 function setupSDK(sessionKey, authObject) {
     return new SDK(authObject, {
         eventHandlers: {
-            onLoop: (type, req) => {
+            onLoop: (type, accumulator) => {
                 Util.logger.info(
-                    ` - Requesting next batch (currently ${req.Results.length} records)`
+                    ` - Requesting next batch (currently ${accumulator?.length} records)`
                 );
             },
             onRefresh: (authObject) => {
@@ -104,10 +104,18 @@ function setupSDK(sessionKey, authObject) {
                 Util.logger.warn(
                     ` - Connection problem (Code: ${ex.code}). Retrying ${remainingAttempts} time${
                         remainingAttempts > 1 ? 's' : ''
+                    }${
+                        ex.endpoint
+                            ? Util.getGrayMsg(
+                                  ' - ' + ex.endpoint.split('rest.marketingcloudapis.com')[1]
+                              )
+                            : ''
                     }`
                 );
                 Util.logger.errorStack(ex);
             },
+            // logRequest: (req) => console.log('request', req), // uncomment to log requests
+            // logResponse: (res) => console.log('response:', res), // uncomment to log responses
         },
         requestAttempts: 4,
         retryOnConnectionError: true,

package/lib/util/cli.js

@@ -410,7 +410,10 @@ const Cli = {
             const flattenedDefinitions = [];
             for (const el in MetadataDefinitions) {
                 // if subtypes on metadata (eg. Assets) then add each nested subtype
-                if (MetadataDefinitions[el].subTypes) {
+                if (
+                    MetadataDefinitions[el].subTypes &&
+                    Array.isArray(MetadataDefinitions[el].typeRetrieveByDefault)
+                ) {
                     for (const subtype of MetadataDefinitions[el].subTypes) {
                         flattenedDefinitions.push({
                             typeName:

package/lib/util/file.js

@@ -246,6 +246,10 @@ const File = {
                 filename + '.' + filetype,
             ])}`;
             Util.logger.debug(warnMsg);
+            if (Util.logger.level === 'debug') {
+                // useful when running test cases in which we cannot see .error files
+                Util.logger.debug(ex.message);
+            }
 
             // save prettier errror into log file
             // Note: we have to filter color codes from prettier's error message before saving it to file
@@ -300,7 +304,7 @@ const File = {
      * @param {string} filename name of the file without '.json' ending
      * @param {boolean} sync should execute sync (default is async)
      * @param {boolean} cleanPath should execute sync (default is true)
-     * @returns {Promise | object} Promise or JSON object depending on if async or not
+     * @returns {Promise.<object> | object | void} Promise or JSON object depending on if async or not; void on error
      */
     readJSONFile: function (directory, filename, sync, cleanPath) {
         try {
@@ -336,7 +340,7 @@ const File = {
      * @param {string} filename name of the file without '.json' ending
      * @param {string} filetype filetype suffix
      * @param {string} [encoding='utf8'] read file with encoding (defaults to utf-8)
-     * @returns {Promise.<string>} file contents
+     * @returns {Promise.<string> | void} file contents; void on error
      */
     readFilteredFilename: function (directory, filename, filetype, encoding) {
         try {
@@ -411,7 +415,7 @@ const File = {
      * @param {number} [depth] how many levels to check (1 base)
      * @param {boolean} [includeStem] include the parent directory in the response
      * @param {number} [_stemLength] set recursively for subfolders. do not set manually!
-     * @returns {string[]} array of fully defined file paths
+     * @returns {string[] | void} array of fully defined file paths; void on error
      */
     readDirectoriesSync: function (directory, depth, includeStem, _stemLength) {
         try {

package/lib/util/init.js

@@ -186,6 +186,68 @@ const Init = {
         }
     },
 
+    /**
+     * Creates template file for properties.json
+     *
+     * @returns {Promise.<void>} -
+     */
+    async joinProject() {
+        const responses = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'isJoin',
+                message:
+                    'Do you want to join an existing project for which you have a Git-Repository URL?',
+                default: true,
+            },
+        ]);
+        if (responses.isJoin) {
+            const gitRepoQs = await inquirer.prompt([
+                {
+                    type: 'input',
+                    name: 'gitRepoUrl',
+                    message: 'Please enter the Git-Repository URL',
+                },
+                {
+                    type: 'input',
+                    name: 'gitBranch',
+                    message:
+                        'If you were asked to work on a specific branch, please enter it now (or leave empty for default)',
+                },
+            ]);
+            const repoName = gitRepoQs.gitRepoUrl.split('/').pop().replace('.git', '');
+            // clone repo into current folder
+            Util.execSync(
+                'git',
+                [
+                    'clone',
+                    gitRepoQs.gitBranch ? `--branch ${gitRepoQs.gitBranch}` : null,
+                    '--config core.longpaths=true',
+                    '--config core.autocrlf=input',
+                    gitRepoQs.gitRepoUrl,
+                ].filter(Boolean)
+            );
+            // make sure we switch to the new subfolder or else the rest will fail
+            process.chdir(repoName);
+
+            // check if the branch looks good
+            const properties = await config.getProperties(true, true);
+            if (!properties) {
+                Util.logger.error(
+                    'Could not find .mcdevrc.json file in project folder. Please check your Git repository and branch.'
+                );
+                return;
+            }
+
+            // get name and email that's to be used for git commits
+            await InitGit._updateGitConfigUser();
+
+            // ask the user to enter the server credentials
+            await this.initProject(properties);
+        } else {
+            return;
+        }
+    },
     /**
      * helper for @initProject that optionally creates markets and market lists for all BUs
      */