mcdev 3.0.1 → 3.1.1

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

@@ -0,0 +1,227 @@
+module.exports = {
+    bodyIteratorField: 'Results',
+    dependencies: [],
+    folderType: null,
+    hasExtended: false,
+    idField: 'ID',
+    keyField: 'CustomerKey',
+    nameField: 'Name',
+    type: 'accountUser',
+    typeDescription: 'Marketing Cloud users',
+    typeName: 'User',
+    typeRetrieveByDefault: false,
+    fields: {
+        AccountUserID: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        ActiveFlag: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        AssociatedBusinessUnits: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        BusinessUnit: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        ChallengeAnswer: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        ChallengePhrase: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        Client: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        CorrelationID: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        CreatedDate: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        CustomerKey: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        DefaultApplication: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        DefaultBusinessUnit: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        DefaultBusinessUnitObject: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        Delete: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        Email: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        ID: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        IsAPIUser: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        IsLocked: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        LanguageLocale: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        LastSuccessfulLogin: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        Locale: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        ModifiedDate: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        MustChangePassword: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        Name: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        NotificationEmailAddress: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        ObjectID: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        ObjectState: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        Owner: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        PartnerKey: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        PartnerProperties: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        Password: { isCreateable: null, isUpdateable: null, retrieving: false, template: false },
+        Roles: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        'Roles.Role': {
+            skipValidation: false,
+        },
+        'Roles.Role[].Client': {
+            skipValidation: false,
+        },
+        SsoIdentities: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        TimeZone: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        Unlock: { isCreateable: null, isUpdateable: null, retrieving: false, template: null },
+        UserID: { isCreateable: null, isUpdateable: null, retrieving: true, template: false },
+        UserPermissions: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: false,
+        },
+        'UserPermissions.PartnerKey': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.ID': {
+            skipValidation: true,
+        },
+        'UserPermissions.ObjectID': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Name': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Value': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Description': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions.Delete': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].PartnerKey': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].ID': {
+            skipValidation: true,
+        },
+        'UserPermissions[].ObjectID': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Name': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Value': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Description': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        'UserPermissions[].Delete': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: false,
+        },
+        type__c: {
+            skipValidation: true,
+        },
+        AssociatedBusinessUnits__c: {
+            skipValidation: true,
+        },
+    },
+};

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

@@ -677,6 +677,7 @@ module.exports = {
         ],
     },
     typeMapping: {
+        ai: 16,
         psd: 17,
         pdd: 18,
         eps: 19,

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

@@ -8,7 +8,7 @@ module.exports = {
     restPagination: true,
     type: 'campaign',
     typeDescription: 'Way of tagging/categorizing emails, journeys and alike.',
-    typeRetrieveByDefault: true,
+    typeRetrieveByDefault: false,
     typeName: 'Campaign Tag',
     fields: {},
 };

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

@@ -167,7 +167,7 @@ module.exports = {
         ModifiedDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: false,
+            retrieving: true,
             template: false,
         },
         Name: {

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

@@ -92,7 +92,7 @@ module.exports = {
         },
         ObjectID: {
             isCreateable: false,
-            isUpdateable: null,
+            isUpdateable: true,
             retrieving: false,
             template: false,
         },

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

@@ -93,7 +93,7 @@ module.exports = {
         },
         ContentType: {
             isCreateable: true,
-            isUpdateable: true,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },

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

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

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

@@ -21,7 +21,7 @@ module.exports = {
         createdBy: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         createdDate: {
@@ -51,7 +51,7 @@ module.exports = {
         modifiedBy: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         modifiedDate: {
@@ -79,9 +79,9 @@ module.exports = {
             template: false,
         },
         status: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         statusId: {

package/lib/retrieveChangelog.js

@@ -0,0 +1,96 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * sample file on how to retrieve a simple changelog to use in GUIs or automated processing of any kind
+ * @example
+ [{
+    name: 'deName',
+    key: 'deKey',
+    t: 'dataExtension',
+    cd: '2020-05-06T00:16:00.737',
+    cb: 'name of creator',
+    ld: '2020-05-06T00:16:00.737',
+    lb: 'name of lastmodified'
+  }]
+ */
+
+const mcdev = require('./index');
+const Definition = require('./MetadataTypeDefinitions');
+const MetadataType = require('./MetadataTypeInfo');
+
+// disable cli logs
+// mcdev._setLoggingLevel({ silent: true });
+
+const customDefinition = {
+    automation: {
+        keyField: 'CustomerKey',
+        nameField: 'Name',
+        createdDateField: 'CreatedDate',
+        createdNameField: 'CreatedBy',
+        lastmodDateField: 'LastSaveDate',
+        lastmodNameField: 'LastSavedBy',
+    },
+    dataExtension: {
+        keyField: 'CustomerKey',
+        nameField: 'Name',
+        createdDateField: 'CreatedDate',
+        createdNameField: null,
+        lastmodDateField: 'ModifiedDate',
+        lastmodNameField: null,
+    },
+};
+(async function () {
+    // get userid>name mapping
+    const userList = (await mcdev.retrieve('ACN-Learning/_ParentBU_', 'accountUser', true))
+        .accountUser;
+    // reduce userList to simple id-name map
+    Object.keys(userList).forEach((key) => {
+        userList[userList[key].ID] = userList[key].Name;
+        delete userList[key];
+    });
+
+    // get changed metadata
+    const changelogList = await mcdev.retrieve('ACN-Learning/MCDEV_Training_Source', null, true);
+    const allMetadata = [];
+    Object.keys(changelogList).map((type) => {
+        if (changelogList[type]) {
+            const def = customDefinition[type] || Definition[type];
+            allMetadata.push(
+                ...Object.keys(changelogList[type]).map((key) => {
+                    const item = changelogList[type][key];
+                    if (
+                        MetadataType[type].isFiltered(item, true) ||
+                        MetadataType[type].isFiltered(item, false)
+                    ) {
+                        return;
+                    }
+
+                    const listEntry = {
+                        name: item[def.nameField],
+                        key: item[def.keyField],
+                        t: type,
+                        cd: item[def.createdDateField],
+                        cb: getUserName(userList, item, def.createdNameField),
+                        ld: item[def.lastmodDateField],
+                        lb: getUserName(userList, item, def.lastmodNameField),
+                    };
+                    return listEntry;
+                })
+            );
+        }
+    });
+    const finalResult = allMetadata.filter((item) => undefined !== item);
+    console.log('finalResult', finalResult);
+})();
+
+/**
+ *
+ * @param {object<string,string>} userList user-id > user-name map
+ * @param {object<string,string>} item single metadata item
+ * @param {string} fieldname name of field containing the info
+ * @returns {string} username or user id or 'n/a'
+ */
+function getUserName(userList, item, fieldname) {
+    return userList[item[fieldname]] || item[fieldname] || 'n/a';
+}

package/lib/util/cli.js

@@ -427,9 +427,8 @@ const Cli = {
                                 subtype,
                             type: MetadataDefinitions[el].type + '-' + subtype,
                             mainType: MetadataDefinitions[el].type,
-                            typeRetrieveByDefault: MetadataDefinitions[
-                                el
-                            ].typeRetrieveByDefault.includes(subtype),
+                            typeRetrieveByDefault:
+                                MetadataDefinitions[el].typeRetrieveByDefault.includes(subtype),
                         });
                     }
                 }
@@ -560,9 +559,8 @@ const Cli = {
                 let lastCountdown = MetadataDefinitions[el].subTypes.length;
                 for (const subtype of MetadataDefinitions[el].subTypes) {
                     lastCountdown--;
-                    const subTypeRetrieveByDefault = MetadataDefinitions[
-                        el
-                    ].typeRetrieveByDefault.includes(subtype);
+                    const subTypeRetrieveByDefault =
+                        MetadataDefinitions[el].typeRetrieveByDefault.includes(subtype);
                     const definition =
                         '  ' + MetadataDefinitions[el].extendedSubTypes[subtype].join(', ');
                     typeChoices.push({

package/lib/util/init.git.js

@@ -229,7 +229,8 @@ const Init = {
                     // eslint-disable-next-line require-jsdoc
                     validate: function (value) {
                         value = value.trim();
-                        const regex = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+                        const regex =
+                            /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
                         if (!value || !regex.test(String(value).toLowerCase())) {
                             return 'Please enter valid email';
                         }

package/lib/util/util.js

@@ -110,6 +110,23 @@ const Util = {
         'workflows_read',
         'workflows_write',
     ],
+    /**
+     * SFMC accepts multiple true values for Boolean attributes for which we are checking here
+     * @param {*} attrValue value
+     * @returns {boolean} attribute value == true ? true : false
+     */
+    isTrue(attrValue) {
+        return ['true', 'TRUE', 'True', '1', 1, 'Y'].includes(attrValue);
+    },
+    /**
+     * SFMC accepts multiple false values for Boolean attributes for which we are checking here
+     * @param {*} attrValue value
+     * @returns {boolean} attribute value == false ? true : false
+     */
+    isFalse(attrValue) {
+        return ['false', 'FALSE', 'False', '0', 0, 'N'].includes(attrValue);
+    },
+
     /**
      * defines how the properties.json should look like
      * used for creating a template and for checking if variables are set
@@ -581,7 +598,7 @@ const Util = {
             }
         }
         throw new Error(
-            `Missing one or more dependent metadata. ${metadataType} with ${searchField}='${searchValue}' was not found. Please ensure to create this first or include it in the deployment package.`
+            `Missing one or more dependent metadata. ${metadataType} with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
     /**
@@ -627,7 +644,7 @@ const Util = {
             }
         }
         throw new Error(
-            `Missing one or more dependent metadata. list with ListName='${listName}' and r__folder_Path='${folderPath}' was not found. Please ensure to create this first or include it in the deployment package.`
+            `Missing one or more dependent metadata. list with ListName='${listName}' and r__folder_Path='${folderPath}' was not found on your BU`
         );
     },
 
@@ -663,7 +680,7 @@ const Util = {
             }
         }
         throw new Error(
-            `Missing one or more dependent metadata. list with ${searchField}='${searchValue}' was not found. Please ensure to create this first or include it in the deployment package.`
+            `Missing one or more dependent metadata. list with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
     /**
@@ -676,7 +693,7 @@ const Util = {
      */
     async retryOnError(errorMsg, callback, silentError, retries) {
         if ('undefined' === typeof retries || retries === null) {
-            retries = 1;
+            retries = 3;
         }
         try {
             await callback();
@@ -687,34 +704,33 @@ const Util = {
                 ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET'].includes(ex.code)
             ) {
                 retries--;
+                Util.logger.debug(ex.stack);
+                const msg = `Connection problem. ${errorMsg} (${retries + 1} tries left)`;
                 if (silentError) {
-                    Util.logger.debug(
-                        `Connection error. ${errorMsg} - Retries left: ${retries + 1}`
-                    );
+                    Util.logger.debug(msg);
                 } else {
-                    Util.logger.error(`Connection error. ${errorMsg}`);
+                    Util.logger.warn(msg);
                 }
-                Util.logger.debug(ex.stack);
-                await this.retryOnError(errorMsg, callback, retries);
+                await this.retryOnError(errorMsg, callback, silentError, retries);
             } else if (
                 ex.code &&
                 ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET'].includes(ex.code)
             ) {
+                Util.logger.debug(ex.stack);
                 Util.logger.error(
-                    `Failed due to a Connection Error (${ex.code}) - Please check your network connection and try again`
+                    `"${errorMsg}" Failed due to a Connection Error (${ex.code}) - Please check your network connection and try again`
                 );
-                Util.logger.debug(ex.stack);
                 if (Util.logger.level === 'debug') {
                     console.log(ex.stack);
                 }
-                throw new Error(ex.message);
+                throw ex;
             } else {
-                Util.logger.error(ex.message);
                 Util.logger.debug(ex.stack);
                 if (Util.logger.level === 'debug') {
                     console.log(ex.stack);
                 }
-                throw new Error(ex.message);
+                Util.logger.error(ex.message);
+                throw ex;
             }
         }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "3.0.1",
+    "version": "3.1.1",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -19,7 +19,7 @@
     },
     "main": "./lib/index.js",
     "bin": {
-        "mcdev": "./lib/index.js"
+        "mcdev": "./lib/cli.js"
     },
     "engines": {
         "node": ">=14.16"
@@ -27,7 +27,6 @@
     "scripts": {
         "start": "node lib/index.js",
         "mcdev": "node lib/index.js",
-        "postinstall": "node postinstall.js",
         "build": "run-s lint docs",
         "debug": "node --nolazy --inspect-brk=9229 lib/index.js",
         "docs": "jsdoc2md --files lib/**/*.js > docs/dist/documentation.md",
@@ -38,34 +37,34 @@
     },
     "dependencies": {
         "bluebird": "3.7.2",
-        "cli-progress": "3.9.0",
+        "cli-progress": "3.10.0",
         "command-exists": "1.2.9",
         "console.table": "0.10.0",
-        "fs-extra": "9.1.0",
-        "inquirer": "8.0.0",
+        "fs-extra": "10.0.0",
+        "inquirer": "8.2.0",
         "json-to-table": "4.2.1",
-        "mustache": "4.1.0",
-        "prettier": "2.2.1",
-        "semver": "5.7.1",
+        "mustache": "4.2.0",
+        "prettier": "2.5.1",
+        "semver": "7.3.5",
         "sfmc-fuelsdk-node": "2.4.0",
-        "simple-git": "2.37.0",
+        "simple-git": "2.48.0",
         "sql-formatter-plus": "1.3.6",
         "toposort": "2.0.2",
         "update-notifier-git": "5.0.3",
-        "winston": "3.3.3",
-        "yargs": "16.2.0"
+        "winston": "3.3.4",
+        "yargs": "17.3.0"
     },
     "devDependencies": {
         "chai": "4.3.4",
-        "eslint": "7.22.0",
-        "eslint-config-prettier": "8.1.0",
+        "eslint": "8.4.1",
+        "eslint-config-prettier": "8.3.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-mocha": "8.1.0",
-        "eslint-plugin-prettier": "3.3.1",
-        "husky": "5.1.3",
-        "jsdoc-to-markdown": "7.0.0",
-        "lint-staged": "10.5.4",
-        "mocha": "8.3.2",
+        "eslint-plugin-mocha": "10.0.1",
+        "eslint-plugin-prettier": "4.0.0",
+        "husky": "7.0.4",
+        "jsdoc-to-markdown": "7.1.0",
+        "lint-staged": "12.1.2",
+        "mocha": "9.1.3",
         "npm-check": "5.9.2",
         "npm-run-all": "4.1.5"
     },
@@ -73,9 +72,6 @@
         "*.{js,jsx,ts,tsx}": [
             "eslint --fix",
             "prettier --write"
-        ],
-        "*.{md}": [
-            "prettier --write"
         ]
     }
 }