mcdev 5.0.2 → 5.2.0

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

@@ -11,6 +11,7 @@ module.exports = {
     lastmodNameField: 'modifiedBy',
     nameField: 'name',
     restPagination: true,
+    maxKeyLength: 36, // confirmed max length
     type: 'dataExtract',
     typeDescription: 'Creates zipped files in your FTP directory or convert XML into CSV.',
     typeRetrieveByDefault: true,

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

@@ -14,6 +14,7 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
+    maxKeyLength: 36, // confirmed max length
     type: 'emailSend',
     soapType: 'emailSendDefinition',
     typeDescription: 'Mainly used in Automations as "Send Email Activity".',

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

@@ -11,6 +11,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: 'modifiedBy',
     restPagination: true,
+    maxKeyLength: 200, // confirmed max length
     type: 'event',
     typeDescription: 'Used in Journeys (Interactions) to define Entry Events.',
     typeRetrieveByDefault: true,

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

@@ -11,6 +11,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
     restPagination: true,
+    maxKeyLength: 36, // confirmed max length
     type: 'filter',
     typeDescription:
         'BETA: Part of how filtered Data Extensions are created. Depends on type "FilterDefinitions".',

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

@@ -22,6 +22,7 @@ module.exports = {
         DataExtension: 255,
         Email: 0,
     },
+    maxKeyLength: 36, // confirmed max length
     type: 'importFile',
     typeDescription: 'Reads files in FTP directory for further processing.',
     typeRetrieveByDefault: true,
@@ -221,11 +222,41 @@ module.exports = {
             retrieving: true,
             template: true,
         },
-        c__dataAction: { skipValidation: true },
-        r__dataExtension_CustomerKey: { skipValidation: true },
-        c__destinationType: { skipValidation: true },
-        r__list_PathName: { skipValidation: true },
-        r__fileLocation_name: { skipValidation: true },
-        c__subscriberImportType: { skipValidation: true },
+        c__dataAction: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__dataExtension_CustomerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        c__destinationType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__list_PathName: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__fileLocation_name: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        c__subscriberImportType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };

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

@@ -12,6 +12,7 @@ module.exports = {
     lastmodNameField: null,
     restPagination: true,
     restPageSize: 50,
+    maxKeyLength: 50, // assumed max length
     type: 'mobileKeyword',
     typeDescription: 'Used for managing subscriptions for Mobile numbers in Mobile Connect',
     typeRetrieveByDefault: true,

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

@@ -21,6 +21,7 @@ module.exports = {
         Overwrite: 0,
         Update: 1,
     },
+    maxKeyLength: 36, // confirmed max length
     type: 'query',
     typeDescription: 'Select & transform data using SQL.',
     typeRetrieveByDefault: true,

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

@@ -23,6 +23,7 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
+    maxKeyLength: 36, // confirmed max length
     type: 'role',
     typeDescription:
         'User Roles define groups that are used to grant users access to SFMC systems.',

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

@@ -21,6 +21,7 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
+    maxKeyLength: 36, // confirmed max length
     type: 'triggeredSend',
     soapType: 'triggeredSendDefinition',
     typeDescription: 'DEPRECATED: Sends emails via API or DataExtension Event.',
@@ -534,6 +535,7 @@ module.exports = {
         r__folder_Path: { skipValidation: true },
         r__assetMessage_Name_readOnly: { skipValidation: true },
         r__assetMessage_Key: { skipValidation: true },
+        r__email_Name: { skipValidation: true },
         r__list_PathName: { skipValidation: true },
     },
 };

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

@@ -12,6 +12,7 @@ module.exports = {
     createdNameField: null,
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: 'Client.ModifiedBy',
+    maxKeyLength: 50, // confirmed max length
     type: 'user',
     soapType: 'AccountUser',
     typeDescription: 'Marketing Cloud users',

package/lib/util/cache.js

@@ -72,10 +72,15 @@ module.exports = {
      * @returns {void}
      */
     mergeMetadata: (type, metadataMap, overrideMID) => {
-        dataStore[overrideMID || currentMID][type] = Object.assign(
-            metadataMap,
-            dataStore[currentMID][type]
-        );
+        // ensure cache exists for type
+        dataStore[currentMID][type] ||= {};
+        // if overrideMID is provided, create a copy of current MID cache
+        if (overrideMID) {
+            // ! needs to be verified if this is actually needed. When discovering an issue with this method actually overriting metadataMap, this copy-logic was present and i did not want to break things
+            dataStore[overrideMID][type] = Object.assign({}, dataStore[currentMID][type]);
+        }
+        // merge metadataMap into existing cache
+        Object.assign(dataStore[overrideMID || currentMID][type] || {}, metadataMap);
     },
     /**
      * standardized method for getting data from cache.

package/lib/util/cli.js

@@ -53,6 +53,46 @@ const Cli = {
             return null;
         }
     },
+
+    /**
+     *
+     * @param {TYPE.SupportedMetadataTypes} type limit execution to given metadata type
+     * @param {TYPE.SupportedMetadataTypes[]} dependentTypes types that depent on type
+     * @returns {Promise.<boolean>} true if user wants to continue with retrieve
+     */
+    async postFixKeysReretrieve(type, dependentTypes) {
+        if (Util.isTrue(Util.skipInteraction?.fixKeysReretrieve)) {
+            return true;
+        } else if (Util.isFalse(Util.skipInteraction?.fixKeysReretrieve)) {
+            return false;
+        } else {
+            const now = await inquirer.prompt([
+                {
+                    type: 'confirm',
+                    name: 'fixKeysReretrieve',
+                    message: `Do you want to re-retrieve dependent types (${dependentTypes.join(
+                        ', '
+                    )}) now?`,
+                    default: true,
+                },
+            ]);
+            if (Util.OPTIONS._multiBuExecution) {
+                const remember = await inquirer.prompt([
+                    {
+                        type: 'confirm',
+                        name: 'rememberFixKeysReretrieve',
+                        message: `Remember answer for other BUs?`,
+                        default: true,
+                    },
+                ]);
+                if (remember.rememberFixKeysReretrieve) {
+                    Util.skipInteraction ||= {};
+                    Util.skipInteraction.fixKeysReretrieve = now.fixKeysReretrieve;
+                }
+            }
+            return now.fixKeysReretrieve;
+        }
+    },
     /**
      * helper that logs to cli which credentials are already existing in our config file
      *

package/lib/util/devops.js

@@ -293,17 +293,19 @@ const DevOps = {
             }
 
             /** @type {TYPE.DeltaPkgItem[]} */
-            const copied = delta.map((file) =>
-                File.copyFile(
-                    file.file,
-                    path
-                        .normalize(file.file)
-                        .replace(
-                            path.normalize(properties.directories.retrieve),
-                            path.normalize(properties.directories.deploy)
-                        )
-                )
-            );
+            const copied = delta
+                .filter((file) => !file.file.endsWith('.md')) // filter documentation files
+                .map((file) =>
+                    File.copyFile(
+                        file.file,
+                        path
+                            .normalize(file.file)
+                            .replace(
+                                path.normalize(properties.directories.retrieve),
+                                path.normalize(properties.directories.deploy)
+                            )
+                    )
+                );
             const results = await Promise.all(copied);
             const failed = results.filter((result) => result.status === 'failed');
             const skipped = results.filter((result) => result.status === 'skipped');

package/lib/util/file.js

@@ -381,7 +381,7 @@ const File = {
      * @param {string | string[]} directory directory where the file is stored
      * @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)
+     * @param {string} [encoding] read file with encoding (defaults to utf-8)
      * @returns {Promise.<string> | void} file contents; void on error
      */
     readFilteredFilename: function (directory, filename, filetype, encoding) {
@@ -514,7 +514,7 @@ const File = {
     /**
      * Initalises Prettier formatting lib async.
      *
-     * @param {string} [filetype='html'] filetype ie. JSON or SSJS
+     * @param {string} [filetype] filetype ie. JSON or SSJS
      * @returns {Promise.<boolean>} success of config load
      */
     async initPrettier(filetype = 'html') {

package/lib/util/init.js

@@ -8,6 +8,8 @@ const InitNpm = require('./init.npm');
 const InitConfig = require('./init.config');
 const inquirer = require('inquirer');
 const Util = require('./util');
+const fs = require('node:fs');
+const path = require('node:path');
 
 /**
  * CLI helper class
@@ -22,6 +24,10 @@ const Init = {
      * @returns {Promise.<void>} -
      */
     async initProject(properties, credentialName) {
+        if (!(await Init._checkPathForCloud())) {
+            return;
+        }
+
         const skipInteraction = Util.skipInteraction;
         if (!properties) {
             // try to get cached properties because we return null in case of a crucial error
@@ -192,6 +198,10 @@ const Init = {
      * @returns {Promise.<void>} -
      */
     async joinProject() {
+        if (!(await Init._checkPathForCloud())) {
+            return;
+        }
+
         const responses = await inquirer.prompt([
             {
                 type: 'confirm',
@@ -217,6 +227,9 @@ const Init = {
             ]);
             const repoName = gitRepoQs.gitRepoUrl.split('/').pop().replace('.git', '');
             // clone repo into current folder
+            Util.logger.info(
+                'Cloning initiated. You might be asked for your Git credentials in a pop-up window in a few seconds.'
+            );
             Util.execSync(
                 'git',
                 [
@@ -227,6 +240,16 @@ const Init = {
                     gitRepoQs.gitRepoUrl,
                 ].filter(Boolean)
             );
+
+            if (!fs.existsSync(repoName)) {
+                Util.logger.error(
+                    'Could not clone repository. Please check your Git-Repository URL as well as your credentials and try again.'
+                );
+                Util.logger.info(
+                    'Check if you need an "API-Token" instead of your normal user password to authenticate'
+                );
+                return;
+            }
             // make sure we switch to the new subfolder or else the rest will fail
             process.chdir(repoName);
 
@@ -357,6 +380,10 @@ const Init = {
      * @returns {Promise.<boolean>} success flag
      */
     async upgradeProject(properties, initial, repoName) {
+        if (!(await Init._checkPathForCloud())) {
+            return;
+        }
+
         let status;
         const versionBeforeUpgrade = properties?.version || '0.0.0';
         if (!initial) {
@@ -390,9 +417,66 @@ const Init = {
 
         return true;
     },
+    /**
+     * check if git repo is being saved on a cloud service and warn the user
+     *
+     * @private
+     * @returns {void} throws errors if problems were found
+     */
+    async _checkPathForCloud() {
+        const absolutePath = path.resolve('');
+        // popular cloud services and their respective default name for the absolute path
+        // * CloudDocs is the default folder name for iCloud
+        const cloudServices = ['Dropbox', 'OneDrive', 'Google Drive', 'iCloud', 'CloudDocs'];
+        let cloudServiceFound = false;
+        for (const variable in cloudServices) {
+            if (absolutePath.includes(cloudServices[variable])) {
+                Util.logger.warn(
+                    `It seems your project folder will be synchronized via '${
+                        cloudServices[variable] === 'CloudDocs' ? 'iCloud' : cloudServices[variable]
+                    }'. This can reduce the overall performance of your computer due to conflicts with Git.`
+                );
+                Util.logger.warn(
+                    `We strongly recommend moving your project folder outside of the '${
+                        cloudServices[variable] === 'CloudDocs' ? 'iCloud' : cloudServices[variable]
+                    }' folder.`
+                );
+                cloudServiceFound = true;
+            }
+        }
+        if (!cloudServiceFound && absolutePath.includes(process.env.USERPROFILE)) {
+            // warn user to not place project folder into user profile folder
+            Util.logger.warn(
+                `It seems your project folder is located in your user profile's default folder which is often synchronized to webservices like ${cloudServices.join(
+                    ', '
+                )}. This can reduce the overall performance of your computer due to conflicts between with Git.`
+            );
+            Util.logger.warn(
+                `We strongly recommend moving your project folder outside of this folder.`
+            );
+            cloudServiceFound = true;
+        }
+        if (cloudServiceFound) {
+            const responses = await inquirer.prompt([
+                {
+                    type: 'confirm',
+                    name: 'ignoreCloudWarning',
+                    message: 'Do you want to continue anyways?',
+                    default: false,
+                },
+            ]);
+            if (!responses.ignoreCloudWarning) {
+                Util.logger.error('Exiting due to cloud service warning');
+                return false;
+            }
+        }
+        return true;
+    },
+
     /**
      * finds credentials that are set up in config but not in auth file
      *
+     * @private
      * @param {TYPE.Mcdevrc} properties javascript object in .mcdevrc.json
      * @returns {string[]} list of credential names
      */