mcdev 3.1.1 → 4.0.0

package/lib/metadataTypes/AccountUser.js

@@ -1,58 +1,77 @@
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const MetadataType = require('./MetadataType');
 const Util = require('../util/util');
 const File = require('../util/file');
 
 /**
  * MessageSendActivity MetadataType
+ *
  * @augments MetadataType
  */
 class AccountUser extends MetadataType {
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
-     * @param {String} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {String[]} _ Returns specified fields even if their retrieve definition is not set to true
-     * @param {Object} buObject properties for auth
-     * @returns {Promise<Object>} Promise of metadata
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {void} _ unused parameter
+     * @param {TYPE.BuObject} buObject properties for auth
+     * @param {void} [___] unused parameter
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
-    static async retrieve(retrieveDir, _, buObject) {
+    static async retrieve(retrieveDir, _, buObject, ___, key) {
         if (buObject.eid !== buObject.mid) {
-            Util.logger.info('Skipping User retrieval on non-parent BU');
+            Util.logger.info(' - Skipping User retrieval on non-parent BU');
             return;
         }
-        Util.logger.info('- Caching dependent Metadata: AccountUserAccount');
+        return this._retrieve(retrieveDir, buObject, key);
+    }
+    /**
+     * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
+     *
+     * @param {TYPE.BuObject} buObject properties for auth
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     */
+    static async retrieveChangelog(buObject) {
+        return this._retrieve(null, buObject, null);
+    }
+    /**
+     * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
+     *
+     * @private
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {TYPE.BuObject} buObject properties for auth
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     */
+    static async _retrieve(retrieveDir, buObject, key) {
+        Util.logger.info(' - Caching dependent Metadata: AccountUserAccount');
 
         // get BUs that each users have access to
         const optionsBUs = {};
-        let resultsBatch;
-        await Util.retryOnError(`Retrying ${this.definition.type}`, async () => {
-            resultsBatch = await new Promise((resolve, reject) => {
-                this.client.SoapClient.retrieve(
-                    'AccountUserAccount',
-                    [
-                        'AccountUser.AccountUserID',
-                        'AccountUser.UserID',
-                        'Account.ID',
-                        'Account.Name',
-                    ],
-                    optionsBUs,
-                    (ex, response) => (ex ? reject(ex) : resolve(response.body.Results))
-                );
-            });
-        });
+
+        const resultsBatch = (
+            await this.client.soap.retrieveBulk(
+                'AccountUserAccount',
+                ['AccountUser.AccountUserID', 'AccountUser.UserID', 'Account.ID', 'Account.Name'],
+                optionsBUs
+            )
+        ).Results;
         this.userIdBuMap = {};
-        resultsBatch.forEach((item) => {
+        for (const item of resultsBatch) {
             this.userIdBuMap[item.AccountUser.AccountUserID] =
                 this.userIdBuMap[item.AccountUser.AccountUserID] || [];
             this.userIdBuMap[item.AccountUser.AccountUserID].push({
                 ID: item.Account.ID,
                 Name: item.Account.Name,
             });
-        });
+        }
         // get actual user details
-        const options = {
-            queryAllAccounts: true,
+        /** @type {TYPE.SoapRequestParams} */
+        let requestParams = {
+            QueryAllAccounts: true,
 
             filter: {
                 leftOperand: {
@@ -79,13 +98,26 @@ class AccountUser extends MetadataType {
                 },
             },
         };
+        if (key) {
+            // move original filter down one level into rightOperand and add key filter into leftOperand
+            requestParams = {
+                filter: {
+                    leftOperand: {
+                        leftOperand: 'CustomerKey',
+                        operator: 'equals',
+                        rightOperand: key,
+                    },
+                    operator: 'AND',
+                    rightOperand: requestParams.filter,
+                },
+            };
+        }
 
-        return super.retrieveSOAPgeneric(retrieveDir, buObject, options);
+        return super.retrieveSOAP(retrieveDir, buObject, requestParams);
     }
     /**
      *
      * @param {string} date first date
-     * @param {string} date2 second date
      * @returns {number} time difference
      */
     static timeSinceDate(date) {
@@ -98,8 +130,8 @@ class AccountUser extends MetadataType {
         date = new Date(date);
         const now = new Date();
         const timediff = now - date;
-        if (isNaN(timediff)) {
-            return NaN;
+        if (Number.isNaN(timediff)) {
+            return Number.NaN;
         }
         let result;
         switch (interval) {
@@ -128,31 +160,28 @@ class AccountUser extends MetadataType {
                 result = Math.floor(timediff / second);
                 break;
             default:
-                return undefined;
+                return;
         }
         return result + ' ' + interval;
     }
     /**
      * helper to print bu names
-     * @param {Util.BuObject} buObject needed for eid
+     *
+     * @param {TYPE.BuObject} buObject needed for eid
      * @param {string} buObject.eid needed to check for parent bu
-     * @param {numeric} id bu id
+     * @param {number} id bu id
      * @returns {string} "bu name (bu id)""
      */
     static getBuName(buObject, id) {
-        let name;
-        if (buObject.eid == id) {
-            name = '_ParentBU_';
-        } else {
-            name = this.buIdName[id];
-        }
+        const name = buObject.eid == id ? '_ParentBU_' : this.buIdName[id];
         return `<nobr>${name} (${id})</nobr>`;
     }
     /**
      * Creates markdown documentation of all roles
-     * @param {Util.BuObject} buObject properties for auth
-     * @param {Object} [metadata] user list
-     * @returns {Promise<void>} -
+     *
+     * @param {TYPE.BuObject} buObject properties for auth
+     * @param {TYPE.MetadataTypeMap} [metadata] user list
+     * @returns {Promise.<void>} -
      */
     static async document(buObject, metadata) {
         if (buObject.eid !== buObject.mid) {
@@ -182,6 +211,9 @@ class AccountUser extends MetadataType {
 
         // initialize permission object
         this.allPermissions = {};
+        /**
+         * @type {TYPE.AccountUserDocument[]}
+         */
         const users = [];
         // traverse all permissions recursively and write them into allPermissions object once it has reached the end
         for (const id in metadata) {
@@ -194,9 +226,7 @@ class AccountUser extends MetadataType {
                     user.UserPermissions = [user.UserPermissions];
                 }
                 userPermissions = user.UserPermissions.map((item) => item.ID * 1)
-                    .sort(function (a, b) {
-                        return a < b ? -1 : a > b ? 1 : 0;
-                    })
+                    .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))
                     .join(', ');
             }
             // user roles
@@ -206,9 +236,7 @@ class AccountUser extends MetadataType {
                 roles =
                     '<nobr>' +
                     user.Roles.map((item) => item.Name)
-                        .sort(function (a, b) {
-                            return a < b ? -1 : a > b ? 1 : 0;
-                        })
+                        .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))
                         .join(',</nobr><br> <nobr>') +
                     '</nobr>';
             }
@@ -218,9 +246,7 @@ class AccountUser extends MetadataType {
                     this.buIdName[item.ID] = item.Name;
                     return this.getBuName(buObject, item.ID);
                 })
-                    .sort(function (a, b) {
-                        return a < b ? -1 : a > b ? 1 : 0;
-                    })
+                    .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))
                     .join(',<br> ');
             }
             const defaultBUName = this.getBuName(buObject, user.DefaultBusinessUnit);
@@ -232,9 +258,9 @@ class AccountUser extends MetadataType {
                 Name: user.Name,
                 Email: user.Email,
                 NotificationEmailAddress: user.NotificationEmailAddress,
-                ActiveFlag: user.ActiveFlag === 'true' ? '✓' : '-',
-                IsAPIUser: user.IsAPIUser === 'true' ? '✓' : '-',
-                MustChangePassword: user.MustChangePassword === 'true' ? '✓' : '-',
+                ActiveFlag: user.ActiveFlag === true ? '✓' : '-',
+                IsAPIUser: user.IsAPIUser === true ? '✓' : '-',
+                MustChangePassword: user.MustChangePassword === true ? '✓' : '-',
                 DefaultBusinessUnit: defaultBUName,
                 AssociatedBusinessUnits__c: associatedBus,
                 Roles: roles,
@@ -244,9 +270,7 @@ class AccountUser extends MetadataType {
                 ModifiedDate: user.ModifiedDate.split('T').join(' '),
             });
         }
-        users.sort(function (a, b) {
-            return a.Name < b.Name ? -1 : a.Name > b.Name ? 1 : 0;
-        });
+        users.sort((a, b) => (a.Name < b.Name ? -1 : a.Name > b.Name ? 1 : 0));
         const columnsToPrint = [
             ['Name', 'Name'],
             ['Last successful Login', 'LastSuccessfulLogin'],
@@ -281,72 +305,60 @@ class AccountUser extends MetadataType {
             'Installed Package',
             columnsToPrint
         );
-        const docPath = File.normalizePath([this.properties.directories.users]);
+        const docPath = File.normalizePath([this.properties.directories.docs, 'user']);
 
         try {
             const filename = buObject.credential;
-            // ensure docs/roles folder is existing (depends on setup in .mcdevrc.json)
-            if (!File.existsSync(docPath)) {
-                File.mkdirpSync(docPath);
-            }
             // write to disk
-            await File.writeToFile(docPath, filename + '.accountUser', 'md', output);
-            Util.logger.info(`Created ${docPath}${filename}.accountUser.md`);
+            await File.writeToFile(docPath, filename + '.accountUsers', 'md', output);
+            Util.logger.info(`Created ${File.normalizePath([docPath, filename])}.accountUsers.md`);
             if (['html', 'both'].includes(this.properties.options.documentType)) {
                 Util.logger.warn(
-                    'HTML-based documentation of accountUser currently not supported.'
+                    ' - HTML-based documentation of accountUser currently not supported.'
                 );
             }
         } catch (ex) {
             Util.logger.error(`AccountUser.document():: error | `, ex.message);
         }
     }
-    /**
-     * Experimental: Only working for DataExtensions:
-     * Saves json content to a html table in the local file system. Will create the parent directory if it does not exist.
-     * The json's first level of keys must represent the rows and the secend level the columns
-     * @private
-     * @param {DataExtensionItem} json dataextension
-     * @param {Array} tabled prepped array for output in tabular format
-     * @returns {string} file content
-     */
     /**
      *
-     * @param {Object[]} users list of users and installed package
+     * @param {object[]} users list of users and installed package
      * @param {'Installed Package'|'User'} type choose what sub type to print
      * @param {Array[]} columnsToPrint helper array
-     * @param {Object} buObject properties for auth
      * @returns {string} markdown
      */
     static _generateDocMd(users, type, columnsToPrint) {
         let output = `\n\n## ${type}s (${users.length})\n\n`;
         let tableSeparator = '';
-        columnsToPrint.forEach((column) => {
+        for (const column of columnsToPrint) {
             output += `| ${column[0]} `;
             tableSeparator += '| --- ';
-        });
+        }
         output += `|\n${tableSeparator}|\n`;
-        users.forEach((user) => {
-            columnsToPrint.forEach((column) => {
+        for (const user of users) {
+            for (const column of columnsToPrint) {
                 output += `| ${user[column[1]]} `;
-            });
+            }
             output += `|\n`;
-        });
+        }
         return output;
     }
 
     /**
      * manages post retrieve steps
-     * @param {Object} metadata a single query
-     * @returns {Object[]} Array with one metadata object and one query string
+     *
+     * @param {TYPE.MetadataTypeItem} metadata a single query
+     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one query string
      */
     static postRetrieveTasks(metadata) {
         return this.parseMetadata(metadata);
     }
     /**
      * parses retrieved Metadata before saving
-     * @param {Object} metadata a single query activity definition
-     * @returns {Array} Array with one metadata object and one sql string
+     *
+     * @param {TYPE.MetadataTypeItem} metadata a single query activity definition
+     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one sql string
      */
     static parseMetadata(metadata) {
         metadata.type__c = 'Installed Package';
@@ -354,11 +366,7 @@ class AccountUser extends MetadataType {
             metadata.type__c = 'User';
         }
 
-        if (this.userIdBuMap[metadata.ID]) {
-            metadata.AssociatedBusinessUnits__c = this.userIdBuMap[metadata.ID];
-        } else {
-            metadata.AssociatedBusinessUnits__c = [];
-        }
+        metadata.AssociatedBusinessUnits__c = this.userIdBuMap[metadata.ID] || [];
 
         let roles;
         if (metadata.Roles.Role) {
@@ -370,9 +378,7 @@ class AccountUser extends MetadataType {
             roles = metadata.Roles.Role.map((item) => ({
                 Name: item.Name,
                 CustomerKey: item.CustomerKey,
-            })).sort(function (a, b) {
-                return a.Name < b.Name ? -1 : a.Name > b.Name ? 1 : 0;
-            });
+            })).sort((a, b) => (a.Name < b.Name ? -1 : a.Name > b.Name ? 1 : 0));
         } else {
             // set to empty array
             roles = [];